OpenShift

2.1. Getting started with the OpenShift CLI2.1.1. About the OpenShift CLI With the OpenShift command-line interface (CLI), the oc command, you can create applications and manage OpenShift Container Platform projects from a terminal. The OpenShift CLI is ideal in the following situations: Working directly with project source code Scripting OpenShift Container Platform operations Managing projects while restricted by bandwidth resources and the web console is unavailable 2.1.2. Installing the OpenShift CLI You can install the OpenShift CLI (oc) either by downloading the binary or by using an RPM. 2.1.2.1. Installing the OpenShift CLI by downloading the binary You can install the OpenShift CLI (oc) to interact with OpenShift Container Platform 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 OpenShift Container Platform 4.7. Download and install the new version of oc. 2.1.2.1.1. Installing the OpenShift CLI on Linux You can install the OpenShift CLI (oc) binary on Linux by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version in the Version drop-down menu. Click Download Now next to the OpenShift v4.7 Linux Client entry and save the file. Unpack the archive: $ tar xvzf Place the oc binary in a directory that is on your PATH. To check your PATH, execute the following command: $ echo $PATH After you install the OpenShift CLI,

It is available using the oc command: $ oc 2.1.2.1.2. Installing the OpenShift CLI on Windows You can install the OpenShift CLI (oc) binary on Windows by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version in the Version drop-down menu. Click Download Now next to the OpenShift v4.7 Windows Client entry and save the file. Unzip the archive with a ZIP program. Move the oc binary to a directory that is on your PATH. To check your PATH, open the command prompt and execute the following command: C:\> path After you install the OpenShift CLI, it is available using the oc command: C:\> oc 2.1.2.1.3. Installing the OpenShift CLI on macOS You can install the OpenShift CLI (oc) binary on macOS by using the following procedure. Procedure Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal. Select the appropriate version in the Version drop-down menu. Click Download Now next to the OpenShift v4.7 MacOSX 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 After you install the OpenShift CLI, it is available using the oc command: $ oc 2.1.2.2. Installing the OpenShift CLI by using the web console You can install the OpenShift CLI (oc) to interact with OpenShift Container Platform 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 OpenShift Container Platform 4.17. Download and install the new version of oc. Installing the OpenShift CLI on Linux You can install the OpenShift CLI (oc) binary on Linux by using the following procedure. 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.17 Linux Clients entry and save the file. Unpack the archive: $ tar xvf Place the oc binary in a directory that is on your PATH. To check your PATH, execute the following command: $ echo $PATHVerification After you install the OpenShift CLI, it is available using the oc command: $ oc Installing the OpenShift CLI on Windows You can install the OpenShift CLI (oc) binary on Windows by using the following procedure. 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.17 Windows Client entry and save the file. Unzip the archive with a ZIP program. Move the oc binary to a directory that is on your PATH. To check your PATH, open the command prompt and execute the following command: C:\> pathVerification After you install the OpenShift CLI, it is available using the oc command: C:\> oc Installing the OpenShift CLI on macOS You can install the OpenShift CLI (oc) binary on macOS by using the following procedure. 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.17 macOS Clients entry and save the file. For macOS arm64, choose the OpenShift v4.17 macOS arm64 Client entry. Unpack and unzip the archive. Move the oc binary to a directory on your PATH.

Cat namespace: openshift-mtvspec: type: 1 url: 2 settings: vddkInitImage: /vddk: 3 secret: name: 4 namespace: openshift-mtvEOF1 Allowed values are ovirt, vsphere, and openstack. 2 Specify the API end point URL, for example, for vSphere, for RHV, or for OpenStack. 3 VMware only: Specify the VDDK image that you created. 4 Specify the name of provider Secret CR. VMware only: Create a Host manifest: $ cat namespace: openshift-mtvspec: provider: namespace: openshift-mtv name: 1 id: 2 ipAddress: 3EOF1 Specify the name of the VMware Provider CR. 2 Specify the managed object reference (MOR) of the VMware host. 3 Specify the IP address of the VMware migration network. Create a NetworkMap manifest to map the source and destination networks: $ cat namespace: openshift-mtvspec: map: - destination: name: namespace: openshift-mtv type: pod 1 source: 2 id: 3 name: - destination: name: 4 namespace: 5 type: multus source: id: name: provider: source: name: namespace: openshift-mtv destination: name: namespace: openshift-mtvEOF1 Allowed values are pod and multus. 2 You can use either the id or the name parameter to specify the source network. 3 Specify the VMware network MOR, the RHV network UUID, or the OpenStack network UUID. 4 Specify a network attachment definition for each additional OpenShift Virtualization network. 5 Specify the namespace of the OpenShift Virtualization network attachment definition. Create a StorageMap manifest to map source and destination storage: $ cat namespace: openshift-mtvspec: map: - destination: storageClass: accessMode: 1 source: id: 2 - destination: storageClass: accessMode: source: id: provider: source: name: namespace: openshift-mtv destination: name:

