Chapter 4. Developer CLI commands

Display documentation for a certain resource.

$ oc explain pods

oc explain pods

Log in to the OpenShift Container Platform server and save login information for subsequent use.

$ oc login

oc login

$ oc login -u user1

oc login -u user1

Create a new application by specifying source code, a template, or an image.

$ oc new-app .

oc new-app .

$ oc new-app https://github.com/sclorg/cakephp-ex

oc new-app https://github.com/sclorg/cakephp-ex

$ oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret

oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret

Create a new project and switch to it as the default project in your configuration.

$ oc new-project myproject

oc new-project myproject

Switch to another project and make it the default in your configuration.

$ oc project test-project

oc project test-project

Display information about the current active project and existing projects on the server.

$ oc projects

oc projects

Show a high-level overview of the current project.

$ oc status

oc status

Cancel a running, pending, or new build.

$ oc cancel-build python-1

oc cancel-build python-1

$ oc cancel-build buildconfig/python --state=pending

oc cancel-build buildconfig/python --state=pending

Import the latest tag and image information from an image repository.

$ oc import-image my-ruby

oc import-image my-ruby

Create a new BuildConfig from source code.

$ oc new-build .

oc new-build .

$ oc new-build https://github.com/sclorg/cakephp-ex

oc new-build https://github.com/sclorg/cakephp-ex

Revert an application back to a previous Deployment.

$ oc rollback php

oc rollback php

$ oc rollback php --to-version=3

oc rollback php --to-version=3

Start a new rollout, view its status or history, or roll back to a previous revision of your application.

$ oc rollout undo deploymentconfig/php

oc rollout undo deploymentconfig/php

$ oc rollout latest deploymentconfig/php

oc rollout latest deploymentconfig/php

Start a build from a BuildConfig or copy an existing build.

$ oc start-build python

oc start-build python

$ oc start-build --from-build=python-1

oc start-build --from-build=python-1

$ oc start-build python --env=mykey=myvalue

oc start-build python --env=mykey=myvalue

Tag existing images into imagestreams.

$ oc tag ruby:latest ruby:2.0

oc tag ruby:latest ruby:2.0

Update the annotations on one or more resources.

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"

oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-

oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-

Apply a configuration to a resource by file name or standard in (stdin) in JSON or YAML format.

$ oc apply -f pod.json

oc apply -f pod.json

Autoscale a DeploymentConfig or ReplicationController.

$ oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5

oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5

Create a resource by file name or standard in (stdin) in JSON or YAML format.

$ oc create -f pod.json

oc create -f pod.json

Delete a resource.

$ oc delete pod/parksmap-katacoda-1-qfqz4

oc delete pod/parksmap-katacoda-1-qfqz4

$ oc delete pods -l app=parksmap-katacoda

oc delete pods -l app=parksmap-katacoda

Return detailed information about a specific object.

$ oc describe deployment/example

oc describe deployment/example

$ oc describe pods

oc describe pods

Edit a resource.

$ oc edit deploymentconfig/parksmap-katacoda

oc edit deploymentconfig/parksmap-katacoda

$ OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda

OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda

$ oc edit deploymentconfig/parksmap-katacoda -o json

oc edit deploymentconfig/parksmap-katacoda -o json

Expose a Service externally as a Route.

$ oc expose service/parksmap-katacoda

oc expose service/parksmap-katacoda

$ oc expose service/parksmap-katacoda --hostname=www.my-host.com

oc expose service/parksmap-katacoda --hostname=www.my-host.com

Display one or more resources.

$ oc get pods -n default

oc get pods -n default

$ oc get deploymentconfig/python -o json

oc get deploymentconfig/python -o json

Update the labels on one or more resources.

$ oc label pod/python-1-mz2rf status=unhealthy

oc label pod/python-1-mz2rf status=unhealthy

Set the desired number of replicas for a ReplicationController or a DeploymentConfig.

$ oc scale deploymentconfig/ruby-app --replicas=3

oc scale deploymentconfig/ruby-app --replicas=3

Manage secrets in your project.

$ oc secrets link default my-pull-secret --for=pull

oc secrets link default my-pull-secret --for=pull

Get a token assigned to a service account or create a new token or kubeconfig file for a service account.

