Merge pull request #46282 from bergerhoffer/OSDOCS-3557

OSDOCS-3557: Generating CLI docs for 4.11

Author: bergerhoffer

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

@@ -553,6 +553,10 @@ Extract the contents of an update payload to disk
   
   # Extract cloud credential requests for AWS
   oc adm release extract --credentials-requests --cloud=aws
+  
+  # Use git to check out the source code for the current cluster release to DIR from linux/s390x image
+  # Note: Wildcard filter is not supported. Pass a single os/arch to extract
+  oc adm release extract --git=DIR quay.io/openshift-release-dev/ocp-release:4.2.2 --filter-by-os=linux/s390x
 ----
 
 
@@ -574,6 +578,10 @@ Display information about a release
   
   # Show where the images referenced by the release are located
   oc adm release info quay.io/openshift-release-dev/ocp-release:4.2.2 --pullspecs
+  
+  # Show information about linux/s390x image
+  # Note: Wildcard filter is not supported. Pass a single os/arch to extract
+  oc adm release info quay.io/openshift-release-dev/ocp-release:4.2.2 --filter-by-os=linux/s390x
 ----
 
 
@@ -727,7 +735,7 @@ Mark node as schedulable
 
 
 == oc adm upgrade
-Upgrade a cluster
+Upgrade a cluster or adjust the upgrade channel
 
 .Example usage
 [source,bash,options="nowrap"]

modules/oc-by-example-content.adoc

@@ -91,6 +91,9 @@ Apply a configuration to a resource by file name or stdin
   # Apply the JSON passed into stdin to a pod
   cat pod.json | oc apply -f -
   
+  # Apply the configuration from all files that end with '.json' - i.e. expand wildcard characters in file names
+  oc apply -f '*.json'
+  
   # Note: --prune is still in Alpha
   # Apply the configuration in manifest.yaml that matches label app=nginx and delete all other resources that are not in the file and match label app=nginx
   oc apply --prune -f manifest.yaml -l app=nginx
@@ -474,11 +477,14 @@ Set a cluster entry in kubeconfig
   # Embed certificate authority data for the e2e cluster entry
   oc config set-cluster e2e --embed-certs --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
   
-  # Disable cert checking for the dev cluster entry
+  # Disable cert checking for the e2e cluster entry
   oc config set-cluster e2e --insecure-skip-tls-verify=true
   
   # Set custom TLS server name to use for validation for the e2e cluster entry
   oc config set-cluster e2e --tls-server-name=my-cluster-name
+  
+  # Set proxy url for the e2e cluster entry
+  oc config set-cluster e2e --proxy-url=https://1.2.3.4
 ----
 
 
@@ -626,8 +632,8 @@ Create a resource from a file or from stdin
   # Create a pod based on the JSON passed into stdin
   cat pod.json | oc create -f -
   
-  # Edit the data in docker-registry.yaml in JSON then create the resource using the edited data
-  oc create -f docker-registry.yaml --edit -o json
+  # Edit the data in registry.yaml in JSON then create the resource using the edited data
+  oc create -f registry.yaml --edit -o json
 ----
 
 
@@ -1124,6 +1130,33 @@ Create a service account with the specified name
 
 
 
+== oc create token
+Request a service account token
+
+.Example usage
+[source,bash,options="nowrap"]
+----
+  # Request a token to authenticate to the kube-apiserver as the service account "myapp" in the current namespace
+  oc create token myapp
+  
+  # Request a token for a service account in a custom namespace
+  oc create token myapp --namespace myns
+  
+  # Request a token with a custom expiration
+  oc create token myapp --duration 10m
+  
+  # Request a token with a custom audience
+  oc create token myapp --audience https://example.com
+  
+  # Request a token bound to an instance of a Secret object
+  oc create token myapp --bound-object-kind Secret --bound-object-name mysecret
+  
+  # Request a token bound to an instance of a Secret object with a specific uid
+  oc create token myapp --bound-object-kind Secret --bound-object-name mysecret --bound-object-uid 0d4691ed-659b-4935-a832-355f77ee47cc
+----
+
+
+
 == oc create user
 Manually create a user (only needed if automatic creation is disabled)
 
@@ -1196,6 +1229,9 @@ Delete resources by file names, stdin, resources and names, or by resources and
   # Delete resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml
   oc delete -k dir
   
+  # Delete resources from all files that end with '.json' - i.e. expand wildcard characters in file names
+  oc apply -f '*.json'
+  
   # Delete a pod based on the type and name in the JSON passed into stdin
   cat pod.json | oc delete -f -
   
