Ce contenu n'est pas disponible dans la langue sélectionnée.
CLI tools
Learning how to use the command-line tools for MicroShift
Abstract
Chapter 1. CLI tools introduction Copier lienLien copié sur presse-papiers!
You can use different command-line interface (CLI) tools to build, deploy, and manage a MicroShift cluster and workloads. With CLI tools, you can complete various administration and development operations from the terminal to manage deployments and interact with each component of the system.
CLI tools available for use with MicroShift are the following:
-
Kubernetes CLI (
kubectl
) -
The OpenShift CLI (
oc
) tool with an enabled subset of commands -
Built-in
microshift
command types
Commands for multi-node deployments, projects, and developer tooling are not supported by Red Hat build of MicroShift.
Chapter 2. Getting started with the OpenShift CLI Copier lienLien copié sur presse-papiers!
To use the OpenShift CLI (oc
) tool, you must download and install it separately from your MicroShift installation. You can install oc
by downloading the binary or by using Homebrew.
2.1. Installing the OpenShift CLI by downloading the binary Copier lienLien copié sur presse-papiers!
You can install the OpenShift CLI (oc
) to interact with Red Hat build of MicroShift from a command-line interface. You can install oc
on Linux, Windows, or macOS.
If you installed an earlier version of oc
, you cannot use it to complete all of the commands in Red Hat build of MicroShift 4.14. Download and install the new version of oc
.
2.1.1. Installing the OpenShift CLI on Linux Copier lienLien copié sur presse-papiers!
You can install the OpenShift CLI (oc
) binary on Linux by using the following procedure.
Red Hat build of MicroShift version numbering matches OpenShift Container Platform version numbering. Use the oc
binary that matches your MicroShift version and has the appropriate RHEL compatibility.
Procedure
- Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
- Select the architecture from the Product Variant drop-down list.
- Select the appropriate version from the Version drop-down list.
- Click Download Now next to the OpenShift v4.14 Linux Client entry and save the file.
Unpack the archive:
tar xvf <file>
$ tar xvf <file>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Place the
oc
binary in a directory that is on yourPATH
.To check your
PATH
, execute the following command:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
After you install the OpenShift CLI, it is available using the
oc
command:oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.2. Installing the OpenShift CLI on Windows Copier lienLien copié sur presse-papiers!
You can install the OpenShift CLI (oc
) binary on Windows by using the following procedure.
Red Hat build of MicroShift version numbering matches OpenShift Container Platform version numbering. Use the oc
binary that matches your MicroShift version and has the appropriate RHEL compatibility.
Procedure
- Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
- Select the appropriate version from the Version drop-down list.
- Click Download Now next to the OpenShift v4.14 Windows Client entry and save the file.
- Unzip the archive with a ZIP program.
Move the
oc
binary to a directory that is on yourPATH
.To check your
PATH
, open the command prompt and execute the following command:path
C:\> path
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
After you install the OpenShift CLI, it is available using the
oc
command:oc <command>
C:\> oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.1.3. Installing the OpenShift CLI on macOS Copier lienLien copié sur presse-papiers!
You can install the OpenShift CLI (oc
) binary on macOS by using the following procedure.
Red Hat build of MicroShift version numbering matches OpenShift Container Platform version numbering. Use the oc
binary that matches your MicroShift version and has the appropriate RHEL compatibility.
Procedure
- Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
- Select the appropriate version from the Version drop-down list.
- Click Download Now next to the OpenShift v4.14 macOS Client entry and save the file.
- Unpack and unzip the archive.
Move the
oc
binary to a directory on your PATH.To check your
PATH
, open a terminal and execute the following command:echo $PATH
$ echo $PATH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Verify your installation by using an
oc
command:oc <command>
$ oc <command>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.2. Installing the OpenShift CLI by using Homebrew Copier lienLien copié sur presse-papiers!
For macOS, you can install the OpenShift CLI (oc
) by using the Homebrew package manager.
Prerequisites
-
You must have Homebrew (
brew
) installed.
Procedure
Install the openshift-cli package by running the following command:
brew install openshift-cli
$ brew install openshift-cli
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
-
Verify your installation by using an
oc
command:
oc <command>
$ oc <command>
2.3. Installing the OpenShift CLI by using an RPM Copier lienLien copié sur presse-papiers!
For Red Hat Enterprise Linux (RHEL), you can install the OpenShift CLI (oc
) as an RPM if you have an active Red Hat build of MicroShift subscription on your Red Hat account.
You must install oc
for RHEL 9 by downloading the binary. Installing oc
by using an RPM package is not supported on Red Hat Enterprise Linux (RHEL) 9.
Prerequisites
- Must have root or sudo privileges.
Procedure
Register with Red Hat Subscription Manager:
subscription-manager register
# subscription-manager register
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Pull the latest subscription data:
subscription-manager refresh
# subscription-manager refresh
Copy to Clipboard Copied! Toggle word wrap Toggle overflow List the available subscriptions:
subscription-manager list --available --matches '*OpenShift*'
# subscription-manager list --available --matches '*OpenShift*'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow In the output for the previous command, find the pool ID for an Red Hat build of MicroShift subscription and attach the subscription to the registered system:
subscription-manager attach --pool=<pool_id>
# subscription-manager attach --pool=<pool_id>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Enable the repositories required by Red Hat build of MicroShift 4.14.
subscription-manager repos --enable="rhocp-4.14-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="rhocp-4.14-for-rhel-8-x86_64-rpms"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Install the
openshift-clients
package:yum install openshift-clients
# yum install openshift-clients
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
-
Verify your installation by using an
oc
command:
oc <command>
$ oc <command>
Chapter 3. Configuring the OpenShift CLI Copier lienLien copié sur presse-papiers!
Configure OpenShift CLI (oc
) based on your preferences for working with it.
3.1. Enabling tab completion Copier lienLien copié sur presse-papiers!
You can enable tab completion for the Bash or Zsh shells.
3.1.1. Enabling tab completion for Bash Copier lienLien copié sur presse-papiers!
After you install the OpenShift CLI (oc
), you can enable tab completion to automatically complete oc
commands or suggest options when you press Tab. The following procedure enables tab completion for the Bash shell.
Prerequisites
-
You must have the OpenShift CLI (
oc
) installed. -
You must have the package
bash-completion
installed.
Procedure
Save the Bash completion code to a file:
oc completion bash > oc_bash_completion
$ oc completion bash > oc_bash_completion
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the file to
/etc/bash_completion.d/
:sudo cp oc_bash_completion /etc/bash_completion.d/
$ sudo cp oc_bash_completion /etc/bash_completion.d/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can also save the file to a local directory and source it from your
.bashrc
file instead.
Tab completion is enabled when you open a new terminal.
3.1.2. Enabling tab completion for Zsh Copier lienLien copié sur presse-papiers!
After you install the OpenShift CLI (oc
), you can enable tab completion to automatically complete oc
commands or suggest options when you press Tab. The following procedure enables tab completion for the Zsh shell.
Prerequisites
-
You must have the OpenShift CLI (
oc
) installed.
Procedure
To add tab completion for
oc
to your.zshrc
file, run the following command:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Tab completion is enabled when you open a new terminal.
Chapter 4. Using the oc tool Copier lienLien copié sur presse-papiers!
The optional OpenShift CLI (oc
) tool provides a subset of oc
commands for MicroShift deployments. Using oc
is convenient if you are familiar with OpenShift Container Platform and Kubernetes.
4.1. About the OpenShift CLI Copier lienLien copié sur presse-papiers!
With the OpenShift command-line interface (CLI), the oc
command, you can deploy and manage MicroShift projects from a terminal. The CLI oc
tool is ideal in the following situations:
- Working directly with project source code
- Scripting Red Hat build of MicroShift operations
- Managing projects while restricted by bandwidth resources
A kubeconfig
file must exist for the cluster to be accessible. The values are applied from built-in default values or a config.yaml
, if one was created.
4.2. Using oc with a MicroShift cluster Copier lienLien copié sur presse-papiers!
Review the following sections to learn how to complete common tasks in MicroShift using the oc
CLI.
4.2.1. Viewing pods Copier lienLien copié sur presse-papiers!
Use the oc get pods
command to view the pods for the current project.
When you run oc
inside a pod and do not specify a namespace, the namespace of the pod is used by default.
oc get pods -o wide
$ oc get pods -o wide
Example output
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE cakephp-ex-1-build 0/1 Completed 0 5m45s 10.131.0.10 ip-10-0-141-74.ec2.internal <none> cakephp-ex-1-deploy 0/1 Completed 0 3m44s 10.129.2.9 ip-10-0-147-65.ec2.internal <none> cakephp-ex-1-ktz97 1/1 Running 0 3m33s 10.128.2.11 ip-10-0-168-105.ec2.internal <none>
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE
cakephp-ex-1-build 0/1 Completed 0 5m45s 10.131.0.10 ip-10-0-141-74.ec2.internal <none>
cakephp-ex-1-deploy 0/1 Completed 0 3m44s 10.129.2.9 ip-10-0-147-65.ec2.internal <none>
cakephp-ex-1-ktz97 1/1 Running 0 3m33s 10.128.2.11 ip-10-0-168-105.ec2.internal <none>
4.2.2. Viewing pod logs Copier lienLien copié sur presse-papiers!
Use the oc logs
command to view logs for a particular pod.
oc logs cakephp-ex-1-deploy
$ oc logs cakephp-ex-1-deploy
Example output
--> Scaling cakephp-ex-1 to 1 --> Success
--> Scaling cakephp-ex-1 to 1
--> Success
4.2.3. Listing supported API resources Copier lienLien copié sur presse-papiers!
Use the oc api-resources
command to view the list of supported API resources on the server.
oc api-resources
$ oc api-resources
Example output
NAME SHORTNAMES APIGROUP NAMESPACED KIND bindings true Binding componentstatuses cs false ComponentStatus configmaps cm true ConfigMap ...
NAME SHORTNAMES APIGROUP NAMESPACED KIND
bindings true Binding
componentstatuses cs false ComponentStatus
configmaps cm true ConfigMap
...
4.3. Getting help Copier lienLien copié sur presse-papiers!
You can get help with CLI commands and MicroShift resources in the following ways.
Use
oc help --flag
to get information about a specific CLI command:Example: Get help for the
oc create
commandoc create --help
$ oc create --help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Use the
oc explain
command to view the description and fields for a particular resource:Example: View documentation for the
Pod
resourceoc explain pods
$ oc explain pods
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
4.4. oc command errors in Red Hat build of MicroShift Copier lienLien copié sur presse-papiers!
Not all OpenShift CLI (oc
) commands are relevant for MicroShift deployments. When you use oc
to make a request call against an unsupported API, the oc
binary usually generates an error message about a resource that cannot be found.
Example output
For example, when the following new-project
command is run:
oc new-project test
$ oc new-project test
The following error message can be generated:
Error from server (NotFound): the server could not find the requested resource (get projectrequests.project.openshift.io)
Error from server (NotFound): the server could not find the requested resource (get projectrequests.project.openshift.io)
And when the get projects
command is run, another error can be generated as follows:
oc get projects
$ oc get projects
error: the server doesn't have a resource type "projects"
Chapter 5. Using oc and kubectl commands Copier lienLien copié sur presse-papiers!
The Kubernetes command-line interface (CLI), kubectl
, can be used to run commands against a Kubernetes cluster. Because MicroShift is a certified Kubernetes distribution, you can use the supported kubectl
CLI tool or you can gain extended functionality by using the OpenShift CLI (oc
).
5.1. The kubectl CLI tool Copier lienLien copié sur presse-papiers!
You can use the kubectl
CLI tool to interact with Kubernetes primitives on your MicroShift cluster. You can also use existing kubectl
workflows and scripts for users coming from another Kubernetes environment, or for those who prefer to use the kubectl
CLI.
-
The
kubectl
CLI tool is included in the archive when you downloadoc
. - For more information, see the Kubernetes CLI tool documentation.
5.2. The oc CLI tool Copier lienLien copié sur presse-papiers!
The oc
CLI tool offers the same capabilities as the kubectl
CLI tool, but it extends to natively support additional OpenShift Container Platform features, including:
Route resource
The
Route
resource object is specific to OpenShift Container Platform distributions, and builds upon standard Kubernetes primitives.Additional commands
The additional command
oc new-app
, for example, makes it easier to get new applications started using existing source code or pre-built images.
If you installed an earlier version of oc
, you might not be able use it to complete all of the commands in MicroShift 4.14. If you want the latest features, you must download and install the latest version of oc
that corresponds with your MicroShift version.
Using new capabilities often requires the latest oc
binary. A 4.17 server might have additional capabilities that a 4.12 oc
binary cannot use and a 4.17 oc
binary might have additional capabilities that are unsupported by a 4.13 server.
X.Y ( |
X.Y+N [a] ( | |
X.Y (Server) | Fully compatible. |
The |
X.Y+N [a] (Server) |
The | Fully compatible. |
[a]
Where N is a number greater than or equal to 1.
|
Chapter 6. OpenShift CLI command reference Copier lienLien copié sur presse-papiers!
Descriptions and example commands for OpenShift CLI (oc
) commands are included in this reference document. You must have cluster-admin
or equivalent permissions to use these commands. To list administrator commands and information about them, use the following commands:
Enter the
oc adm -h
command to list all administrator commands:Command syntax
oc adm -h
$ oc adm -h
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Enter the
oc <command> --help
command to get additional details for a specific command:Command syntax
oc <command> --help
$ oc <command> --help
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Using oc <command> --help
lists details for any oc
command. Not all oc
commands apply to using Red Hat build of MicroShift.
6.1. OpenShift CLI (oc) developer commands Copier lienLien copié sur presse-papiers!
6.1.1. oc annotate Copier lienLien copié sur presse-papiers!
Update the annotations on a resource
Example usage
6.1.2. oc api-resources Copier lienLien copié sur presse-papiers!
Print the supported API resources on the server
Example usage
6.1.3. oc api-versions Copier lienLien copié sur presse-papiers!
Print the supported API versions on the server, in the form of "group/version"
Example usage
Print the supported API versions
# Print the supported API versions
oc api-versions
6.1.4. oc apply Copier lienLien copié sur presse-papiers!
Apply a configuration to a resource by file name or stdin
Example usage
6.1.5. oc apply edit-last-applied Copier lienLien copié sur presse-papiers!
Edit latest last-applied-configuration annotations of a resource/object
Example usage
Edit the last-applied-configuration annotations by type/name in YAML
# Edit the last-applied-configuration annotations by type/name in YAML
oc apply edit-last-applied deployment/nginx
# Edit the last-applied-configuration annotations by file in JSON
oc apply edit-last-applied -f deploy.yaml -o json
6.1.6. oc apply set-last-applied Copier lienLien copié sur presse-papiers!
Set the last-applied-configuration annotation on a live object to match the contents of a file
Example usage
6.1.7. oc apply view-last-applied Copier lienLien copié sur presse-papiers!
View the latest last-applied-configuration annotations of a resource/object
Example usage
View the last-applied-configuration annotations by type/name in YAML
# View the last-applied-configuration annotations by type/name in YAML
oc apply view-last-applied deployment/nginx
# View the last-applied-configuration annotations by file in JSON
oc apply view-last-applied -f deploy.yaml -o json
6.1.8. oc attach Copier lienLien copié sur presse-papiers!
Attach to a running container
Example usage
6.1.9. oc auth can-i Copier lienLien copié sur presse-papiers!
Check whether an action is allowed
Example usage
6.1.10. oc auth reconcile Copier lienLien copié sur presse-papiers!
Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects
Example usage
Reconcile RBAC resources from a file
# Reconcile RBAC resources from a file
oc auth reconcile -f my-rbac-rules.yaml
6.1.11. oc auth whoami Copier lienLien copié sur presse-papiers!
Experimental: Check self subject attributes
Example usage
Get your subject attributes.
# Get your subject attributes.
oc auth whoami
# Get your subject attributes in JSON format.
oc auth whoami -o json
6.1.12. oc cluster-info Copier lienLien copié sur presse-papiers!
Display cluster information
Example usage
Print the address of the control plane and cluster services
# Print the address of the control plane and cluster services
oc cluster-info
6.1.13. oc cluster-info dump Copier lienLien copié sur presse-papiers!
Dump relevant information for debugging and diagnosis
Example usage
6.1.14. oc completion Copier lienLien copié sur presse-papiers!
Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
Example usage
6.1.15. oc config current-context Copier lienLien copié sur presse-papiers!
Display the current-context
Example usage
Display the current-context
# Display the current-context
oc config current-context
6.1.16. oc config delete-cluster Copier lienLien copié sur presse-papiers!
Delete the specified cluster from the kubeconfig
Example usage
Delete the minikube cluster
# Delete the minikube cluster
oc config delete-cluster minikube
6.1.17. oc config delete-context Copier lienLien copié sur presse-papiers!
Delete the specified context from the kubeconfig
Example usage
Delete the context for the minikube cluster
# Delete the context for the minikube cluster
oc config delete-context minikube
6.1.18. oc config delete-user Copier lienLien copié sur presse-papiers!
Delete the specified user from the kubeconfig
Example usage
Delete the minikube user
# Delete the minikube user
oc config delete-user minikube
6.1.19. oc config get-clusters Copier lienLien copié sur presse-papiers!
Display clusters defined in the kubeconfig
Example usage
List the clusters that oc knows about
# List the clusters that oc knows about
oc config get-clusters
6.1.20. oc config get-contexts Copier lienLien copié sur presse-papiers!
Describe one or many contexts
Example usage
List all the contexts in your kubeconfig file
# List all the contexts in your kubeconfig file
oc config get-contexts
# Describe one context in your kubeconfig file
oc config get-contexts my-context
6.1.21. oc config get-users Copier lienLien copié sur presse-papiers!
Display users defined in the kubeconfig
Example usage
List the users that oc knows about
# List the users that oc knows about
oc config get-users
6.1.22. oc config new-admin-kubeconfig Copier lienLien copié sur presse-papiers!
Generate, make the server trust, and display a new admin.kubeconfig.
Example usage
Generate a new admin kubeconfig
# Generate a new admin kubeconfig
oc config new-admin-kubeconfig
6.1.23. oc config new-kubelet-bootstrap-kubeconfig Copier lienLien copié sur presse-papiers!
Generate, make the server trust, and display a new kubelet /etc/kubernetes/kubeconfig.
Example usage
Generate a new kubelet bootstrap kubeconfig
# Generate a new kubelet bootstrap kubeconfig
oc config new-kubelet-bootstrap-kubeconfig
6.1.24. oc config refresh-ca-bundle Copier lienLien copié sur presse-papiers!
Update the OpenShift CA bundle by contacting the apiserver.
Example usage
6.1.25. oc config rename-context Copier lienLien copié sur presse-papiers!
Rename a context from the kubeconfig file
Example usage
Rename the context 'old-name' to 'new-name' in your kubeconfig file
# Rename the context 'old-name' to 'new-name' in your kubeconfig file
oc config rename-context old-name new-name
6.1.26. oc config set Copier lienLien copié sur presse-papiers!
Set an individual value in a kubeconfig file
Example usage
6.1.27. oc config set-cluster Copier lienLien copié sur presse-papiers!
Set a cluster entry in kubeconfig
Example usage
6.1.28. oc config set-context Copier lienLien copié sur presse-papiers!
Set a context entry in kubeconfig
Example usage
Set the user field on the gce context entry without touching other values
# Set the user field on the gce context entry without touching other values
oc config set-context gce --user=cluster-admin
6.1.29. oc config set-credentials Copier lienLien copié sur presse-papiers!
Set a user entry in kubeconfig
Example usage
6.1.30. oc config unset Copier lienLien copié sur presse-papiers!
Unset an individual value in a kubeconfig file
Example usage
Unset the current-context
# Unset the current-context
oc config unset current-context
# Unset namespace in foo context
oc config unset contexts.foo.namespace
6.1.31. oc config use-context Copier lienLien copié sur presse-papiers!
Set the current-context in a kubeconfig file
Example usage
Use the context for the minikube cluster
# Use the context for the minikube cluster
oc config use-context minikube
6.1.32. oc config view Copier lienLien copié sur presse-papiers!
Display merged kubeconfig settings or a specified kubeconfig file
Example usage
6.1.33. oc cp Copier lienLien copié sur presse-papiers!
Copy files and directories to and from containers
Example usage
6.1.34. oc create Copier lienLien copié sur presse-papiers!
Create a resource from a file or from stdin
Example usage
6.1.35. oc create clusterrole Copier lienLien copié sur presse-papiers!
Create a cluster role
Example usage
6.1.36. oc create clusterrolebinding Copier lienLien copié sur presse-papiers!
Create a cluster role binding for a particular cluster role
Example usage
Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
# Create a cluster role binding for user1, user2, and group1 using the cluster-admin cluster role
oc create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
6.1.37. oc create configmap Copier lienLien copié sur presse-papiers!
Create a config map from a local file, directory or literal value
Example usage
6.1.38. oc create cronjob Copier lienLien copié sur presse-papiers!
Create a cron job with the specified name
Example usage
Create a cron job
# Create a cron job
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *"
# Create a cron job with a command
oc create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date
6.1.39. oc create deployment Copier lienLien copié sur presse-papiers!
Create a deployment with the specified name
Example usage
6.1.40. oc create ingress Copier lienLien copié sur presse-papiers!
Create an ingress with the specified name
Example usage
6.1.41. oc create job Copier lienLien copié sur presse-papiers!
Create a job with the specified name
Example usage
6.1.42. oc create namespace Copier lienLien copié sur presse-papiers!
Create a namespace with the specified name
Example usage
Create a new namespace named my-namespace
# Create a new namespace named my-namespace
oc create namespace my-namespace
6.1.43. oc create poddisruptionbudget Copier lienLien copié sur presse-papiers!
Create a pod disruption budget with the specified name
Example usage
6.1.44. oc create priorityclass Copier lienLien copié sur presse-papiers!
Create a priority class with the specified name
Example usage
6.1.45. oc create quota Copier lienLien copié sur presse-papiers!
Create a quota with the specified name
Example usage
Create a new resource quota named my-quota
# Create a new resource quota named my-quota
oc create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
# Create a new resource quota named best-effort
oc create quota best-effort --hard=pods=100 --scopes=BestEffort
6.1.46. oc create role Copier lienLien copié sur presse-papiers!
Create a role with single rule
Example usage
6.1.47. oc create rolebinding Copier lienLien copié sur presse-papiers!
Create a role binding for a particular role or cluster role
Example usage
Create a role binding for user1, user2, and group1 using the admin cluster role
# Create a role binding for user1, user2, and group1 using the admin cluster role
oc create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
# Create a role binding for serviceaccount monitoring:sa-dev using the admin role
oc create rolebinding admin-binding --role=admin --serviceaccount=monitoring:sa-dev
6.1.48. oc create route edge Copier lienLien copié sur presse-papiers!
Create a route that uses edge TLS termination
Example usage
6.1.49. oc create route passthrough Copier lienLien copié sur presse-papiers!
Create a route that uses passthrough TLS termination
Example usage
6.1.50. oc create route reencrypt Copier lienLien copié sur presse-papiers!
Create a route that uses reencrypt TLS termination
Example usage
6.1.51. oc create secret docker-registry Copier lienLien copié sur presse-papiers!
Create a secret for use with a Docker registry
Example usage
If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
oc create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
# Create a new secret named my-secret from ~/.docker/config.json
oc create secret docker-registry my-secret --from-file=.dockerconfigjson=path/to/.docker/config.json
6.1.52. oc create secret generic Copier lienLien copié sur presse-papiers!
Create a secret from a local file, directory, or literal value
Example usage
6.1.53. oc create secret tls Copier lienLien copié sur presse-papiers!
Create a TLS secret
Example usage
Create a new TLS secret named tls-secret with the given key pair
# Create a new TLS secret named tls-secret with the given key pair
oc create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
6.1.54. oc create service clusterip Copier lienLien copié sur presse-papiers!
Create a ClusterIP service
Example usage
Create a new ClusterIP service named my-cs
# Create a new ClusterIP service named my-cs
oc create service clusterip my-cs --tcp=5678:8080
# Create a new ClusterIP service named my-cs (in headless mode)
oc create service clusterip my-cs --clusterip="None"
6.1.55. oc create service externalname Copier lienLien copié sur presse-papiers!
Create an ExternalName service
Example usage
Create a new ExternalName service named my-ns
# Create a new ExternalName service named my-ns
oc create service externalname my-ns --external-name bar.com
6.1.56. oc create service loadbalancer Copier lienLien copié sur presse-papiers!
Create a LoadBalancer service
Example usage
Create a new LoadBalancer service named my-lbs
# Create a new LoadBalancer service named my-lbs
oc create service loadbalancer my-lbs --tcp=5678:8080
6.1.57. oc create service nodeport Copier lienLien copié sur presse-papiers!
Create a NodePort service
Example usage
Create a new NodePort service named my-ns
# Create a new NodePort service named my-ns
oc create service nodeport my-ns --tcp=5678:8080
6.1.58. oc create serviceaccount Copier lienLien copié sur presse-papiers!
Create a service account with the specified name
Example usage
Create a new service account named my-service-account
# Create a new service account named my-service-account
oc create serviceaccount my-service-account
6.1.59. oc create token Copier lienLien copié sur presse-papiers!
Request a service account token
Example usage
6.1.60. oc debug Copier lienLien copié sur presse-papiers!
Launch a new instance of a pod for debugging
Example usage
6.1.61. oc delete Copier lienLien copié sur presse-papiers!
Delete resources by file names, stdin, resources and names, or by resources and label selector
Example usage
6.1.62. oc describe Copier lienLien copié sur presse-papiers!
Show details of a specific resource or group of resources
Example usage
6.1.63. oc diff Copier lienLien copié sur presse-papiers!
Diff the live version against a would-be applied version
Example usage
Diff resources included in pod.json
# Diff resources included in pod.json
oc diff -f pod.json
# Diff file read from stdin
cat service.yaml | oc diff -f -
6.1.64. oc edit Copier lienLien copié sur presse-papiers!
Edit a resource on the server
Example usage
6.1.65. oc events Copier lienLien copié sur presse-papiers!
List events
Example usage
6.1.66. oc exec Copier lienLien copié sur presse-papiers!
Execute a command in a container
Example usage
6.1.67. oc explain Copier lienLien copié sur presse-papiers!
Get documentation for a resource
Example usage
Get the documentation of the resource and its fields
# Get the documentation of the resource and its fields
oc explain pods
# Get the documentation of a specific field of a resource
oc explain pods.spec.containers
6.1.68. oc expose Copier lienLien copié sur presse-papiers!
Expose a replicated application as a service or route
Example usage
6.1.69. oc extract Copier lienLien copié sur presse-papiers!
Extract secrets or config maps to disk
Example usage
6.1.70. oc get Copier lienLien copié sur presse-papiers!
Display one or many resources
Example usage
6.1.71. oc image append Copier lienLien copié sur presse-papiers!
Add layers to images and push them to a registry
Example usage
6.1.72. oc image extract Copier lienLien copié sur presse-papiers!
Copy files from an image to the file system
Example usage
6.1.73. oc image info Copier lienLien copié sur presse-papiers!
Display information about an image
Example usage
6.1.74. oc image mirror Copier lienLien copié sur presse-papiers!
Mirror images from one repository to another
Example usage
6.1.75. oc kustomize Copier lienLien copié sur presse-papiers!
Build a kustomization target from a directory or URL
Example usage
6.1.76. oc label Copier lienLien copié sur presse-papiers!
Update the labels on a resource
Example usage
6.1.77. oc logs Copier lienLien copié sur presse-papiers!
Print the logs for a container in a pod
Example usage
6.1.78. oc observe Copier lienLien copié sur presse-papiers!
Observe changes to resources and react to them (experimental)
Example usage
6.1.79. oc patch Copier lienLien copié sur presse-papiers!
Update fields of a resource
Example usage
6.1.80. oc plugin list Copier lienLien copié sur presse-papiers!
List all visible plugin executables on a user’s PATH
Example usage
List all available plugins
# List all available plugins
oc plugin list
6.1.81. oc policy add-role-to-user Copier lienLien copié sur presse-papiers!
Add a role to users or service accounts for the current project
Example usage
Add the 'view' role to user1 for the current project
# Add the 'view' role to user1 for the current project
oc policy add-role-to-user view user1
# Add the 'edit' role to serviceaccount1 for the current project
oc policy add-role-to-user edit -z serviceaccount1
6.1.82. oc policy scc-review Copier lienLien copié sur presse-papiers!
Check which service account can create a pod
Example usage
6.1.83. oc policy scc-subject-review Copier lienLien copié sur presse-papiers!
Check whether a user or a service account can create a pod
Example usage
6.1.84. oc port-forward Copier lienLien copié sur presse-papiers!
Forward one or more local ports to a pod
Example usage
6.1.85. oc proxy Copier lienLien copié sur presse-papiers!
Run a proxy to the Kubernetes API server
Example usage
6.1.86. oc rollback Copier lienLien copié sur presse-papiers!
Revert part of an application back to a previous deployment
Example usage
6.1.87. oc rollout cancel Copier lienLien copié sur presse-papiers!
Cancel the in-progress deployment
Example usage
Cancel the in-progress deployment based on 'nginx'
# Cancel the in-progress deployment based on 'nginx'
oc rollout cancel dc/nginx
6.1.88. oc rollout history Copier lienLien copié sur presse-papiers!
View rollout history
Example usage
View the rollout history of a deployment
# View the rollout history of a deployment
oc rollout history dc/nginx
# View the details of deployment revision 3
oc rollout history dc/nginx --revision=3
6.1.89. oc rollout latest Copier lienLien copié sur presse-papiers!
Start a new rollout for a deployment config with the latest state from its triggers
Example usage
Start a new rollout based on the latest images defined in the image change triggers
# Start a new rollout based on the latest images defined in the image change triggers
oc rollout latest dc/nginx
# Print the rolled out deployment config
oc rollout latest dc/nginx -o json
6.1.90. oc rollout pause Copier lienLien copié sur presse-papiers!
Mark the provided resource as paused
Example usage
Mark the nginx deployment as paused. Any current state of
# Mark the nginx deployment as paused. Any current state of
# the deployment will continue its function, new updates to the deployment will not
# have an effect as long as the deployment is paused
oc rollout pause dc/nginx
6.1.91. oc rollout restart Copier lienLien copié sur presse-papiers!
Restart a resource
Example usage
6.1.92. oc rollout resume Copier lienLien copié sur presse-papiers!
Resume a paused resource
Example usage
Resume an already paused deployment
# Resume an already paused deployment
oc rollout resume dc/nginx
6.1.93. oc rollout retry Copier lienLien copié sur presse-papiers!
Retry the latest failed rollout
Example usage
Retry the latest failed deployment based on 'frontend'
# Retry the latest failed deployment based on 'frontend'
# The deployer pod and any hook pods are deleted for the latest failed deployment
oc rollout retry dc/frontend
6.1.94. oc rollout status Copier lienLien copié sur presse-papiers!
Show the status of the rollout
Example usage
Watch the status of the latest rollout
# Watch the status of the latest rollout
oc rollout status dc/nginx
6.1.95. oc rollout undo Copier lienLien copié sur presse-papiers!
Undo a previous rollout
Example usage
Roll back to the previous deployment
# Roll back to the previous deployment
oc rollout undo dc/nginx
# Roll back to deployment revision 3. The replication controller for that version must exist
oc rollout undo dc/nginx --to-revision=3
6.1.96. oc rsh Copier lienLien copié sur presse-papiers!
Start a shell session in a container
Example usage
6.1.97. oc rsync Copier lienLien copié sur presse-papiers!
Copy files between a local file system and a pod
Example usage
Synchronize a local directory with a pod directory
# Synchronize a local directory with a pod directory
oc rsync ./local/dir/ POD:/remote/dir
# Synchronize a pod directory with a local directory
oc rsync POD:/remote/dir/ ./local/dir
6.1.98. oc run Copier lienLien copié sur presse-papiers!
Run a particular image on the cluster
Example usage
6.1.99. oc scale Copier lienLien copié sur presse-papiers!
Set a new size for a deployment, replica set, or replication controller
Example usage
6.1.100. oc secrets link Copier lienLien copié sur presse-papiers!
Link secrets to a service account
Example usage
Add an image pull secret to a service account to automatically use it for pulling pod images
# Add an image pull secret to a service account to automatically use it for pulling pod images
oc secrets link 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
oc secrets link builder builder-image-secret --for=pull,mount
6.1.101. oc secrets unlink Copier lienLien copié sur presse-papiers!
Detach secrets from a service account
Example usage
Unlink a secret currently associated with a service account
# Unlink a secret currently associated with a service account
oc secrets unlink serviceaccount-name secret-name another-secret-name ...
6.1.102. oc set data Copier lienLien copié sur presse-papiers!
Update the data within a config map or secret
Example usage
6.1.103. oc set env Copier lienLien copié sur presse-papiers!
Update environment variables on a pod template
Example usage
6.1.104. oc set image Copier lienLien copié sur presse-papiers!
Update the image of a pod template
Example usage
6.1.105. oc set image-lookup Copier lienLien copié sur presse-papiers!
Change how images are resolved when deploying applications
Example usage
6.1.106. oc set probe Copier lienLien copié sur presse-papiers!
Update a probe on a pod template
Example usage
6.1.107. oc set resources Copier lienLien copié sur presse-papiers!
Update resource requests/limits on objects with pod templates
Example usage
6.1.108. oc set route-backends Copier lienLien copié sur presse-papiers!
Update the backends for a route
Example usage
6.1.109. oc set selector Copier lienLien copié sur presse-papiers!
Set the selector on a resource
Example usage
Set the labels and selector before creating a deployment/service pair.
# Set the labels and selector before creating a deployment/service pair.
oc create service clusterip my-svc --clusterip="None" -o yaml --dry-run | oc set selector --local -f - 'environment=qa' -o yaml | oc create -f -
oc create deployment my-dep -o yaml --dry-run | oc label --local -f - environment=qa -o yaml | oc create -f -
6.1.110. oc set serviceaccount Copier lienLien copié sur presse-papiers!
Update the service account of a resource
Example usage
Set deployment nginx-deployment's service account to serviceaccount1
# Set deployment nginx-deployment's service account to serviceaccount1
oc set serviceaccount deployment nginx-deployment serviceaccount1
# Print the result (in YAML format) of updated nginx deployment with service account from a local file, without hitting the API server
oc set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
6.1.111. oc set subject Copier lienLien copié sur presse-papiers!
Update the user, group, or service account in a role binding or cluster role binding
Example usage
6.1.112. oc set volumes Copier lienLien copié sur presse-papiers!
Update volumes on a pod template
Example usage
6.1.113. oc tag Copier lienLien copié sur presse-papiers!
Tag existing images into image streams
Example usage
6.1.114. oc version Copier lienLien copié sur presse-papiers!
Print the client and server version information
Example usage
6.1.115. oc wait Copier lienLien copié sur presse-papiers!
Experimental: Wait for a specific condition on one or many resources
Example usage
6.2. OpenShift CLI (oc) administrator commands Copier lienLien copié sur presse-papiers!
6.2.1. oc adm inspect Copier lienLien copié sur presse-papiers!
Collect debugging data for a given resource
Example usage
6.2.2. oc adm release extract Copier lienLien copié sur presse-papiers!
Extract the contents of an update payload to disk
Example usage
6.2.3. oc adm release info Copier lienLien copié sur presse-papiers!
Display information about a release
Example usage
6.2.4. oc adm taint Copier lienLien copié sur presse-papiers!
Update the taints on nodes
Example usage