Merge pull request #90335 from mgencur/short_lines

[OCPBUGS-53162]: Long command-line prompts not visible

Author: lahinson

modules/advanced-node-tuning-hosted-cluster.adoc

@@ -114,7 +114,8 @@ After the nodes are available, the containerized TuneD daemon calculates the req
 +
 [source,terminal]
 ----
-$ oc --kubeconfig="<hosted_cluster_kubeconfig>" get tuned.tuned.openshift.io -n openshift-cluster-node-tuning-operator
+$ oc --kubeconfig="<hosted_cluster_kubeconfig>" get tuned.tuned.openshift.io \
+  -n openshift-cluster-node-tuning-operator
 ----
 +
 .Example output
@@ -130,7 +131,8 @@ rendered             123m
 +
 [source,terminal]
 ----
-$ oc --kubeconfig="<hosted_cluster_kubeconfig>" get profile.tuned.openshift.io -n openshift-cluster-node-tuning-operator
+$ oc --kubeconfig="<hosted_cluster_kubeconfig>" get profile.tuned.openshift.io \
+  -n openshift-cluster-node-tuning-operator
 ----
 +
 .Example output
@@ -149,7 +151,8 @@ Both of the worker nodes in the new `NodePool` have the `openshift-node-hugepage
 +
 [source,terminal]
 ----
-$ oc --kubeconfig="<hosted_cluster_kubeconfig>" debug node/nodepool-1-worker-1 -- chroot /host cat /proc/cmdline
+$ oc --kubeconfig="<hosted_cluster_kubeconfig>" \
+  debug node/nodepool-1-worker-1 -- chroot /host cat /proc/cmdline
 ----
 +
 .Example output

modules/backup-etcd-hosted-cluster.adoc

@@ -19,28 +19,38 @@ This procedure requires API downtime.
 +
 [source,terminal]
 ----
-$ oc patch -n clusters hostedclusters/<hosted_cluster_name> -p '{"spec":{"pausedUntil":"true"}}' --type=merge
+$ oc patch -n clusters hostedclusters/<hosted_cluster_name> \
+  -p '{"spec":{"pausedUntil":"true"}}' --type=merge
 ----
 
 . Stop all etcd-writer deployments by entering the following command:
 +
 [source,terminal]
 ----
-$ oc scale deployment -n <hosted_cluster_namespace> --replicas=0 kube-apiserver openshift-apiserver openshift-oauth-apiserver
+$ oc scale deployment -n <hosted_cluster_namespace> --replicas=0 \
+  kube-apiserver openshift-apiserver openshift-oauth-apiserver
 ----
 
 . To take an etcd snapshot, use the `exec` command in each etcd container by entering the following command:
 +
 [source,terminal]
 ----
-$ oc exec -it <etcd_pod_name> -n <hosted_cluster_namespace> -- env ETCDCTL_API=3 /usr/bin/etcdctl --cacert /etc/etcd/tls/etcd-ca/ca.crt --cert /etc/etcd/tls/client/etcd-client.crt --key /etc/etcd/tls/client/etcd-client.key --endpoints=localhost:2379 snapshot save /var/lib/data/snapshot.db
+$ oc exec -it <etcd_pod_name> -n <hosted_cluster_namespace> -- \
+  env ETCDCTL_API=3 /usr/bin/etcdctl \
+  --cacert /etc/etcd/tls/etcd-ca/ca.crt \
+  --cert /etc/etcd/tls/client/etcd-client.crt \
+  --key /etc/etcd/tls/client/etcd-client.key \
+  --endpoints=localhost:2379 \
+  snapshot save /var/lib/data/snapshot.db
 ----
 
 . To check the snapshot status, use the `exec` command in each etcd container by running the following command:
 +
 [source,terminal]
 ----
-$ oc exec -it <etcd_pod_name> -n <hosted_cluster_namespace> -- env ETCDCTL_API=3 /usr/bin/etcdctl -w table snapshot status /var/lib/data/snapshot.db
+$ oc exec -it <etcd_pod_name> -n <hosted_cluster_namespace> -- \
+  env ETCDCTL_API=3 /usr/bin/etcdctl -w table snapshot status \
+  /var/lib/data/snapshot.db
 ----
 
 . Copy the snapshot data to a location where you can retrieve it later, such as an S3 bucket. See the following example.
@@ -78,15 +88,17 @@ oc exec -it etcd-0 -n ${HOSTED_CLUSTER_NAMESPACE} -- curl -X PUT -T "/var/lib/da
 +
 [source,terminal]
 ----
-$ oc get hostedcluster <hosted_cluster_name> -o=jsonpath='{.spec.secretEncryption.aescbc}'
+$ oc get hostedcluster <hosted_cluster_name> \
+  -o=jsonpath='{.spec.secretEncryption.aescbc}'
 {"activeKey":{"name":"<hosted_cluster_name>-etcd-encryption-key"}}
 ----
 
 .. Save the secret encryption key by entering the following command:
 +
 [source,terminal]
 ----
-$ oc get secret <hosted_cluster_name>-etcd-encryption-key -o=jsonpath='{.data.key}'
+$ oc get secret <hosted_cluster_name>-etcd-encryption-key \
+  -o=jsonpath='{.data.key}'
 ----
 +
 You can decrypt this key when restoring a snapshot on a new cluster.
@@ -95,14 +107,16 @@ You can decrypt this key when restoring a snapshot on a new cluster.
 +
 [source,terminal]
 ----
-$ oc scale deployment -n <control_plane_namespace> --replicas=3 kube-apiserver openshift-apiserver openshift-oauth-apiserver
+$ oc scale deployment -n <control_plane_namespace> --replicas=3 \
+  kube-apiserver openshift-apiserver openshift-oauth-apiserver
 ----
 
 . Resume the reconciliation of the hosted cluster by entering the following command:
 +
 [source,terminal]
 ----
-$ oc patch -n <hosted_cluster_namespace> -p '[\{"op": "remove", "path": "/spec/pausedUntil"}]' --type=json
+$ oc patch -n <hosted_cluster_namespace> \
+  -p '[\{"op": "remove", "path": "/spec/pausedUntil"}]' --type=json
 ----
 
 .Next steps

modules/destroy-hc-ibm-z-cli.adoc

@@ -14,7 +14,8 @@ To destroy a hosted cluster and its managed cluster on `x86` bare metal with {ib
 +
 [source,terminal]
 ----
-$ oc -n <hosted_cluster_namespace> scale nodepool <nodepool_name> --replicas 0
+$ oc -n <hosted_cluster_namespace> scale nodepool <nodepool_name> \
+  --replicas 0
 ----
 +
 After the `NodePool` object is scaled to `0`, the compute nodes are detached from the hosted cluster. In {product-title} version 4.17, this function is applicable only for {ibm-z-title} with KVM. For z/VM and LPAR, you must delete the compute nodes manually.
@@ -26,7 +27,8 @@ If you want to re-attach compute nodes to the cluster, you can scale up the `Nod
 If the compute nodes are not detached from the hosted cluster or are stuck in the `Notready` state, delete the compute nodes manually by running the following command:
 [source,terminal]
 ----