$ oc serviceaccounts get-token default

oc serviceaccounts get-token default

Configure existing application resources.

$ oc set build-secret --source buildconfig/mybc mysecret

oc set build-secret --source buildconfig/mybc mysecret

Attach the shell to a running container.

$ oc attach python-1-mz2rf -c python

oc attach python-1-mz2rf -c python

Copy files and directories to and from containers.

$ oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.

oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.

Launch a command shell to debug a running application.

$ oc debug deploymentconfig/python

oc debug deploymentconfig/python

Execute a command in a container.

$ oc exec python-1-mz2rf -c python ls

oc exec python-1-mz2rf -c python ls

Retrieve the log output for a specific build, BuildConfig, DeploymentConfig, or Pod.

$ oc logs -f deploymentconfig/python

oc logs -f deploymentconfig/python

Forward one or more local ports to a Pod.

$ oc port-forward python-1-mz2rf 8888:5000

oc port-forward python-1-mz2rf 8888:5000

Run a proxy to the Kubernetes API server.

$ oc proxy --port=8011 --www=./local/www/

oc proxy --port=8011 --www=./local/www/

Open a remote shell session to a container.

$ oc rsh python-1-mz2rf

oc rsh python-1-mz2rf

Copy contents of a directory to or from a running Pod container. Only changed files are copied using the rsync command from your operating system.

$ oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/

oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/

Create and run a particular image. By default, this creates a DeploymentConfig to manage the created containers.

$ oc run my-test --image=perl --replicas=3

oc run my-test --image=perl --replicas=3

Wait for a specific condition on one or more resources.

$ oc wait --for=delete pod/python-1-mz2rf

oc wait --for=delete pod/python-1-mz2rf

Display the full list of API resources that the server supports.

$ oc api-resources

oc api-resources

Display the full list of API versions that the server supports.

$ oc api-versions

oc api-versions

Inspect permissions and reconcile RBAC roles.

$ oc auth can-i get pods --subresource=log

oc auth can-i get pods --subresource=log

$ oc auth reconcile -f policy.json

oc auth reconcile -f policy.json

Display the address of the master and cluster services.

$ oc cluster-info

oc cluster-info

Convert a YAML or JSON configuration file to a different API version and print to standard output (stdout).

$ oc convert -f pod.yaml

oc convert -f pod.yaml

Extract the contents of a ConfigMap or secret. Each key in the ConfigMap or secret is created as a separate file with the name of the key.

$ oc extract configmap/ruby-1-ca

oc extract configmap/ruby-1-ca

$ oc extract configmap/ruby-1-ca --to=-

oc extract configmap/ruby-1-ca --to=-

Idle scalable resources. An idled Service will automatically become unidled when it receives traffic or it can be manually unidled using the oc scale command.

$ oc idle ruby-app

oc idle ruby-app

Manage images in your OpenShift Container Platform cluster.

$ oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable

oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable

Observe changes to resources and take action on them.

$ oc observe services

oc observe services

Updates one or more fields of an object using strategic merge patch in JSON or YAML format.

$ oc patch node/node1 -p '{"spec":{"unschedulable":true}}'

oc patch node/node1 -p '{"spec":{"unschedulable":true}}'

Manage authorization policies.

$ oc policy add-role-to-user edit user1

oc policy add-role-to-user edit user1

Process a template into a list of resources.

$ oc process -f template.json | oc create -f -

oc process -f template.json | oc create -f -

Manage the integrated registry on OpenShift Container Platform.

$ oc registry info

oc registry info

Modify an existing object based on the contents of the specified configuration file.

$ oc replace -f pod.json

oc replace -f pod.json

Output shell completion code for the specified shell.

$ oc completion bash

oc completion bash

Manage the client configuration files.

$ oc config view

oc config view

$ oc config use-context test-context

oc config use-context test-context

Log out of the current session.

$ oc logout

oc logout

Display information about the current session.

$ oc whoami

oc whoami

Display general help information for the CLI and a list of available commands.

$ oc help

oc help

$ oc help new-project

oc help new-project

List the available plug-ins on the user’s PATH.

$ oc plugin list

oc plugin list

Display the oc client and server versions.

$ oc version

oc version