Output of some standard Ceph commands like Status, Cluster health, and others. Command variations If one or more master nodes are not in the Ready state, use --node-name to provide a master node that is Ready so that the must-gather pod can be safely scheduled. $ oc adm must-gather --image=registry.redhat.io/ocs4/ocs-must-gather-rhel8:v4.7 --dest-dir= --node-name= If you want to gather information from a specific time: To specify a relative time period for logs gathered, such as within 5 seconds or 2 days, add /usr/bin/gather since=: $ oc adm must-gather --image=registry.redhat.io/ocs4/ocs-must-gather-rhel8:v4.7 --dest-dir= /usr/bin/gather since= To specify a specific time to gather logs after, add /usr/bin/gather since-time=: $ oc adm must-gather --image=registry.redhat.io/ocs4/ocs-must-gather-rhel8:v4.7 --dest-dir= /usr/bin/gather since-time= Replace the example values in these commands as follows: If one or more master nodes are not in the Ready state, use this parameter to provide the name of a master node that is still in the Ready state. This avoids scheduling errors by ensuring that the must-gather pod is not scheduled on a master node that is not ready. The directory to store information collected by must-gather. Specify the period of time to collect information from as a relative duration, for example, 5h (starting from 5 hours ago). Specify the period of time to collect information from as an RFC 3339 timestamp, for example, 2020-11-10T04:00:00+00:00 (starting from 4am UTC on 11 Nov 2020). Chapter 3. Commonly required logs for troubleshooting Some of the commonly used logs for troubleshooting OpenShift Container Storage are listed, along with the commands to generate them. Generating logs for a specific pod: $ oc logs -n Generating logs for Ceph or OpenShift Container Storage cluster: $ oc logs rook-ceph-operator- -n openshift-storage Generating logs for plugin pods like cephfs or rbd to detect any problem in the PVC mount of the app-pod: $ oc logs csi-cephfsplugin- -n openshift-storage -c csi-cephfsplugin$ oc logs csi-rbdplugin- -n openshift-storage -c csi-rbdplugin To generate logs for all the containers in the CSI pod: $ oc logs csi-cephfsplugin- -n openshift-storage --all-containers$ oc logs csi-rbdplugin- -n openshift-storage --all-containers Generating logs for cephfs or rbd provisioner pods to detect problems if PVC is not in BOUND state: $ oc logs csi-cephfsplugin-provisioner- -n openshift-storage -c csi-cephfsplugin$ oc logs csi-rbdplugin-provisioner- -n openshift-storage -c csi-rbdplugin To generate logs for all the containers in the CSI pod: $ oc logs csi-cephfsplugin-provisioner- -n openshift-storage --all-containers$ oc logs csi-rbdplugin-provisioner- -n openshift-storage --all-containers Generating OpenShift Container Storage logs using cluster-info command: $ oc cluster-info dump -n openshift-storage --output-directory= Check the OpenShift Container Storage operator logs and events. To check the operator logs : # oc logs -n openshift-storage# oc get pods -n openshift-storage | grep -i "ocs-operator" | awk '{print $1}' To check the operator events : # oc get events --sort-by=metadata.creationTimestamp -n openshift-storage Get the OpenShift Container Storage operator version and channel. # oc get csv -n openshift-storage Example output : NAME DISPLAY VERSION REPLACESPHASEocs-operator.v4.7.2 OpenShift Container Storage 4.7.2Succeeded# oc get subs -n openshift-storage Example output : NAME PACKAGE SOURCECHANNELocs-operator ocs-operator redhat-operatorsstable-4.7 Confirm that the installplan is created. # oc