OSDOCS#13548: Generating the CLI docs for OCP 4.19

Author: bergerhoffer

modules/oc-adm-by-example-content.adoc

@@ -355,6 +355,9 @@ Create an ISO image for booting the nodes to be added to the target cluster
   # Specify a custom image name
   oc adm node-image create -o=my-node.iso
   
+  # In place of an ISO, creates files that can be used for PXE boot
+  oc adm node-image create --pxe
+  
   # Create an ISO to add a single node without using the configuration file
   oc adm node-image create --mac-address=00:d8:e7:c7:4b:bb
   
@@ -375,7 +378,7 @@ Monitor new nodes being added to an OpenShift cluster
   oc adm node-image monitor --ip-addresses 192.168.111.83
   
   # Monitor multiple nodes being added to a cluster by separating each
-  IP address with a comma
+  # IP address with a comma
   oc adm node-image monitor --ip-addresses 192.168.111.83,192.168.111.84
 ----
 
@@ -480,51 +483,6 @@ Update user-data secrets in an OpenShift cluster to use updated MCO certfs
 
 
 
-== oc adm pod-network isolate-projects
-Isolate project network
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Provide isolation for project p1
-  oc adm pod-network isolate-projects <p1>
-  
-  # Allow all projects with label name=top-secret to have their own isolated project network
-  oc adm pod-network isolate-projects --selector='name=top-secret'
-----
-
-
-
-== oc adm pod-network join-projects
-Join project network
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Allow project p2 to use project p1 network
-  oc adm pod-network join-projects --to=<p1> <p2>
-  
-  # Allow all projects with label name=top-secret to use project p1 network
-  oc adm pod-network join-projects --to=<p1> --selector='name=top-secret'
-----
-
-
-
-== oc adm pod-network make-projects-global
-Make project network global
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Allow project p1 to access all pods in the cluster and vice versa
-  oc adm pod-network make-projects-global <p1>
-  
-  # Allow all projects with label name=share to access all pods in the cluster and vice versa
-  oc adm pod-network make-projects-global --selector='name=share'
-----
-
-
-
 == oc adm policy add-cluster-role-to-group
 Add a role to groups for all projects in the cluster
 
@@ -973,6 +931,24 @@ Display resource (CPU/memory) usage of nodes
 
 
 
+== oc adm top persistentvolumeclaims
+Experimental: Show usage statistics for bound persistentvolumeclaims
+
+.Example usage
+[source,bash,options="nowrap"]
+----
+  # Show usage statistics for all the bound persistentvolumeclaims across the cluster
+  oc adm top persistentvolumeclaims -A
+  
+  # Show usage statistics for all the bound persistentvolumeclaims in a specific namespace
+  oc adm top persistentvolumeclaims -n default
+  
+  # Show usage statistics for specific bound persistentvolumeclaims
+  oc adm top persistentvolumeclaims database-pvc app-pvc -n default
+----
+
+
+
 == oc adm top pod
 Display resource (CPU/memory) usage of pods
 

modules/oc-by-example-content.adoc

@@ -187,9 +187,8 @@ Check whether an action is allowed
   # Check to see if I can list deployments in my current namespace
   oc auth can-i list deployments.apps
   
-  # Check to see if service account "foo" of namespace "dev" can list pods
-  # in the namespace "prod".
-  # You must be allowed to use impersonation for the global option "--as".
+  # Check to see if service account "foo" of namespace "dev" can list pods in the namespace "prod"
+  # You must be allowed to use impersonation for the global option "--as"
   oc auth can-i list pods --as=system:serviceaccount:dev:foo -n prod
   
   # Check to see if I can do everything in my current namespace ("*" means all)
@@ -204,6 +203,9 @@ Check whether an action is allowed
   # Check to see if I can access the URL /logs/
   oc auth can-i get /logs/
   
+  # Check to see if I can approve certificates.k8s.io
+  oc auth can-i approve certificates.k8s.io
+  
   # List all allowed actions in namespace "foo"
   oc auth can-i --list --namespace=foo
 ----
@@ -228,10 +230,10 @@ Experimental: Check self subject attributes
 .Example usage
 [source,bash,options="nowrap"]
 ----
-  # Get your subject attributes.
+  # Get your subject attributes
   oc auth whoami
   
-  # Get your subject attributes in JSON format.
+  # Get your subject attributes in JSON format
   oc auth whoami -o json
 ----
 
@@ -1032,7 +1034,7 @@ Create a role binding for a particular role or 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
+  # Create a role binding for service account monitoring:sa-dev using the admin role
   oc create rolebinding admin-binding --role=admin --serviceaccount=monitoring:sa-dev
 ----
 
@@ -1097,7 +1099,7 @@ Create a secret for use with a Docker registry
   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
+  oc create secret docker-registry my-secret --from-file=path/to/.docker/config.json
 ----
 
 
