func NewCommandTop(name, fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command {
// Parent command to which all subcommands are added.
cmds := &cobra.Command{
Use: name,
Short: "Show usage statistics of resources on the server",
Long: topLong,
Run: cmdutil.DefaultSubCommandRun(errOut),
}
cmds.AddCommand(NewCmdTopImages(f, fullName, TopImagesRecommendedName, out))
cmds.AddCommand(NewCmdTopImageStreams(f, fullName, TopImageStreamsRecommendedName, out))
cmdTopNode := kcmd.NewCmdTopNode(f.Factory, out)
cmdTopNode.Long = templates.LongDesc(cmdTopNode.Long)
cmdTopNode.Example = templates.Examples(cmdTopNode.Example)
cmdTopPod := kcmd.NewCmdTopPod(f.Factory, out)
cmdTopPod.Long = templates.LongDesc(cmdTopPod.Long)
cmdTopPod.Example = templates.Examples(cmdTopPod.Example)
cmds.AddCommand(cmdTopNode)
cmds.AddCommand(cmdTopPod)
return cmds
}
Prune OpenShift Groups referencing missing records on from an external provider.
In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish
to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have
been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported.
The path to a sync configuration file that was used for syncing the groups in question is required in order to
describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups
for which the external record does not exist, to run the pruning process and commit the results, use the --confirm
flag.`)
pruneExamples = templates.Examples(`
# Prune all orphaned groups
%[1]s --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Prune all orphaned groups except the ones from the blacklist file
%[1]s --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Prune all orphaned groups from a list of specific groups specified in a whitelist file
%[1]s --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Prune all orphaned groups from a list of specific groups specified in a whitelist
%[1]s groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm`)
)
type PruneOptions struct {
// Config is the LDAP sync config read from file
Config *api.LDAPSyncConfig
// Whitelist are the names of OpenShift group or LDAP group UIDs to use for syncing
Whitelist []string
// Blacklist are the names of OpenShift group or LDAP group UIDs to exclude
"github.com/openshift/origin/pkg/build/api"
buildutil "github.com/openshift/origin/pkg/build/util"
"github.com/openshift/origin/pkg/cmd/templates"
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
)
var (
buildLogsLong = templates.LongDesc(`
Retrieve logs for a build
This command displays the log for the provided build. If the pod that ran the build has been deleted logs
will no longer be available. If the build has not yet completed, the build logs will be streamed until the
build completes or fails.`)
buildLogsExample = templates.Examples(`
# Stream logs from container
%[1]s build-logs 566bed879d2d`)
)
// NewCmdBuildLogs implements the OpenShift cli build-logs command
func NewCmdBuildLogs(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command {
opts := api.BuildLogOptions{}
cmd := &cobra.Command{
Use: "build-logs BUILD",
Short: "Show logs from a build",
Long: buildLogsLong,
Example: fmt.Sprintf(buildLogsExample, fullName),
Deprecated: fmt.Sprintf("use \"oc %v build/<build-name>\" instead.", LogsRecommendedCommandName),
Run: func(cmd *cobra.Command, args []string) {
err := RunBuildLogs(fullName, f, out, cmd, opts, args)
"github.com/openshift/origin/pkg/client"
"github.com/openshift/origin/pkg/cmd/templates"
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
deployapi "github.com/openshift/origin/pkg/deploy/api"
)
var DeploymentConfigRecommendedName = "deploymentconfig"
var (
deploymentConfigLong = templates.LongDesc(`
Create a deployment config that uses a given image.
Deployment configs define the template for a pod and manages deploying new images or configuration changes.`)
deploymentConfigExample = templates.Examples(`
# Create an nginx deployment config named my-nginx
%[1]s my-nginx --image=nginx`)
)
type CreateDeploymentConfigOptions struct {
DC *deployapi.DeploymentConfig
Client client.DeploymentConfigsNamespacer
DryRun bool
Mapper meta.RESTMapper
OutputFormat string
Out io.Writer
Printer ObjectPrinter
}
and override the current build source settings. When using --from-repo, the --commit flag can be
used to control which branch, tag, or commit is sent to the server. If you pass --from-file, the
file is placed in the root of an empty directory with the same filename. Note that builds
triggered from binary input will not preserve the source on the server, so rebuilds triggered by
base image changes will use the source specified on the build config.`)
startBuildExample = templates.Examples(`
# Starts build from build config "hello-world"
%[1]s start-build hello-world
# Starts build from a previous build "hello-world-1"
%[1]s start-build --from-build=hello-world-1
# Use the contents of a directory as build input
%[1]s start-build hello-world --from-dir=src/
# Send the contents of a Git repository to the server from tag 'v2'
%[1]s start-build hello-world --from-repo=../hello-world --commit=v2
# Start a new build for build config "hello-world" and watch the logs until the build
# completes or fails.
%[1]s start-build hello-world --follow
# Start a new build for build config "hello-world" and wait until the build completes. It
# exits with a non-zero return code if the build fails.
%[1]s start-build hello-world --wait`)
)
// NewCmdStartBuild implements the OpenShift cli start-build command
func NewCmdStartBuild(fullName string, f *clientcmd.Factory, in io.Reader, out, errout io.Writer) *cobra.Command {
o := &StartBuildOptions{}
)
// LinkSecretRecommendedName `oc secrets link`
const LinkSecretRecommendedName = "link"
var (
linkSecretLong = templates.LongDesc(`
Link secrets to a service account
Linking a secret enables a service account to automatically use that secret for some forms of authentication.`)
linkSecretExample = templates.Examples(`
# Add an image pull secret to a service account to automatically use it for pulling pod images:
%[1]s serviceaccount-name pull-secret --for=pull
# Add an image pull secret to a service account to automatically use it for both pulling and pushing build images:
%[1]s builder builder-image-secret --for=pull,mount
# If the cluster's serviceAccountConfig is operating with limitSecretReferences: True, secrets must be added to the pod's service account whitelist in order to be available to the pod:
%[1]s pod-sa pod-secret`)
)
type LinkSecretOptions struct {
SecretOptions
ForMount bool
ForPull bool
typeFlags []string
}
2. Perform an HTTP GET against a URL on a container that must return 200 OK
3. Run a command in the container that must return exit code 0
Containers that take a variable amount of time to start should set generous
initial-delay-seconds values, otherwise as your application evolves you may suddenly begin
to fail.`)
probeExample = templates.Examples(`
# Clear both readiness and liveness probes off all containers
%[1]s probe dc/registry --remove --readiness --liveness
# Set an exec action as a liveness probe to run 'echo ok'
%[1]s probe dc/registry --liveness -- echo ok
# Set a readiness probe to try to open a TCP socket on 3306
%[1]s probe rc/mysql --readiness --open-tcp=3306
# Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP
%[1]s probe dc/webapp --readiness --get-url=http://:8080/healthz
# Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod
%[1]s probe dc/router --readiness --get-url=https://127.0.0.1:1936/stats
# Set only the initial-delay-seconds field on all deployments
%[1]s probe dc --all --readiness --initial-delay-seconds=30`)
)
type ProbeOptions struct {
Out io.Writer
Err io.Writer
Filenames []string
When using the Docker command line to push images, you can authenticate to a given registry by running
'docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to
authenticate to the registry.
When creating applications, you may have a Docker registry that requires authentication. In order for the
nodes to pull images on your behalf, they have to have the credentials. You can provide this information
by creating a dockercfg secret and attaching it to your service account.`)
createDockercfgExample = templates.Examples(`
# Create a new .dockercfg secret:
%[1]s SECRET --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
# Create a new .dockercfg secret from an existing file:
%[2]s SECRET path/to/.dockercfg
# Create a new .docker/config.json secret from an existing file:
%[2]s SECRET .dockerconfigjson=path/to/.docker/config.json
# To add new secret to 'imagePullSecrets' for the node, or 'secrets' for builds, use:
%[3]s SERVICE_ACCOUNT`)
)
type CreateDockerConfigOptions struct {
SecretName string
RegistryLocation string
Username string
Password string
EmailAddress string
SecretsInterface client.SecretsInterface
newAppExample = templates.Examples(` # List all local templates and image streams that can be used to create an app %[1]s %[2]s --list # Create an application based on the source code in the current git repository (with a public remote) # and a Docker image %[1]s %[2]s . --docker-image=repo/langimage # Create a Ruby application based on the provided [image]~[source code] combination %[1]s %[2]s centos/ruby-22-centos7~https://github.com/openshift/ruby-ex.git # Use the public Docker Hub MySQL image to create an app. Generated artifacts will be labeled with db=mysql %[1]s %[2]s mysql MYSQL_USER=user MYSQL_PASSWORD=pass MYSQL_DATABASE=testdb -l db=mysql # Use a MySQL image in a private registry to create an app and override application artifacts' names %[1]s %[2]s --docker-image=myregistry.com/mycompany/mysql --name=private # Create an application from a remote repository using its beta4 branch %[1]s %[2]s https://github.com/openshift/ruby-hello-world#beta4 # Create an application based on a stored template, explicitly setting a parameter value %[1]s %[2]s --template=ruby-helloworld-sample --param=MYSQL_USER=admin # Create an application from a remote repository and specify a context directory %[1]s %[2]s https://github.com/youruser/yourgitrepo --context-dir=src/build # Create an application based on a template file, explicitly setting a parameter value %[1]s %[2]s --file=./example/myapp/template.json --param=MYSQL_USER=admin # Search all templates, image streams, and Docker images for the ones that match "ruby" %[1]s %[2]s --search ruby # Search for "ruby", but only in stored templates (--template, --image-stream and --docker-image # can be used to filter search results) %[1]s %[2]s --search --template=ruby # Search for "ruby" in stored templates and print the output as an YAML %[1]s %[2]s --search --template=ruby --output=yaml`)
// BuildChainRecommendedCommandName is the recommended command name
const BuildChainRecommendedCommandName = "build-chain"
var (
buildChainLong = templates.LongDesc(`
Output the inputs and dependencies of your builds
Supported formats for the generated graph are dot and a human-readable output.
Tag and namespace are optional and if they are not specified, 'latest' and the
default namespace will be used respectively.`)
buildChainExample = templates.Examples(`
# Build the dependency tree for the 'latest' tag in <image-stream>
%[1]s <image-stream>
# Build the dependency tree for 'v2' tag in dot format and visualize it via the dot utility
%[1]s <image-stream>:v2 -o dot | dot -T svg -o deps.svg
# Build the dependency tree across all namespaces for the specified image stream tag found in 'test' namespace
%[1]s <image-stream> -n test --all`)
)
// BuildChainOptions contains all the options needed for build-chain
type BuildChainOptions struct {
name string
defaultNamespace string
namespaces sets.String
allNamespaces bool
triggerOnly bool
reverse bool
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
sdnapi "github.com/openshift/origin/pkg/sdn/api"
)
const JoinProjectsNetworkCommandName = "join-projects"
var (
joinProjectsNetworkLong = templates.LongDesc(`
Join project network
Allows projects to join existing project network when using the %[1]s network plugin.`)
joinProjectsNetworkExample = templates.Examples(`
# Allow project p2 to use project p1 network
%[1]s --to=<p1> <p2>
# Allow all projects with label name=top-secret to use project p1 network
%[1]s --to=<p1> --selector='name=top-secret'`)
)
type JoinOptions struct {
Options *ProjectOptions
joinProjectName string
}
func NewCmdJoinProjectsNetwork(commandName, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command {
opts := &ProjectOptions{}
joinOp := &JoinOptions{Options: opts}
cmd := &cobra.Command{
In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish
to sync and where their records live. For instance, all or some groups may be selected from the current Groups
stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those
stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is
requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry-run
without changing OpenShift records. Passing '--confirm' will sync all groups from the LDAP server returned by the
LDAP query templates.`)
syncExamples = templates.Examples(`
# Sync all groups from an LDAP server
%[1]s --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Sync all groups except the ones from the blacklist file from an LDAP server
%[1]s --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Sync specific groups specified in a whitelist file with an LDAP server
%[1]s --whitelist=/path/to/whitelist.txt --sync-config=/path/to/sync-config.yaml --confirm
# Sync all OpenShift Groups that have been synced previously with an LDAP server
%[1]s --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm
# Sync specific OpenShift Groups if they have been synced previously with an LDAP server
%[1]s groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm`)
)
// GroupSyncSource determines the source of the groups to be synced
type GroupSyncSource string
const (
// GroupSyncSourceLDAP determines that the groups to be synced are determined from an LDAP record
GroupSyncSourceLDAP GroupSyncSource = "ldap"
The --adjust flag allows you to alter the weight of an individual service relative to
itself or to the primary backend. Specifying a percentage will adjust the backend
relative to either the primary or the first alternate (if you specify the primary).
If there are other backends their weights will be kept proportional to the changed.
Not all routers may support multiple or weighted backends.`)
backendsExample = templates.Examples(`
# Print the backends on the route 'web'
%[1]s route-backends web
# Set two backend services on route 'web' with 2/3rds of traffic going to 'a'
%[1]s route-backends web a=2 b=1
# Increase the traffic percentage going to b by 10%% relative to a
%[1]s route-backends web --adjust b=+10%%
# Set traffic percentage going to b to 10%% of the traffic going to a
%[1]s route-backends web --adjust b=10%%
# Set weight of b to 10
%[1]s route-backends web --adjust b=10
# Set the weight to all backends to zero
%[1]s route-backends web --zero`)
)
type BackendsOptions struct {
Out io.Writer
Err io.Writer
Filenames []string
Update cluster role bindings to match the recommended bootstrap policy
This command will inspect the cluster role bindings against the recommended bootstrap policy.
Any cluster role binding that does not match will be replaced by the recommended bootstrap role binding.
This command will not remove any additional cluster role bindings.
You can see which recommended cluster role bindings have changed by choosing an output type.`)
reconcileBindingsExample = templates.Examples(`
# Display the names of cluster role bindings that would be modified
%[1]s -o name
# Display the cluster role bindings that would be modified, removing any extra subjects
%[1]s --additive-only=false
# Update cluster role bindings that don't match the current defaults
%[1]s --confirm
# Update cluster role bindings that don't match the current defaults, avoid adding roles to the system:authenticated group
%[1]s --confirm --exclude-groups=system:authenticated
# Update cluster role bindings that don't match the current defaults, removing any extra subjects from the binding
%[1]s --confirm --additive-only=false`)
)
// NewCmdReconcileClusterRoleBindings implements the OpenShift cli reconcile-cluster-role-bindings command
func NewCmdReconcileClusterRoleBindings(name, fullName string, f *clientcmd.Factory, out, err io.Writer) *cobra.Command {
o := &ReconcileClusterRoleBindingsOptions{
Out: out,
Err: err,
Union: true,
For descriptions on other volume types, see https://docs.openshift.com`) volumeExample = templates.Examples(` # List volumes defined on all deployment configs in the current project %[1]s volume dc --all # Add a new empty dir volume to deployment config (dc) 'registry' mounted under # /var/lib/registry %[1]s volume dc/registry --add --mount-path=/var/lib/registry # Use an existing persistent volume claim (pvc) to overwrite an existing volume 'v1' %[1]s volume dc/registry --add --name=v1 -t pvc --claim-name=pvc1 --overwrite # Remove volume 'v1' from deployment config 'registry' %[1]s volume dc/registry --remove --name=v1 # Create a new persistent volume claim that overwrites an existing volume 'v1' %[1]s volume dc/registry --add --name=v1 -t pvc --claim-size=1G --overwrite # Change the mount point for volume 'v1' to /data %[1]s volume dc/registry --add --name=v1 -m /data --overwrite # Modify the deployment config by removing volume mount "v1" from container "c1" # (and by removing the volume "v1" if no other containers have volume mounts that reference it) %[1]s volume dc/registry --remove --name=v1 --containers=c1 # Add new volume based on a more complex volume source (Git repo, AWS EBS, GCE PD, # Ceph, Gluster, NFS, ISCSI, ...) %[1]s volume dc/registry --add -m /repo --source=<json-string>`) )
cmd.AddCommand(NewCmdCreateReencryptRoute(fullName, f, out))
return cmd
}
var (
edgeRouteLong = templates.LongDesc(`
Create a route that uses edge TLS termination
Specify the service (either just its name or using type/name syntax) that the
generated route should expose via the --service flag.`)
edgeRouteExample = templates.Examples(`
# Create an edge route named "my-route" that exposes frontend service.
%[1]s create route edge my-route --service=frontend
# Create an edge route that exposes the frontend service and specify a path.
# If the route name is omitted, the service name will be re-used.
%[1]s create route edge --service=frontend --path /assets`)
)
// NewCmdCreateEdgeRoute is a macro command to create an edge route.
func NewCmdCreateEdgeRoute(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command {
cmd := &cobra.Command{
Use: "edge [NAME] --service=SERVICE",
Short: "Create a route that uses edge TLS termination",
Long: edgeRouteLong,
Example: fmt.Sprintf(edgeRouteExample, fullName),
Run: func(cmd *cobra.Command, args []string) {
err := CreateEdgeRoute(f, out, cmd, args)
kcmdutil.CheckErr(err)
)
var (
idleLong = templates.LongDesc(`
Idle scalable resources
Idling discovers the scalable resources (such as deployment configs and replication controllers)
associated with a series of services by examining the endpoints of the service.
Each service is then marked as idled, the associated resources are recorded, and the resources
are scaled down to zero replicas.
Upon receiving network traffic, the services (and any associated routes) will "wake up" the
associated resources by scaling them back up to their previous scale.`)
idleExample = templates.Examples(`
# Idle the scalable controllers associated with the services listed in to-idle.txt
$ %[1]s idle --resource-names-file to-idle.txt`)
)
// NewCmdIdle implements the OpenShift cli idle command
func NewCmdIdle(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command {
o := &IdleOptions{
out: out,
errOut: errOut,
cmdFullName: fullName,
}
cmd := &cobra.Command{
Use: "idle (SERVICE_ENDPOINTS... | -l label | --all | --resource-names-file FILENAME)",
Short: "Idle scalable resources",
Long: idleLong,
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/runtime"
authorizationapi "github.com/openshift/origin/pkg/authorization/api"
"github.com/openshift/origin/pkg/client"
"github.com/openshift/origin/pkg/cmd/templates"
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
)
const PolicyBindingRecommendedName = "policybinding"
var (
policyBindingLong = templates.LongDesc(`Create a policy binding that references the policy in the targeted namespace.`)
policyBindingExample = templates.Examples(`
# Create a policy binding in namespace "foo" that references the policy in namespace "bar"
%[1]s bar -n foo`)
)
type CreatePolicyBindingOptions struct {
BindingNamespace string
PolicyNamespace string
BindingClient client.PolicyBindingsNamespacer
Mapper meta.RESTMapper
OutputFormat string
Out io.Writer
Printer ObjectPrinter
}
EncryptedFile string
// EncryptedWriter has encrypted data written to it if EncryptedFile is unspecified.
EncryptedWriter io.Writer
// KeyFile contains the password in PEM format (as previously written by GenKeyFile)
KeyFile string
// GenKeyFile indicates a key should be generated and written
GenKeyFile string
// PromptWriter is used to write status and prompt messages
PromptWriter io.Writer
}
var encryptExample = templates.Examples(`
# Encrypt the content of secret.txt with a generated key:
%[1]s --genkey=secret.key --in=secret.txt --out=secret.encrypted
# Encrypt the content of secret2.txt with an existing key:
%[1]s --key=secret.key < secret2.txt > secret2.encrypted`)
func NewCommandEncrypt(commandName string, fullName string, out io.Writer, errout io.Writer) *cobra.Command {
options := &EncryptOptions{
CleartextReader: os.Stdin,
EncryptedWriter: out,
PromptWriter: errout,
}
cmd := &cobra.Command{
Use: commandName,
Short: "Encrypt data with AES-256-CBC encryption",
Example: fmt.Sprintf(encryptExample, fullName),
Run: func(cmd *cobra.Command, args []string) {
)
const (
TopImagesRecommendedName = "images"
maxImageIDLength = 20
)
var (
topImagesLong = templates.LongDesc(`
Show usage statistics for Images
This command analyzes all the Images managed by the platform and presents current
usage statistics.`)
topImagesExample = templates.Examples(`
# Show usage statistics for Images
%[1]s %[2]s`)
)
// NewCmdTopImages implements the OpenShift cli top images command.
func NewCmdTopImages(f *clientcmd.Factory, parentName, name string, out io.Writer) *cobra.Command {
opts := &TopImagesOptions{}
cmd := &cobra.Command{
Use: name,
Short: "Show usage statistics for Images",
Long: topImagesLong,
Example: fmt.Sprintf(topImagesExample, parentName, name),
Run: func(cmd *cobra.Command, args []string) {
kcmdutil.CheckErr(opts.Complete(f, cmd, args, out))
kcmdutil.CheckErr(opts.Validate(cmd))
kcmdutil.CheckErr(opts.Run())
If an IP failover configuration does not exist with the given name,
the --create flag can be passed to create a deployment configuration that
will provide IP failover capability. If you are running in production, it is
recommended that the labeled selector for the nodes matches at least 2 nodes
to ensure you have failover protection, and that you provide a --replicas=<n>
value that matches the number of nodes for the given labeled selector.`)
ipFailover_example = templates.Examples(`
# Check the default IP failover configuration ("ipfailover"):
%[1]s %[2]s
# See what the IP failover configuration would look like if it is created:
%[1]s %[2]s -o json
# Create an IP failover configuration if it does not already exist:
%[1]s %[2]s ipf --virtual-ips="10.1.1.1-4" --create
# Create an IP failover configuration on a selection of nodes labeled
# "router=us-west-ha" (on 4 nodes with 7 virtual IPs monitoring a service
# listening on port 80, such as the router process).
%[1]s %[2]s ipfailover --selector="router=us-west-ha" --virtual-ips="1.2.3.4,10.1.1.100-104,5.6.7.8" --watch-port=80 --replicas=4 --create
# Use a different IP failover config image and see the configuration:
%[1]s %[2]s ipf-alt --selector="hagroup=us-west-ha" --virtual-ips="1.2.3.4" -o yaml --images=myrepo/myipfailover:mytag`)
)
func NewCmdIPFailoverConfig(f *clientcmd.Factory, parentName, name string, out, errout io.Writer) *cobra.Command {
options := &ipfailover.IPFailoverConfigCmdOptions{
Action: configcmd.BulkAction{
Out: out,
ErrOut: errout,
Log in to your server and save login for subsequent use
First-time users of the client should run this command to connect to a server,
establish an authenticated session, and save connection to the configuration file. The
default configuration will be saved to your home directory under
".kube/config".
The information required to login -- like username and password, a session token, or
the server details -- can be provided through flags. If not provided, the command will
prompt for user input as needed.`)
loginExample = templates.Examples(`
# Log in interactively
%[1]s login
# Log in to the given server with the given certificate authority file
%[1]s login localhost:8443 --certificate-authority=/path/to/cert.crt
# Log in to the given server with the given credentials (will not prompt interactively)
%[1]s login localhost:8443 --username=myuser --password=mypass`)
)
// NewCmdLogin implements the OpenShift cli login command
func NewCmdLogin(fullName string, f *osclientcmd.Factory, reader io.Reader, out io.Writer) *cobra.Command {
options := &LoginOptions{
Reader: reader,
Out: out,
}
cmds := &cobra.Command{
Use: "login [URL]",
appJSONLong = templates.LongDesc(`
Import app.json files as OpenShift objects
app.json defines the pattern of a simple, stateless web application that can be horizontally scaled.
This command will transform a provided app.json object into its OpenShift equivalent.
During transformation fields in the app.json syntax that are not relevant when running on top of
a containerized platform will be ignored and a warning printed.
The command will create objects unless you pass the -o yaml or --as-template flags to generate a
configuration file for later use.
Experimental: This command is under active development and may change without notice.`)
appJSONExample = templates.Examples(`
# Import a directory containing an app.json file
$ %[1]s app.json -f .
# Turn an app.json file into a template
$ %[1]s app.json -f ./app.json -o yaml --as-template`)
)
type AppJSONOptions struct {
Action configcmd.BulkAction
In io.Reader
Filenames []string
BaseImage string
Generator string
AsTemplate string
PrintObject func(runtime.Object) error
"github.com/openshift/origin/pkg/cmd/templates"
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
imageapi "github.com/openshift/origin/pkg/image/api"
)
const ImageStreamRecommendedName = "imagestream"
var (
imageStreamLong = templates.LongDesc(`
Create a new image stream
Image streams allow you to track, tag, and import images from other registries. They also define an
access controlled destination that you can push images to.`)
imageStreamExample = templates.Examples(`
# Create a new image stream
%[1]s mysql`)
)
type CreateImageStreamOptions struct {
IS *imageapi.ImageStream
Client client.ImageStreamsNamespacer
DryRun bool
Mapper meta.RESTMapper
OutputFormat string
Out io.Writer
Printer ObjectPrinter
}
Important: when handling deletes, the previous state of the object may not be
available and only the name/namespace of the object will be passed to your
--delete command as arguments (all custom arguments are omitted).
More complicated interactions build on the two examples above - your inventory
script could make a call to allocate storage on your infrastructure as a
service, or register node names in DNS, or set complex firewalls. The more
complex your integration, the more important it is to record enough data in the
remote system that you can identify when resources on either side are deleted.
Experimental: This command is under active development and may change without notice.`)
observeExample = templates.Examples(`
# Observe changes to services
%[1]s observe services
# Observe changes to services, including the clusterIP and invoke a script for each
%[1]s observe services -a '{ .spec.clusterIP }' -- register_dns.sh`)
)
// NewCmdObserve creates the observe command.
func NewCmdObserve(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *cobra.Command {
options := &ObserveOptions{
baseCommandName: fullName,
retryCount: 2,
templateType: "jsonpath",
maximumErrors: 20,
listenAddr: ":11251",
}
cmd := &cobra.Command{
updated whenever an image stream tag is updated.
Build configs support triggering off of image changes, config changes, and webhooks (both GitHub-specific
and generic). The config change trigger for a build config will only trigger the first build.`)
triggersExample = templates.Examples(`
# Print the triggers on the registry
%[1]s triggers dc/registry
# Set all triggers to manual
%[1]s triggers dc/registry --manual
# Enable all automatic triggers
%[1]s triggers dc/registry --auto
# Reset the GitHub webhook on a build to a new, generated secret
%[1]s triggers bc/webapp --from-github
%[1]s triggers bc/webapp --from-webhook
# Remove all triggers
%[1]s triggers bc/webapp --remove-all
# Stop triggering on config change
%[1]s triggers dc/registry --from-config --remove
# Add an image trigger to a build config
%[1]s triggers bc/webapp --from-image=namespace1/image:latest`)
)
type TriggersOptions struct {
Out io.Writer
Err io.Writer
var (
rsyncLong = templates.LongDesc(`
Copy local files to or from a pod container
This command will copy local files to or from a remote container.
It only copies the changed files using the rsync command from your OS.
To ensure optimum performance, install rsync locally. In UNIX systems,
use your package manager. In Windows, install cwRsync from
https://www.itefix.net/cwrsync.
If no container is specified, the first container of the pod is used
for the copy.`)
rsyncExample = templates.Examples(`
# Synchronize a local directory with a pod directory
%[1]s ./local/dir/ POD:/remote/dir
# Synchronize a pod directory with a local directory
%[1]s POD:/remote/dir/ ./local/dir`)
)
// copyStrategy
type copyStrategy interface {
Copy(source, destination *pathSpec, out, errOut io.Writer) error
Validate() error
String() string
}
// executor executes commands
type executor interface {
Execute(command []string, in io.Reader, out, err io.Writer) error
}
* jobs
* pods
* replicationcontrollers
* secrets (docker)
Only images, imagestreams, and secrets are updated by default. Updating images and image
streams requires administrative privileges.`)
internalMigrateImagesExample = templates.Examples(`
# Perform a dry-run of migrating all "docker.io" references to "myregistry.com"
%[1]s docker.io/*=myregistry.com/*
# To actually perform the migration, the confirm flag must be appended
%[1]s docker.io/*=myregistry.com/* --confirm
# To see more details of what will be migrated, use the loglevel and output flags
%[1]s docker.io/*=myregistry.com/* --loglevel=2 -o yaml
# Migrate from a service IP to an internal service DNS name
%[1]s 172.30.1.54/*=registry.openshift.svc.cluster.local/*
# Migrate from a service IP to an internal service DNS name for all deployment configs and builds
%[1]s 172.30.1.54/*=registry.openshift.svc.cluster.local/* --include=buildconfigs,deploymentconfigs`)
)
type MigrateImageReferenceOptions struct {
migrate.ResourceOptions
Client client.Interface
Mappings ImageReferenceMappings
UpdatePodSpecFn func(obj runtime.Object, fn func(*kapi.PodSpec) error) (bool, error)
var (
exposeLong = templates.LongDesc(`
Expose containers internally as services or externally via routes
There is also the ability to expose a deployment configuration, replication controller, service, or pod
as a new service on a specified port. If no labels are specified, the new object will re-use the
labels from the object it exposes.`)
exposeExample = templates.Examples(`
# Create a route based on service nginx. The new route will re-use nginx's labels
%[1]s expose service nginx
# Create a route and specify your own label and route name
%[1]s expose service nginx -l name=myroute --name=fromdowntown
# Create a route and specify a hostname
%[1]s expose service nginx --hostname=www.example.com
# Expose a deployment configuration as a service and use the specified port
%[1]s expose dc ruby-hello-world --port=8080
# Expose a service as a route in the specified path
%[1]s expose service nginx --path=/nginx`)
)
// NewCmdExpose is a wrapper for the Kubernetes cli expose command
func NewCmdExpose(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command {
cmd := kcmd.NewCmdExposeService(f.Factory, out)
cmd.Short = "Expose a replicated application as a service or route"
cmd.Long = exposeLong
cmd.Example = fmt.Sprintf(exposeExample, fullName)
var (
newLong = templates.LongDesc(`
Create a new secret based on a file or directory
Key files can be specified using their file path, in which case a default name will be given to them, or optionally
with a name and file path, in which case the given name will be used. Specifying a directory will create a secret
using with all valid keys in that directory.`)
newExample = templates.Examples(`
# Create a new secret named my-secret with a key named ssh-privatekey
%[1]s my-secret ~/.ssh/ssh-privatekey
# Create a new secret named my-secret with keys named ssh-privatekey and ssh-publickey instead of the names of the keys on disk
%[1]s my-secret ssh-privatekey=~/.ssh/id_rsa ssh-publickey=~/.ssh/id_rsa.pub
# Create a new secret named my-secret with keys for each file in the folder "bar"
%[1]s my-secret path/to/bar
# Create a new .dockercfg secret named my-secret
%[1]s my-secret path/to/.dockercfg
# Create a new .docker/config.json secret named my-secret
%[1]s my-secret .dockerconfigjson=path/to/.docker/config.json`)
)
type CreateSecretOptions struct {
// Name of the resulting secret
Name string
// SecretTypeName is the type to use when creating the secret. It is checked against known types.
SecretTypeName string
