mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
Autogenerate updated CLI docs for 4.9
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
8cebc05491
commit
0567d72509
@@ -54,6 +54,30 @@ Mirror an operator-registry catalog
|
||||
|
||||
|
||||
|
||||
== oc adm certificate approve
|
||||
Approve a certificate signing request
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Approve CSR 'csr-sqgzp'
|
||||
kubectl certificate approve csr-sqgzp
|
||||
----
|
||||
|
||||
|
||||
|
||||
== oc adm certificate deny
|
||||
Deny a certificate signing request
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Deny CSR 'csr-sqgzp'
|
||||
kubectl certificate deny csr-sqgzp
|
||||
----
|
||||
|
||||
|
||||
|
||||
== oc adm completion
|
||||
Output shell completion code for the specified shell (bash or zsh)
|
||||
|
||||
@@ -65,13 +89,13 @@ Output shell completion code for the specified shell (bash or zsh)
|
||||
brew install bash-completion
|
||||
## or, if running Bash 4.1+
|
||||
brew install bash-completion@2
|
||||
## If oc is installed via homebrew, this should start working immediately.
|
||||
## If oc is installed via homebrew, this should start working immediately
|
||||
## If you've installed via other means, you may need add the completion to your completion directory
|
||||
oc completion bash > $(brew --prefix)/etc/bash_completion.d/oc
|
||||
|
||||
|
||||
# Installing bash completion on Linux
|
||||
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
|
||||
## If bash-completion is not installed on Linux, install the 'bash-completion' package
|
||||
## via your distribution's package manager.
|
||||
## Load the oc completion code for bash into the current shell
|
||||
source <(oc completion bash)
|
||||
@@ -92,7 +116,7 @@ Output shell completion code for the specified shell (bash or zsh)
|
||||
|
||||
|
||||
== oc adm config current-context
|
||||
Displays the current-context
|
||||
Display the current-context
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -145,7 +169,7 @@ Display clusters defined in the kubeconfig
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# List the clusters oc knows about
|
||||
# List the clusters that oc knows about
|
||||
oc config get-clusters
|
||||
----
|
||||
|
||||
@@ -160,7 +184,7 @@ Describe one or many contexts
|
||||
# List all the contexts in your kubeconfig file
|
||||
oc config get-contexts
|
||||
|
||||
# Describe one context in your kubeconfig file.
|
||||
# Describe one context in your kubeconfig file
|
||||
oc config get-contexts my-context
|
||||
----
|
||||
|
||||
@@ -172,14 +196,14 @@ Display users defined in the kubeconfig
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# List the users oc knows about
|
||||
# List the users that oc knows about
|
||||
oc config get-users
|
||||
----
|
||||
|
||||
|
||||
|
||||
== oc adm config rename-context
|
||||
Renames a context from the kubeconfig file.
|
||||
Rename a context from the kubeconfig file
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -191,33 +215,33 @@ Renames a context from the kubeconfig file.
|
||||
|
||||
|
||||
== oc adm config set
|
||||
Sets an individual value in a kubeconfig file
|
||||
Set an individual value in a kubeconfig file
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Set server field on the my-cluster cluster to https://1.2.3.4
|
||||
# Set the server field on the my-cluster cluster to https://1.2.3.4
|
||||
oc config set clusters.my-cluster.server https://1.2.3.4
|
||||
|
||||
# Set certificate-authority-data field on the my-cluster cluster.
|
||||
# Set the certificate-authority-data field on the my-cluster cluster
|
||||
oc config set clusters.my-cluster.certificate-authority-data $(echo "cert_data_here" | base64 -i -)
|
||||
|
||||
# Set cluster field in the my-context context to my-cluster.
|
||||
# Set the cluster field in the my-context context to my-cluster
|
||||
oc config set contexts.my-context.cluster my-cluster
|
||||
|
||||
# Set client-key-data field in the cluster-admin user using --set-raw-bytes option.
|
||||
# Set the client-key-data field in the cluster-admin user using --set-raw-bytes option
|
||||
oc config set users.cluster-admin.client-key-data cert_data_here --set-raw-bytes=true
|
||||
----
|
||||
|
||||
|
||||
|
||||
== oc adm config set-cluster
|
||||
Sets a cluster entry in kubeconfig
|
||||
Set a cluster entry in kubeconfig
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Set only the server field on the e2e cluster entry without touching other values.
|
||||
# Set only the server field on the e2e cluster entry without touching other values
|
||||
oc config set-cluster e2e --server=https://1.2.3.4
|
||||
|
||||
# Embed certificate authority data for the e2e cluster entry
|
||||
@@ -233,7 +257,7 @@ Sets a cluster entry in kubeconfig
|
||||
|
||||
|
||||
== oc adm config set-context
|
||||
Sets a context entry in kubeconfig
|
||||
Set a context entry in kubeconfig
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -245,13 +269,13 @@ Sets a context entry in kubeconfig
|
||||
|
||||
|
||||
== oc adm config set-credentials
|
||||
Sets a user entry in kubeconfig
|
||||
Set a user entry in kubeconfig
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Set only the "client-key" field on the "cluster-admin"
|
||||
# entry, without touching other values:
|
||||
# entry, without touching other values
|
||||
oc config set-credentials cluster-admin --client-key=~/.kube/admin.key
|
||||
|
||||
# Set basic auth for the "cluster-admin" entry
|
||||
@@ -285,22 +309,22 @@ Sets a user entry in kubeconfig
|
||||
|
||||
|
||||
== oc adm config unset
|
||||
Unsets an individual value in a kubeconfig file
|
||||
Unset an individual value in a kubeconfig file
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Unset the current-context.
|
||||
# Unset the current-context
|
||||
oc config unset current-context
|
||||
|
||||
# Unset namespace in foo context.
|
||||
# Unset namespace in foo context
|
||||
oc config unset contexts.foo.namespace
|
||||
----
|
||||
|
||||
|
||||
|
||||
== oc adm config use-context
|
||||
Sets the current-context in a kubeconfig file
|
||||
Set the current-context in a kubeconfig file
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -317,10 +341,10 @@ Display merged kubeconfig settings or a specified kubeconfig file
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Show merged kubeconfig settings.
|
||||
# Show merged kubeconfig settings
|
||||
oc config view
|
||||
|
||||
# Show merged kubeconfig settings and raw certificate data.
|
||||
# Show merged kubeconfig settings and raw certificate data
|
||||
oc config view --raw
|
||||
|
||||
# Get the password for the e2e user
|
||||
@@ -335,7 +359,7 @@ Mark node as unschedulable
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Mark node "foo" as unschedulable.
|
||||
# Mark node "foo" as unschedulable
|
||||
oc adm cordon foo
|
||||
----
|
||||
|
||||
@@ -395,11 +419,11 @@ Drain node in preparation for maintenance
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
|
||||
$ oc adm drain foo --force
|
||||
# Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set on it
|
||||
oc adm drain foo --force
|
||||
|
||||
# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.
|
||||
$ oc adm drain foo --grace-period=900
|
||||
# As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set or stateful set, and use a grace period of 15 minutes
|
||||
oc adm drain foo --grace-period=900
|
||||
----
|
||||
|
||||
|
||||
@@ -782,7 +806,7 @@ Remove unreferenced images
|
||||
|
||||
# To actually perform the prune operation, the confirm flag must be appended
|
||||
oc adm prune images --prune-over-size-limit --confirm
|
||||
|
||||
|
||||
# Force the insecure http protocol with the particular registry host name
|
||||
oc adm prune images --registry-url=http://registry.example.org --confirm
|
||||
|
||||
@@ -885,11 +909,11 @@ Update the taints on one or more nodes
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'.
|
||||
# If a taint with that key and effect already exists, its value is replaced as specified.
|
||||
# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'
|
||||
# If a taint with that key and effect already exists, its value is replaced as specified
|
||||
oc adm taint nodes foo dedicated=special-user:NoSchedule
|
||||
|
||||
# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.
|
||||
# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists
|
||||
oc adm taint nodes foo dedicated:NoSchedule-
|
||||
|
||||
# Remove from node 'foo' all the taints with key 'dedicated'
|
||||
@@ -929,7 +953,7 @@ Show usage statistics for image streams
|
||||
|
||||
|
||||
== oc adm top node
|
||||
Display Resource (CPU/Memory) usage of nodes
|
||||
Display resource (CPU/memory) usage of nodes
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -944,7 +968,7 @@ Display Resource (CPU/Memory) usage of nodes
|
||||
|
||||
|
||||
== oc adm top pod
|
||||
Display Resource (CPU/Memory) usage of pods
|
||||
Display resource (CPU/memory) usage of pods
|
||||
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
@@ -970,8 +994,8 @@ Mark node as schedulable
|
||||
.Example usage
|
||||
[source,bash,options="nowrap"]
|
||||
----
|
||||
# Mark node "foo" as schedulable.
|
||||
$ oc adm uncordon foo
|
||||
# Mark node "foo" as schedulable
|
||||
oc adm uncordon foo
|
||||
----
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user