@@ -1324,6 +1326,9 @@ Delete resources by file names, stdin, resources and names, or by resources and
   
   # Delete all pods
   oc delete pods --all
+  
+  # Delete all pods only if the user confirms the deletion
+  oc delete pods --all --interactive
 ----
 
 
@@ -1565,6 +1570,12 @@ Display one or many resources
   
   # List the 'status' subresource for a single pod
   oc get pod web-pod-13je7 --subresource status
+  
+  # List all deployments in namespace 'backend'
+  oc get deployments.apps --namespace backend
+  
+  # List all pods existing in all namespaces
+  oc get pods --all-namespaces
 ----
 
 
@@ -2060,6 +2071,21 @@ Update fields of a resource
 
 
 
+== oc plugin
+Provides utilities for interacting with plugins
+
+.Example usage
+[source,bash,options="nowrap"]
+----
+  # List all available plugins
+  oc plugin list
+  
+  # List only binary names of available plugins without paths
+  oc plugin list --name-only
+----
+
+
+
 == oc plugin list
 List all visible plugin executables on a user's PATH
 
@@ -2068,6 +2094,9 @@ List all visible plugin executables on a user's PATH
 ----
   # List all available plugins
   oc plugin list
+  
+  # List only binary names of available plugins without paths
+  oc plugin list --name-only
 ----
 
 
@@ -2305,6 +2334,27 @@ Revert part of an application back to a previous deployment
 
 
 
+== oc rollout
+Manage the rollout of a resource
+
+.Example usage
+[source,bash,options="nowrap"]
+----
+  # Roll back to the previous deployment
+  oc rollout undo deployment/abc
+  
+  # Check the rollout status of a daemonset
+  oc rollout status daemonset/foo
+  
+  # Restart a deployment
+  oc rollout restart deployment/abc
+  
+  # Restart deployments with the 'app=nginx' label
+  oc rollout restart deployment --selector=app=nginx
+----
+
+
+
 == oc rollout cancel
 Cancel the in-progress deployment
 
@@ -2324,10 +2374,10 @@ View rollout history
 [source,bash,options="nowrap"]
 ----
   # View the rollout history of a deployment
-  oc rollout history dc/nginx
+  oc rollout history deployment/abc
   
-  # View the details of deployment revision 3
-  oc rollout history dc/nginx --revision=3
+  # View the details of daemonset revision 3
+  oc rollout history daemonset/abc --revision=3
 ----
 
 
@@ -2353,10 +2403,10 @@ Mark the provided resource as paused
 .Example usage
 [source,bash,options="nowrap"]
 ----
-  # 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
+  # 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 deployment/nginx
 ----
 
 
@@ -2367,7 +2417,7 @@ Restart a resource
 .Example usage
 [source,bash,options="nowrap"]
 ----
-  # Restart all deployments in test-namespace namespace
+  # Restart all deployments in the test-namespace namespace
   oc rollout restart deployment -n test-namespace
   
   # Restart a deployment
@@ -2389,7 +2439,7 @@ Resume a paused resource
 [source,bash,options="nowrap"]
 ----
   # Resume an already paused deployment
-  oc rollout resume dc/nginx
+  oc rollout resume deployment/nginx
 ----
 
 
@@ -2413,8 +2463,8 @@ Show the status of the rollout
 .Example usage
 [source,bash,options="nowrap"]
 ----
-  # Watch the status of the latest rollout
-  oc rollout status dc/nginx
+  # Watch the rollout status of a deployment
+  oc rollout status deployment/nginx
 ----
 
 
@@ -2426,10 +2476,13 @@ Undo a previous rollout
 [source,bash,options="nowrap"]
 ----
   # Roll back to the previous deployment
-  oc rollout undo dc/nginx
+  oc rollout undo deployment/abc
   
-  # Roll back to deployment revision 3. The replication controller for that version must exist
-  oc rollout undo dc/nginx --to-revision=3
+  # Roll back to daemonset revision 3
+  oc rollout undo daemonset/abc --to-revision=3
+  
+  # Roll back to the previous deployment with dry-run
+  oc rollout undo --dry-run=server deployment/abc
 ----
 
 
@@ -3035,9 +3088,13 @@ Experimental: Wait for a specific condition on one or many resources
   # Wait for pod "busybox1" to be Ready
   oc wait --for='jsonpath={.status.conditions[?(@.type=="Ready")].status}=True' pod/busybox1
   
-  # Wait for the service "loadbalancer" to have ingress.
+  # Wait for the service "loadbalancer" to have ingress
   oc wait --for=jsonpath='{.status.loadBalancer.ingress}' service/loadbalancer
   
+  # Wait for the secret "busybox1" to be created, with a timeout of 30s
+  oc create secret generic busybox1
+  oc wait --for=create secret/busybox1 --timeout=30s
+  
   # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command
   oc delete pod/busybox1
   oc wait --for=delete pod/busybox1 --timeout=60s