@@ -1266,17 +1302,20 @@ Edit a resource on the server
 .Example usage
 [source,bash,options="nowrap"]
 ----
-  # Edit the service named 'docker-registry'
-  oc edit svc/docker-registry
+  # Edit the service named 'registry'
+  oc edit svc/registry
   
   # Use an alternative editor
-  KUBE_EDITOR="nano" oc edit svc/docker-registry
+  KUBE_EDITOR="nano" oc edit svc/registry
   
   # Edit the job 'myjob' in JSON using the v1 API format
   oc edit job.v1.batch/myjob -o json
   
   # Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation
   oc edit deployment/mydeployment -o yaml --save-config
+  
+  # Edit the deployment/mydeployment's status subresource
+  oc edit deployment mydeployment --subresource='status'
 ----
 
 
@@ -1352,13 +1391,6 @@ Expose a replicated application as a service or route
   
   # Expose a service as a route in the specified path
   oc expose service nginx --path=/nginx
-  
-  # Expose a service using different generators
-  oc expose service nginx --name=exposed-svc --port=12201 --protocol="TCP" --generator="service/v2"
-  oc expose service nginx --name=my-route --port=12201 --generator="route/v1"
-  
-  # Exposing a service using the "route/v1" generator (default) will create a new exposed route with the "--name" provided
-  # (or the name of the service otherwise). You may not specify a "--protocol" or "--target-port" option when using this generator
 ----
 
 
@@ -1422,6 +1454,9 @@ Display one or many resources
   
   # List one or more resources by their type and names
   oc get rc/web service/frontend pods/web-pod-13je7
+  
+  # List status subresource for a single pod.
+  oc get pod web-pod-13je7 --subresource status
 ----
 
 
@@ -1867,6 +1902,21 @@ Update fields of a resource
   
   # Update a container's image using a JSON patch with positional arrays
   oc patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+  
+  # Update a deployment's replicas through the scale subresource using a merge patch.
+  oc patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'
+----
+
+
+
+== oc plugin list
+List all visible plugin executables on a user's PATH
+
+.Example usage
+[source,bash,options="nowrap"]
+----
+  # List all available plugins
+  oc plugin list
 ----
 
 
@@ -2065,9 +2115,6 @@ Log in to the integrated registry
   # Log in to the integrated registry
   oc registry login
   
-  # Log in as the default service account in the current namespace
-  oc registry login -z default
-  
   # Log in to different registry using BASIC auth credentials
   oc registry login --registry quay.io/myregistry --auth-basic=USER:PASS
 ----
@@ -2186,6 +2233,9 @@ Restart a resource
   
   # Restart a daemon set
   oc rollout restart daemonset/abc
+  
+  # Restart deployments with the app=nginx label
+  oc rollout restart deployment --selector=app=nginx
 ----
 
 
@@ -2369,46 +2419,6 @@ Detach secrets from a service account
 
 
 
-== oc serviceaccounts create-kubeconfig
-Generate a kubeconfig file for a service account
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Create a kubeconfig file for service account 'default'
-  oc serviceaccounts create-kubeconfig 'default' > default.kubeconfig
-----
-
-
-
-== oc serviceaccounts get-token
-Get a token assigned to a service account
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Get the service account token from service account 'default'
-  oc serviceaccounts get-token 'default'
-----
-
-
-
-== oc serviceaccounts new-token
-Generate a new token for a service account
-
-.Example usage
-[source,bash,options="nowrap"]
-----
-  # Generate a new token for service account 'default'
-  oc serviceaccounts new-token 'default'
-  
-  # Generate a new token for service account 'default' and apply
-  # labels 'foo' and 'bar' to the new token for identification
-  oc serviceaccounts new-token 'default' --labels foo=foo-value,bar=bar-value
-----
-
-
-
 == oc set build-hook
 Update a build hook on a build config
 
@@ -2871,7 +2881,7 @@ Experimental: Wait for a specific condition on one or many resources
   # Wait for the pod "busybox1" to contain the status condition of type "Ready"
   oc wait --for=condition=Ready pod/busybox1
   
-  # The default value of status condition is true; you can set it to false
+  # The default value of status condition is true; you can wait for other targets after an equal delimiter (compared after Unicode simple case folding, which is a more general form of case-insensitivity):
   oc wait --for=condition=Ready=false pod/busybox1
   
   # Wait for the pod "busybox1" to contain the status phase to be "Running".