Chapter 1. OpenShift CLI (oc)

Example: Display documentation for Pods

$ oc explain pods

Example: Interactive login

$ oc login

Example: Log in specifying a user name

$ oc login -u user1

Example: Create a new application from a local Git repository

$ oc new-app .

Example: Create a new application from a remote Git repository

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

Example: Create a new application from a private remote repository

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

Example: Create a new project

$ oc new-project myproject

Example: Switch to a different project

$ oc project test-project

Example: List all projects

$ oc projects

Example: Show the status of the current project

$ oc status

Example: Cancel a build

$ oc cancel-build python-1

Example: Cancel all pending builds from the python BuildConfig

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

Example: Import the latest image information

$ oc import-image my-ruby

Example: Create a BuildConfig from a local Git repository

$ oc new-build .

Example: Create a BuildConfig from a remote Git repository

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

Example: Roll back to the last successful Deployment

$ oc rollback php

Example: Roll back to a specific version

$ oc rollback php --to-version=3

Example: Roll back to the last successful Deployment

$ oc rollout undo deploymentconfig/php

Example: Start a new rollout for a DeploymentConfig with its latest state

$ oc rollout latest deploymentconfig/php

Example: Start a build from the specified BuildConfig

$ oc start-build python

Example: Start a build from a previous build

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

Example: Set an environment variable to use for the current build

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

Example: Configure the ruby image’s latest tag to refer to the image for the 2.0 tag

$ oc tag ruby:latest ruby:2.0

Example: Add an annotation to a Route

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

Example: Remove the annotation from the Route

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

Example: Apply the configuration in pod.json to a Pod

$ oc apply -f pod.json

Example: Autoscale to a minimum of two and maximum of five Pods

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

Example: Create a Pod using the content in pod.json

$ oc create -f pod.json

Example: Delete a Pod named parksmap-katacoda-1-qfqz4

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

Example: Delete all Pods with the app=parksmap-katacoda label

$ oc delete pods -l app=parksmap-katacoda

Example: Describe a Deployment named example

$ oc describe deployment/example

Example: Describe all Pods

$ oc describe pods

Example: Edit a DeploymentConfig using the default editor

$ oc edit deploymentconfig/parksmap-katacoda

Example: Edit a DeploymentConfig using a different editor

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

Example: Edit a DeploymentConfig in JSON format

$ oc edit deploymentconfig/parksmap-katacoda -o json

Example: Expose a Service

$ oc expose service/parksmap-katacoda

Example: Expose a Service and specify the host name

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

Example: List Pods in the default namespace

$ oc get pods -n default

Example: Get details about the python DeploymentConfig in JSON format

$ oc get deploymentconfig/python -o json

Example: Update the python-1-mz2rf Pod with the label status set to unhealthy

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

Example: Scale the ruby-app DeploymentConfig to three Pods

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

Example: Allow my-pull-secret to be used as an image pull secret by the default service account

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

Example: Get the token assigned to the default service account

$ oc serviceaccounts get-token default

Example: Sets the name of a secret on a BuildConfig

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

Example: Get output from the python container from Pod python-1-mz2rf

$ oc attach python-1-mz2rf -c python

Example: Copy a file from the python-1-mz2rf Pod to the local file system

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

Example: Debug the python Deployment

$ oc debug deploymentconfig/python

Example: Execute the ls command in the python container from Pod python-1-mz2rf

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

Example: Stream the latest logs from the python DeploymentConfig

$ oc logs -f deploymentconfig/python

Example: Listen on port 8888 locally and forward to port 5000 in the Pod

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

Example: Run a proxy to the API server on port 8011 serving static content from ./local/www/

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

Example: Open a shell session on the first container in the python-1-mz2rf Pod

$ oc rsh python-1-mz2rf

Example: Synchronize files from a local directory with a Pod directory

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

Example: Start an instance of the perl image with three replicas

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

Example: Wait for the python-1-mz2rf Pod to be deleted

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

Example: List the supported API resources

$ oc api-resources

Example: List the supported API versions

$ oc api-versions

Example: Check whether the current user can read Pod logs

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

Example: Reconcile RBAC roles and permissions from a file

$ oc auth reconcile -f policy.json

Example: Display cluster information

$ oc cluster-info

Example: Convert pod.yaml to the latest version

$ oc convert -f pod.yaml

Example: Download the contents of the ruby-1-ca ConfigMap to the current directory

$ oc extract configmap/ruby-1-ca

