General Commands
oc | Command line tools for managing applications |
oc-adm | Tools for managing a cluster |
oc-adm-build-chain | Output the inputs and dependencies of your builds |
oc-adm-ca | Manage certificates and keys |
oc-adm-ca-create-key-pair | Create a public/private key pair |
oc-adm-ca-create-master-certs | Create certificates and keys for a master |
oc-adm-ca-create-server-cert | Create a signed server certificate and key |
oc-adm-ca-create-signer-cert | Create a signer (certificate authority/CA) certificate and key |
oc-adm-ca-decrypt | Decrypt data encrypted with "oc adm ca encrypt" |
oc-adm-ca-encrypt | Encrypt data with AES-256-CBC encryption |
oc-adm-certificate | Modify certificate resources. |
oc-adm-certificate-approve | Approve a certificate signing request |
oc-adm-certificate-deny | Deny a certificate signing request |
oc-adm-completion | Output shell completion code for the specified shell (bash or zsh) |
oc-adm-config | Change configuration files for the client |
oc-adm-config-current-context | Displays the current-context |
oc-adm-config-delete-cluster | Delete the specified cluster from the kubeconfig |
oc-adm-config-delete-context | Delete the specified context from the kubeconfig |
oc-adm-config-get-clusters | Display clusters defined in the kubeconfig |
oc-adm-config-get-contexts | Describe one or many contexts |
oc-adm-config-rename-context | Renames a context from the kubeconfig file. |
oc-adm-config-set | Sets an individual value in a kubeconfig file |
oc-adm-config-set-cluster | Sets a cluster entry in kubeconfig |
oc-adm-config-set-context | Sets a context entry in kubeconfig |
oc-adm-config-set-credentials | Sets a user entry in kubeconfig |
oc-adm-config-unset | Unsets an individual value in a kubeconfig file |
oc-adm-config-use-context | Sets the current-context in a kubeconfig file |
oc-adm-config-view | Display merged kubeconfig settings or a specified kubeconfig file |
oc-adm-cordon | Mark node as unschedulable |
oc-adm-create-api-client-config | Create a config file for connecting to the server as a user |
oc-adm-create-bootstrap-policy-file | Create the default bootstrap policy |
oc-adm-create-bootstrap-project-template | Create a bootstrap project template |
oc-adm-create-error-template | Create an error page template |
oc-adm-create-key-pair | |
oc-adm-create-kubeconfig | Create a basic .kubeconfig file from client certs |
oc-adm-create-login-template | Create a login template |
oc-adm-create-master-certs | |
oc-adm-create-node-config | Create a configuration bundle for a node |
oc-adm-create-provider-selection-template | Create a provider selection template |
oc-adm-create-server-cert | |
oc-adm-create-signer-cert | |
oc-adm-diagnostics | Diagnose common cluster problems |
oc-adm-diagnostics-aggregatedlogging | Check aggregated logging integration for proper configuration |
oc-adm-diagnostics-all | Diagnose common cluster problems |
oc-adm-diagnostics-analyzelogs | Check for recent problems in systemd service logs |
oc-adm-diagnostics-appcreate | Create an application and test that it deploys correctly. |
oc-adm-diagnostics-clusterregistry | Check that there is a working Docker registry |
oc-adm-diagnostics-clusterrolebindings | Check that the default ClusterRoleBindings are present and contain the expected subjects |
oc-adm-diagnostics-clusterroles | Check that the default ClusterRoles are present and contain the expected permissions |
oc-adm-diagnostics-clusterrouter | Check there is a working router |
oc-adm-diagnostics-configcontexts | Validate client config context is complete and has connectivity |
oc-adm-diagnostics-diagnosticpod | Create a pod to run diagnostics from the application standpoint |
oc-adm-diagnostics-etcdwritevolume | Check the volume of writes against etcd over a time period and classify them by operation and key |
oc-adm-diagnostics-inpod-networkcheck | Within a privileged pod, run network diagnostics |
oc-adm-diagnostics-inpod-poddiagnostic | Within a pod, run pod diagnostics |
oc-adm-diagnostics-masternode | Check if master is also running node (for Open vSwitch) |
oc-adm-diagnostics-metricsapiproxy | Check the integrated heapster metrics can be reached via the API proxy |
oc-adm-diagnostics-networkcheck | Create a pod on all schedulable nodes and run network diagnostics from the application standpoint |
oc-adm-diagnostics-nodedefinitions | Check node records on master |
oc-adm-diagnostics-routecertificatevalidation | Check all route certificates for certificates that might be rejected by extended validation. |
oc-adm-diagnostics-securitycontextconstraints | Check that the default SecurityContextConstraints are present and contain the expected permissions |
oc-adm-diagnostics-serviceexternalips | Check for existing services with ExternalIPs that are disallowed by master config |
oc-adm-diagnostics-unitstatus | Check status for related systemd units |
oc-adm-drain | Drain node in preparation for maintenance |
oc-adm-groups | Manage groups |
oc-adm-groups-add-users | Add users to a group |
oc-adm-groups-new | Create a new group |
oc-adm-groups-prune | Remove old OpenShift groups referencing missing records on an external provider |
oc-adm-groups-remove-users | Remove users from a group |
oc-adm-groups-sync | Sync OpenShift groups with records from an external provider. |
oc-adm-ipfailover | Install an IP failover group to a set of nodes |
oc-adm-manage-node | Manage nodes — list pods, evacuate, or mark ready |
oc-adm-migrate | Migrate data in the cluster |
oc-adm-migrate-etcd-ttl | Attach keys to etcd v3 leases to assist in etcd v2 migrations |
oc-adm-migrate-image-references | Update embedded Docker image references |
oc-adm-migrate-legacy-hpa | Update HPAs to point to the latest group-version-kinds |
oc-adm-migrate-storage | Update the stored version of API objects |
oc-adm-migrate-template-instances | Update TemplateInstances to point to the latest group-version-kinds |
oc-adm-new-project | Create a new project |
oc-adm-options | |
oc-adm-pod-network | Manage pod network |
oc-adm-pod-network-isolate-projects | Isolate project network |
oc-adm-pod-network-join-projects | Join project network |
oc-adm-pod-network-make-projects-global | Make project network global |
oc-adm-policy | Manage policy |
oc-adm-policy-add-cluster-role-to-group | Add a role to groups for all projects in the cluster |
oc-adm-policy-add-cluster-role-to-user | Add a role to users for all projects in the cluster |
oc-adm-policy-add-role-to-group | Add a role to groups for the current project |
oc-adm-policy-add-role-to-user | Add a role to users or serviceaccounts for the current project |
oc-adm-policy-add-scc-to-group | Add security context constraint to groups |
oc-adm-policy-add-scc-to-user | Add security context constraint to users or a service account |
oc-adm-policy-reconcile-cluster-role-bindings | Update cluster role bindings to match the recommended bootstrap policy |
oc-adm-policy-reconcile-cluster-roles | Update cluster roles to match the recommended bootstrap policy |
oc-adm-policy-reconcile-sccs | Replace cluster SCCs to match the recommended bootstrap policy |
oc-adm-policy-remove-cluster-role-from-group | Remove a role from groups for all projects in the cluster |
oc-adm-policy-remove-cluster-role-from-user | Remove a role from users for all projects in the cluster |
oc-adm-policy-remove-group | Remove group from the current project |
oc-adm-policy-remove-role-from-group | Remove a role from groups for the current project |
oc-adm-policy-remove-role-from-user | Remove a role from users for the current project |
oc-adm-policy-remove-scc-from-group | Remove group from scc |
oc-adm-policy-remove-scc-from-user | Remove user from scc |
oc-adm-policy-remove-user | Remove user from the current project |
oc-adm-policy-scc-review | Checks which ServiceAccount can create a Pod |
oc-adm-policy-scc-subject-review | Check whether a user or a ServiceAccount can create a Pod. |
oc-adm-policy-who-can | List who can perform the specified action on a resource |
oc-adm-prune | Remove older versions of resources from the server |
oc-adm-prune-auth | Removes references to the specified roles, clusterroles, users, and groups. |
oc-adm-prune-builds | Remove old completed and failed builds |
oc-adm-prune-deployments | Remove old completed and failed deployments |
oc-adm-prune-groups | Remove old OpenShift groups referencing missing records on an external provider |
oc-adm-prune-images | Remove unreferenced images |
oc-adm-registry | Install the integrated Docker registry |
oc-adm-release | Tools for managing the OpenShift release process |
oc-adm-release-extract | Extract the contents of an update payload to disk |
oc-adm-release-new | Create a new OpenShift release |
oc-adm-router | Install a router |
oc-adm-taint | Update the taints on one or more nodes |
oc-adm-top | Show usage statistics of resources on the server |
oc-adm-top-images | Show usage statistics for Images |
oc-adm-top-imagestreams | Show usage statistics for ImageStreams |
oc-adm-top-node | Display Resource (CPU/Memory/Storage) usage of nodes |
oc-adm-top-pod | Display Resource (CPU/Memory/Storage) usage of pods |
oc-adm-uncordon | Mark node as schedulable |
oc-adm-verify-image-signature | Verify the image identity contained in the image signature |
oc-annotate | Update the annotations on a resource |
oc-api-resources | Print the supported API resources on the server |
oc-api-versions | Print the supported API versions on the server, in the form of "group/version" |
oc-apply | Apply a configuration to a resource by filename or stdin |
oc-apply-edit-last-applied | Edit latest last-applied-configuration annotations of a resource/object |
oc-apply-set-last-applied | Set the last-applied-configuration annotation on a live object to match the contents of a file. |
oc-apply-view-last-applied | View latest last-applied-configuration annotations of a resource/object |
oc-attach | Attach to a running container |
oc-auth | Inspect authorization |
oc-auth-can-i | Check whether an action is allowed |
oc-auth-reconcile | Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole binding objects |
oc-autoscale | Autoscale a deployment config, deployment, replication controller, or replica set |
oc-build-logs | DEPRECATED: logs |
oc-cancel-build | Cancel running, pending, or new builds |
oc-cluster | Start and stop OpenShift cluster |
oc-cluster-add | Add components to an 'oc cluster up' cluster |
oc-cluster-down | Stop OpenShift on Docker |
oc-cluster-status | Show OpenShift on Docker status |
oc-cluster-up | Start OpenShift on Docker with reasonable defaults |
oc-completion | Output shell completion code for the specified shell (bash or zsh) |
oc-config | Change configuration files for the client |
oc-config-current-context | Displays the current-context |
oc-config-delete-cluster | Delete the specified cluster from the kubeconfig |
oc-config-delete-context | Delete the specified context from the kubeconfig |
oc-config-get-clusters | Display clusters defined in the kubeconfig |
oc-config-get-contexts | Describe one or many contexts |
oc-config-rename-context | Renames a context from the kubeconfig file. |
oc-config-set | Sets an individual value in a kubeconfig file |
oc-config-set-cluster | Sets a cluster entry in kubeconfig |
oc-config-set-context | Sets a context entry in kubeconfig |
oc-config-set-credentials | Sets a user entry in kubeconfig |
oc-config-unset | Unsets an individual value in a kubeconfig file |
oc-config-use-context | Sets the current-context in a kubeconfig file |
oc-config-view | Display merged kubeconfig settings or a specified kubeconfig file |
oc-convert | Convert config files between different API versions |
oc-cp | Copy files and directories to and from containers. |
oc-create | Create a resource from a file or from stdin. |
oc-create-clusterresourcequota | Create cluster resource quota resource. |
oc-create-clusterrole | Create a ClusterRole. |
oc-create-clusterrolebinding | Create a ClusterRoleBinding for a particular ClusterRole |
oc-create-configmap | Create a configmap from a local file, directory or literal value |
oc-create-deployment | Create a deployment with the specified name. |
oc-create-deploymentconfig | Create deployment config with default options that uses a given image. |
oc-create-identity | Manually create an identity (only needed if automatic creation is disabled). |
oc-create-imagestream | Create a new empty image stream. |
oc-create-imagestreamtag | Create a new image stream tag. |
oc-create-job | Create a job with the specified name. |
oc-create-namespace | Create a namespace with the specified name |
oc-create-poddisruptionbudget | Create a pod disruption budget with the specified name. |
oc-create-priorityclass | Create a priorityclass with the specified name. |
oc-create-quota | Create a quota with the specified name. |
oc-create-role | Create a role with single rule. |
oc-create-rolebinding | Create a RoleBinding for a particular Role or ClusterRole |
oc-create-route | Expose containers externally via secured routes |
oc-create-route-edge | Create a route that uses edge TLS termination |
oc-create-route-passthrough | Create a route that uses passthrough TLS termination |
oc-create-route-reencrypt | Create a route that uses reencrypt TLS termination |
oc-create-secret | Create a secret using specified subcommand |
oc-create-secret-docker-registry | Create a secret for use with a Docker registry |
oc-create-secret-generic | Create a secret from a local file, directory or literal value |
oc-create-secret-tls | Create a TLS secret |
oc-create-service | Create a service using specified subcommand. |
oc-create-service-clusterip | Create a ClusterIP service. |
oc-create-service-externalname | Create an ExternalName service. |
oc-create-service-loadbalancer | Create a LoadBalancer service. |
oc-create-service-nodeport | Create a NodePort service. |
oc-create-serviceaccount | Create a service account with the specified name |
oc-create-user | Manually create a user (only needed if automatic creation is disabled). |
oc-create-useridentitymapping | Manually map an identity to a user. |
oc-debug | Launch a new instance of a pod for debugging |
oc-delete | Delete one or more resources |
oc-describe | Show details of a specific resource or group of resources |
oc-edit | Edit a resource on the server |
oc-ex | Experimental commands under active development |
oc-ex-build-chain | Output the inputs and dependencies of your builds |
oc-ex-config | Manage config |
oc-ex-config-patch | Update field(s) of a resource using a patch. |
oc-ex-diagnostics | Diagnose common cluster problems |
oc-ex-diagnostics-aggregatedlogging | Check aggregated logging integration for proper configuration |
oc-ex-diagnostics-all | Diagnose common cluster problems |
oc-ex-diagnostics-analyzelogs | Check for recent problems in systemd service logs |
oc-ex-diagnostics-appcreate | Create an application and test that it deploys correctly. |
oc-ex-diagnostics-clusterregistry | Check that there is a working Docker registry |
oc-ex-diagnostics-clusterrolebindings | Check that the default ClusterRoleBindings are present and contain the expected subjects |
oc-ex-diagnostics-clusterroles | Check that the default ClusterRoles are present and contain the expected permissions |
oc-ex-diagnostics-clusterrouter | Check there is a working router |
oc-ex-diagnostics-configcontexts | Validate client config context is complete and has connectivity |
oc-ex-diagnostics-diagnosticpod | Create a pod to run diagnostics from the application standpoint |
oc-ex-diagnostics-etcdwritevolume | Check the volume of writes against etcd over a time period and classify them by operation and key |
oc-ex-diagnostics-inpod-networkcheck | Within a privileged pod, run network diagnostics |
oc-ex-diagnostics-inpod-poddiagnostic | Within a pod, run pod diagnostics |
oc-ex-diagnostics-masternode | Check if master is also running node (for Open vSwitch) |
oc-ex-diagnostics-metricsapiproxy | Check the integrated heapster metrics can be reached via the API proxy |
oc-ex-diagnostics-networkcheck | Create a pod on all schedulable nodes and run network diagnostics from the application standpoint |
oc-ex-diagnostics-nodedefinitions | Check node records on master |
oc-ex-diagnostics-routecertificatevalidation | Check all route certificates for certificates that might be rejected by extended validation. |
oc-ex-diagnostics-securitycontextconstraints | Check that the default SecurityContextConstraints are present and contain the expected permissions |
oc-ex-diagnostics-serviceexternalips | Check for existing services with ExternalIPs that are disallowed by master config |
oc-ex-diagnostics-unitstatus | Check status for related systemd units |
oc-ex-dockergc | Perform garbage collection to free space in docker storage |
oc-ex-ipfailover | Install an IP failover group to a set of nodes |
oc-ex-options | |
oc-ex-prune-groups | Remove old OpenShift groups referencing missing records on an external provider |
oc-ex-sync-groups | Sync OpenShift groups with records from an external provider. |
oc-exec | Execute a command in a container |
oc-explain | Documentation of resources |
oc-export | Export resources so they can be used elsewhere |
oc-expose | Expose a replicated application as a service or route |
oc-extract | Extract secrets or config maps to disk |
oc-get | Display one or many resources |
oc-idle | Idle scalable resources |
oc-image | Useful commands for managing images |
oc-image-append | Add layers to images and push them to a registry |
oc-image-extract | Copy files from an image to the filesystem |
oc-image-mirror | Mirror images from one repository to another |
oc-import | Commands that import applications |
oc-import-app.json | Import an app.json definition into OpenShift (experimental) |
oc-import-image | Imports images from a Docker registry |
oc-label | Update the labels on a resource |
oc-login | Log in to a server |
oc-logout | End the current server session |
oc-logs | Print the logs for a resource |
oc-new-app | Create a new application |
oc-new-build | Create a new build configuration |
oc-new-project | Request a new project |
oc-observe | Observe changes to resources and react to them (experimental) |
oc-options | |
oc-patch | Update field(s) of a resource using strategic merge patch |
oc-plugin | Runs a command-line plugin |
oc-policy | Manage authorization policy |
oc-policy-add-role-to-group | Add a role to groups for the current project |
oc-policy-add-role-to-user | Add a role to users or serviceaccounts for the current project |
oc-policy-can-i | Check whether an action is allowed |
oc-policy-remove-group | Remove group from the current project |
oc-policy-remove-role-from-group | Remove a role from groups for the current project |
oc-policy-remove-role-from-user | Remove a role from users for the current project |
oc-policy-remove-user | Remove user from the current project |
oc-policy-scc-review | Checks which ServiceAccount can create a Pod |
oc-policy-scc-subject-review | Check whether a user or a ServiceAccount can create a Pod. |
oc-policy-who-can | List who can perform the specified action on a resource |
oc-port-forward | Forward one or more local ports to a pod |
oc-process | Process a template into list of resources |
oc-project | Switch to another project |
oc-projects | Display existing projects |
oc-proxy | Run a proxy to the Kubernetes API server |
oc-registry | Commands for working with the registry |
oc-registry-info | Print info about the integrated registry |
oc-registry-login | Login to the integrated registry |
oc-replace | Replace a resource by filename or stdin |
oc-rollback | Revert part of an application back to a previous deployment |
oc-rollout | Manage a Kubernetes deployment or OpenShift deployment config |
oc-rollout-cancel | cancel the in-progress deployment |
oc-rollout-history | View rollout history |
oc-rollout-latest | Start a new rollout for a deployment config with the latest state from its triggers |
oc-rollout-pause | Mark the provided resource as paused |
oc-rollout-resume | Resume a paused resource |
oc-rollout-retry | Retry the latest failed rollout |
oc-rollout-status | Show the status of the rollout |
oc-rollout-undo | Undo a previous rollout |
oc-rsh | Start a shell session in a pod |
oc-rsync | Copy files between local filesystem and a pod |
oc-run | Run a particular image on the cluster |
oc-scale | Change the number of pods in a deployment |
oc-secrets | Manage secrets |
oc-secrets-add | DEPRECATED: secrets link |
oc-secrets-link | Link secrets to a ServiceAccount |
oc-secrets-new | DEPRECATED: create secret |
oc-secrets-new-basicauth | DEPRECATED: create secret |
oc-secrets-new-dockercfg | DEPRECATED: create secret |
oc-secrets-new-sshauth | DEPRECATED: create secret |
oc-secrets-unlink | Detach secrets from a ServiceAccount |
oc-serviceaccounts | Manage service accounts in your project |
oc-serviceaccounts-create-kubeconfig | Generate a kubeconfig file for a service account |
oc-serviceaccounts-get-token | Get a token assigned to a service account. |
oc-serviceaccounts-new-token | Generate a new token for a service account. |
oc-set | Commands that help set specific features on objects |
oc-set-build-hook | Update a build hook on a build config |
oc-set-build-secret | Update a build secret on a build config |
oc-set-deployment-hook | Update a deployment hook on a deployment config |
oc-set-env | Update environment variables on a pod template |
oc-set-image | Update image of a pod template |
oc-set-image-lookup | Change how images are resolved when deploying applications |
oc-set-probe | Update a probe on a pod template |
oc-set-resources | Update resource requests/limits on objects with pod templates |
oc-set-route-backends | Update the backends for a route |
oc-set-triggers | Update the triggers on one or more objects |
oc-set-volumes | Update volumes on a pod template |
oc-start-build | Start a new build |
oc-status | Show an overview of the current project |
oc-tag | Tag existing images into image streams |
oc-types | An introduction to concepts and types |
oc-version | Display client and server versions |
oc-wait | Experimental: Wait for one condition on one or many resources |
oc-whoami | Return information about the current session |