-$ oc --kubeconfig <hosted_cluster_name>.kubeconfig delete node <compute_node_name>
+$ oc --kubeconfig <hosted_cluster_name>.kubeconfig delete \
+  node <compute_node_name>
 ----
 ====
 
@@ -55,5 +57,6 @@ You can delete the virtual machines that you created as agents after you delete
 +
 [source,terminal]
 ----
-$ hcp destroy cluster agent --name <hosted_cluster_name> --namespace <hosted_cluster_namespace>
+$ hcp destroy cluster agent --name <hosted_cluster_name> \
+  --namespace <hosted_cluster_namespace>
 ----

modules/dr-hosted-cluster-within-aws-region-backup.adoc

@@ -14,24 +14,30 @@ To recover your hosted cluster in your target management cluster, you first need
 +
 [source,terminal]
 ----
-$ oc create configmap mgmt-parent-cluster -n default --from-literal=from=${MGMT_CLUSTER_NAME}
+$ oc create configmap mgmt-parent-cluster -n default \
+  --from-literal=from=${MGMT_CLUSTER_NAME}
 ----
 
 . Shut down the reconciliation in the hosted cluster and in the node pools by entering these commands:
 +
 [source,terminal]
 ----
 $ PAUSED_UNTIL="true"
-$ oc patch -n ${HC_CLUSTER_NS} hostedclusters/${HC_CLUSTER_NAME} -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
-$ oc scale deployment -n ${HC_CLUSTER_NS}-${HC_CLUSTER_NAME} --replicas=0 kube-apiserver openshift-apiserver openshift-oauth-apiserver control-plane-operator
+$ oc patch -n ${HC_CLUSTER_NS} hostedclusters/${HC_CLUSTER_NAME} \
+  -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
+$ oc scale deployment -n ${HC_CLUSTER_NS}-${HC_CLUSTER_NAME} --replicas=0 \
+  kube-apiserver openshift-apiserver openshift-oauth-apiserver control-plane-operator
 ----
 +
 [source,terminal]
 ----
 $ PAUSED_UNTIL="true"