Example: Print the contents of the ruby-1-ca ConfigMap to stdout

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

Example: Idle the ruby-app Service

$ oc idle ruby-app

Example: Copy an image to another tag

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

Example: Observe changes to Services

$ oc observe services

Example: Update the spec.unschedulable field for node node1 to true

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

Example: Add the edit role to user1 for the current project

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

Example: Convert template.json to a resource list and pass to oc create

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

Example: Display information about the integrated registry

$ oc registry info

Example: Update a Pod using the content in pod.json

$ oc replace -f pod.json

Example: Display completion code for Bash

$ oc completion bash

Example: Display the current configuration

$ oc config view

Example: Switch to a different context

$ oc config use-context test-context

Example: End the current session

$ oc logout

Example: Display the currently authenticated user

$ oc whoami

Example: Display available commands

$ oc help

Example: Display the help for the new-project command

$ oc help new-project

Example: List available plug-ins

$ oc plugin list

Example: Display version information

$ oc version

Example: Gather debugging information

$ oc adm must-gather

Example: Show CPU and memory usage for Pods

$ oc adm top pods

Example: Show usage statistics for images

$ oc adm top images

Example: Mark node1 as unschedulable

$ oc adm cordon node1

Example: Drain node1

$ oc adm drain node1

Example: Get logs for NetworkManager

$ oc adm node-logs --role master -u NetworkManager.service

Example: Add a taint to dedicate a node for a set of users

$ oc adm taint nodes node1 dedicated=groupName:NoSchedule

Example: Remove the taints with key dedicated from node node1

$ oc adm taint nodes node1 dedicated-

Example: Mark node1 as schedulable

$ oc adm uncordon node1

Example: Approve a CSR

$ oc adm certificate approve csr-sqgzp

Example: Create a new group

$ oc adm groups new my-group

Example: Create a new project using a node selector

$ oc adm new-project myproject --node-selector='type=user-node,region=east'

Example: Isolate project1 and project2 from other non-global projects

$ oc adm pod-network isolate-projects project1 project2

Example: Add the edit role to user1 for all projects

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

Example: Add the privileged security context constraint to a service account

$ oc adm policy add-scc-to-user privileged -z myserviceaccount

Example: Perform an update of all stored objects

$ oc adm migrate storage

Example: Perform an update of only Pods

$ oc adm migrate storage --include=pods

Example: Prune older builds including those whose BuildConfigs no longer exist

$ oc adm prune builds --orphans

Example: Generate a client certificate for a proxy

$ oc adm create-api-client-config \
  --certificate-authority='/etc/origin/master/proxyca.crt' \
  --client-dir='/etc/origin/master/proxy' \
  --signer-cert='/etc/origin/master/proxyca.crt' \
  --signer-key='/etc/origin/master/proxyca.key' \
  --signer-serial='/etc/origin/master/proxyca.serial.txt' \
  --user='system:proxy'

Example: Create a file called policy.json with the default bootstrap policy

$ oc adm create-bootstrap-policy-file --filename=policy.json

Example: Output a bootstrap project template in YAML format to stdout

$ oc adm create-bootstrap-project-template -o yaml

Example: Output a template for the error page to stdout

$ oc adm create-error-template

Example: Create a .kubeconfig file with the provided client certificates

$ oc adm create-kubeconfig \
  --client-certificate=/path/to/client.crt \
  --client-key=/path/to/client.key \
  --certificate-authority=/path/to/ca.crt

Example: Output a template for the login page to stdout

$ oc adm create-login-template

Example: Output a template for the provider selection page to stdout

$ oc adm create-provider-selection-template

Example: Output dependencies for the perl imagestream

$ oc adm build-chain perl

Example: Display oc adm completion code for Bash

$ oc adm completion bash

Example: Display the current configuration

$ oc adm config view

Example: Switch to a different context

$ oc adm config use-context test-context

Example: Generate a changelog between two releases and save to changelog.md

$ oc adm release info --changelog=/tmp/git \
    quay.io/openshift-release-dev/ocp-release:4.2.0-rc.7 \
    quay.io/openshift-release-dev/ocp-release:4.2.0 \
    > changelog.md

Example: Verify the nodejs image signature

$ oc adm verify-image-signature \
    sha256:2bba968aedb7dd2aafe5fa8c7453f5ac36a0b9639f1bf5b03f95de325238b288 \
    --expected-identity 172.30.1.1:5000/openshift/nodejs:latest \
    --public-key /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release \
    --save