openshift-cli-deploy man page

openshift cli deploy — View, start, cancel, or retry a deployment


openshift cli deploy [Options]


View, start, cancel, or retry a deployment

This command allows you to control a deployment config. Each individual deployment is exposed as a new replication controller, and the deployment process manages scaling down old deployments and scaling up new ones. Use 'openshift cli rollback' to rollback to any previous deployment.

There are several deployment strategies defined:

· Rolling (default) - scales up the new deployment in stages, gradually reducing the number of old deployments. If one of the new deployed pods never becomes "ready", the new deployment will be rolled back (scaled down to zero). Use when your application can tolerate two versions of code running at the same time (many web applications, scalable databases)

· Recreate - scales the old deployment down to zero, then scales the new deployment up to full. Use when your application cannot tolerate two versions of code running at the same time

· Custom - run your own deployment process inside a Docker container using your own scripts.

If a deployment fails, you may opt to retry it (if the error was transient). Some deployments may never successfully complete - in which case you can use the '--latest' flag to force a redeployment. If a deployment config has completed deploying successfully at least once in the past, it would be automatically rolled back in the event of a new failed deployment. Note that you would still need to update the erroneous deployment config in order to have its template persisted across your application.

If you want to cancel a running deployment, use '--cancel' but keep in mind that this is a best-effort operation and may take some time to complete. It’s possible the deployment will partially or totally complete before the cancellation is effective. In such a case an appropriate event will be emitted.

If no options are given, shows information about the latest deployment.


Cancel the in-progress deployment.
Enables all image triggers for the deployment config.
Follow the logs of a deployment
Start a new deployment now.
Retry the latest failed deployment.

Options Inherited from Parent Commands

DEPRECATED: The API version to use when talking to the server

Username to impersonate for the operation.

Path to a cert. file for the certificate authority.

Path to a client certificate file for TLS.

Path to a client key file for TLS.

The name of the kubeconfig cluster to use

Path to the config file to use for CLI requests.

The name of the kubeconfig context to use

The Google Cloud Platform Service Account JSON Key to use for authentication.

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

Maximum number of seconds between log flushes

Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request.

The address and port of the Kubernetes API server

Bearer token for authentication to the API server.

The name of the kubeconfig user to use


# Display the latest deployment for the 'database' deployment config
openshift cli deploy database

# Start a new deployment based on the 'database'
openshift cli deploy database --latest

# Start a new deployment and follow its log
openshift cli deploy database --latest --follow

# Retry the latest failed deployment based on 'frontend'
# The deployer pod and any hook pods are deleted for the latest failed deployment
openshift cli deploy frontend --retry

# Cancel the in-progress deployment based on 'frontend'
openshift cli deploy frontend --cancel

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Explore man page connections for openshift-cli-deploy(1).

Openshift Openshift CLI User Manuals June 2016