-$ oc patch -n ${HC_CLUSTER_NS} hostedclusters/${HC_CLUSTER_NAME} -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
-$ oc patch -n ${HC_CLUSTER_NS} nodepools/${NODEPOOLS} -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
-$ oc scale deployment -n ${HC_CLUSTER_NS}-${HC_CLUSTER_NAME} --replicas=0 kube-apiserver openshift-apiserver openshift-oauth-apiserver control-plane-operator
+$ oc patch -n ${HC_CLUSTER_NS} hostedclusters/${HC_CLUSTER_NAME} \
+  -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
+$ oc patch -n ${HC_CLUSTER_NS} nodepools/${NODEPOOLS} \
+  -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge
+$ oc scale deployment -n ${HC_CLUSTER_NS}-${HC_CLUSTER_NAME} --replicas=0 \
+  kube-apiserver openshift-apiserver openshift-oauth-apiserver control-plane-operator
 ----
 
 . Back up etcd and upload the data to an S3 bucket by running this bash script:
@@ -89,7 +95,8 @@ For more information about backing up etcd, see "Backing up and restoring etcd o
 +
 [source,terminal]
 ----
-$ mkdir -p ${BACKUP_DIR}/namespaces/${HC_CLUSTER_NS} ${BACKUP_DIR}/namespaces/${HC_CLUSTER_NS}-${HC_CLUSTER_NAME}
+$ mkdir -p ${BACKUP_DIR}/namespaces/${HC_CLUSTER_NS} \
+  ${BACKUP_DIR}/namespaces/${HC_CLUSTER_NS}-${HC_CLUSTER_NAME}
 $ chmod 700 ${BACKUP_DIR}/namespaces/
 
 # HostedCluster

modules/hcp-access-hc-aws-hcpcli.adoc

@@ -14,7 +14,8 @@ You can access the hosted cluster by using the `hcp` command-line interface (CLI
 +
 [source,terminal]
 ----
-$ hcp create kubeconfig --namespace <hosted_cluster_namespace> --name <hosted_cluster_name> > <hosted_cluster_name>.kubeconfig
+$ hcp create kubeconfig --namespace <hosted_cluster_namespace> \
+  --name <hosted_cluster_name> > <hosted_cluster_name>.kubeconfig
 ----
 
 . After you save the `kubeconfig` file, you can access the hosted cluster by entering the following command:

modules/hcp-access-priv-mgmt-aws.adoc

@@ -14,7 +14,10 @@ You can access your private management cluster by using the command-line interfa
 +
 [source,terminal]
 ----
-$ aws ec2 describe-instances --filter="Name=tag:kubernetes.io/cluster/<infra_id>,Values=owned" | jq '.Reservations[] | .Instances[] | select(.PublicDnsName=="") | .PrivateIpAddress'
+$ aws ec2 describe-instances \
+  --filter="Name=tag:kubernetes.io/cluster/<infra_id>,Values=owned" \
+  | jq '.Reservations[] | .Instances[] | select(.PublicDnsName=="") \
+  | .PrivateIpAddress'
 ----
 
 . Create a `kubeconfig` file for the hosted cluster that you can copy to a node by entering the following command:
@@ -28,7 +31,8 @@ $ hcp create kubeconfig > <hosted_cluster_kubeconfig>
 +
 [source,terminal]
 ----
-$ ssh -o ProxyCommand="ssh ec2-user@<bastion_ip> -W %h:%p" core@<node_ip>
+$ ssh -o ProxyCommand="ssh ec2-user@<bastion_ip> \
+  -W %h:%p" core@<node_ip>
 ----
 
 . From the SSH shell, copy the `kubeconfig` file contents to a file on the node by entering the following command:

modules/hcp-access-pub-hc-aws-cli.adoc

@@ -14,7 +14,8 @@ You can access the hosted cluster by using the `hcp` command-line interface (CLI
 +
 [source,terminal]
 ----
-$ hcp create kubeconfig --namespace <hosted_cluster_namespace> --name <hosted_cluster_name> > <hosted_cluster_name>.kubeconfig
+$ hcp create kubeconfig --namespace <hosted_cluster_namespace> \
+  --name <hosted_cluster_name> > <hosted_cluster_name>.kubeconfig
 ----
 
 . After you save the `kubeconfig` file, access the hosted cluster by entering the following command:

modules/hcp-aws-create-dns-hosted-zone.adoc

@@ -39,7 +39,9 @@ $ dig +short test.user-dest-public.aws.kerberos.com
 +
 [source,terminal]
 ----
-$ hcp create cluster aws --name=<hosted_cluster_name> --endpoint-access=PublicAndPrivate --external-dns-domain=<public_hosted_zone> ... <1>
+$ hcp create cluster aws --name=<hosted_cluster_name> \
+  --endpoint-access=PublicAndPrivate \
+  --external-dns-domain=<public_hosted_zone> ... <1>
 ----
 +
 <1> Replace `<public_hosted_zone>` with the public hosted zone that you created.

modules/hcp-aws-create-public-zone.adoc

@@ -14,7 +14,9 @@ To access applications in your hosted clusters, you must configure the routable
 +
 [source,terminal]
 ----
-$ aws route53 create-hosted-zone --name <basedomain> --caller-reference $(whoami)-$(date --rfc-3339=date) <1>
+$ aws route53 create-hosted-zone \
+  --name <basedomain> \// <1>
+  --caller-reference $(whoami)-$(date --rfc-3339=date)
 ----
 +
 <1> Replace `<basedomain>` with your base domain, for example, `www.example.com`.

modules/hcp-aws-create-role-sts-creds.adoc

@@ -49,9 +49,9 @@ Use this output as the value for `<arn>` in the next step.
 [source,terminal]
 ----
 $ aws iam create-role \
---role-name <name> \// <1>
---assume-role-policy-document file://<file_name>.json \// <2>
---query "Role.Arn"
+  --role-name <name> \// <1>
+  --assume-role-policy-document file://<file_name>.json \// <2>
+  --query "Role.Arn"
 ----
 <1> Replace `<name>` with the role name, for example, `hcp-cli-role`.
 <2> Replace `<file_name>` with the name of the JSON file you created in the previous step.
@@ -221,11 +221,11 @@ $ aws sts get-session-token --output json > sts-creds.json
 [source,json]
 ----
 {
-              "Credentials": {
-                  "AccessKeyId": "ASIA1443CE0GN2ATHWJU",
-                  "SecretAccessKey": "XFLN7cZ5AP0d66KhyI4gd8Mu0UCQEDN9cfelW1”,
-                  "SessionToken": "IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIDyipkM7oPKBHiGeI0pMnXst1gDLfs/TvfskXseKCbshAiEAnl1l/Html7Iq9AEIqf////KQburfkq4A3TuppHMr/9j1TgCj1z83SO261bHqlJUazKoy7vBFR/a6LHt55iMBqtKPEsIWjBgj/jSdRJI3j4Gyk1//luKDytcfF/tb9YrxDTPLrACS1lqAxSIFZ82I/jDhbDs=",
-                  "Expiration": "2025-05-16T04:19:32+00:00"
-              }
-          }
+    "Credentials": {
+        "AccessKeyId": "ASIA1443CE0GN2ATHWJU",
+        "SecretAccessKey": "XFLN7cZ5AP0d66KhyI4gd8Mu0UCQEDN9cfelW1”,
+        "SessionToken": "IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMiJHMEUCIDyipkM7oPKBHiGeI0pMnXst1gDLfs/TvfskXseKCbshAiEAnl1l/Html7Iq9AEIqf////KQburfkq4A3TuppHMr/9j1TgCj1z83SO261bHqlJUazKoy7vBFR/a6LHt55iMBqtKPEsIWjBgj/jSdRJI3j4Gyk1//luKDytcfF/tb9YrxDTPLrACS1lqAxSIFZ82I/jDhbDs=",
+        "Expiration": "2025-05-16T04:19:32+00:00"
+    }
+}
 ----