Red Hat OpenShift Container Platform 4.15

https://docs.redhat.com/en/documentation/openshift_container_platform/4.15
Admin
Red Hat OpenShift Container Platform 4.15 is a comprehensive container application platform that...
Tokens:2,542,809
Snippets:26,626
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Quick Start Introduction Example (Correct)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

State the outcome of the quick start and give action to the user. This example shows the correct way to phrase the introduction.

```text
In this quick start, you will deploy a sample application to {product-title}.
```

--------------------------------

### Install plan status output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/scalability_and_performance/using-node-observability-operator

Example output confirming the installation is complete.

```text
COMPLETE
```

--------------------------------

### Example install plan output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/networking/load-balancing-with-metallb

Sample output displaying manual and automatic install plans.

```text
NAME            CSV                                     APPROVAL    APPROVED
install-shpmd   metallb-operator.v4.15.0-202502261233   Automatic   true
install-tsz2g   metallb-operator.v4.15.0-202503102139   Manual      false
```

--------------------------------

### Quick Start Introduction Example (Incorrect)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Avoid phrasing that focuses on the quick start itself rather than the user's actions. This example shows an incorrect way to phrase the introduction.

```text
This quick start shows you how to deploy a sample application to {product-title}.
```

--------------------------------

### Example Installation Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_an_on-premise_cluster_with_the_agent-based_installer/index

Sample output logs showing the bootstrap and installation completion status.

```text
...................................................................
...................................................................
INFO Bootstrap configMap status is complete
INFO cluster bootstrap is complete
```

```text
...................................................................
...................................................................
INFO Cluster is installed
INFO Install complete!
INFO To access the cluster as the system:admin user when using 'oc', run
INFO     export KUBECONFIG=/home/core/installer/auth/kubeconfig
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.sno-cluster.test.example.com
```

--------------------------------

### Install plan name output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/scalability_and_performance/using-node-observability-operator

Example output of the install plan name.

```text
install-dt54w
```

--------------------------------

### Quick Start Task List Example (Correct)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

List tasks starting with a verb and without specifying the number of tasks. This example shows the correct format for listing tasks.

```text
Tasks to complete: Create a serverless application; Connect an event source; Force a new revision
```

--------------------------------

### Example installation output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_an_on-premise_cluster_with_the_agent-based_installer/installing-with-agent-based-installer

This output indicates a successful cluster installation and provides instructions for accessing the cluster.

```text
...................................................................
...................................................................
INFO Cluster is installed
INFO Install complete!
INFO To access the cluster as the system:admin user when using 'oc', run
INFO     export KUBECONFIG=/home/core/installer/auth/kubeconfig
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.sno-cluster.test.example.com
```

--------------------------------

### Example Operator Installation Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/updating_clusters

Sample output showing a successful Operator installation.

```text
NAME                             DISPLAY                    VERSION   REPLACES   PHASE
update-service-operator.v4.6.0   OpenShift Update Service   4.6.0                Succeeded
...
```

--------------------------------

### Example install-config.yaml Configuration

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_ibm_power_virtual_server/installing-ibm-powervs-vpc

This is an example of an `install-config.yaml` file with the `credentialsMode` parameter set to `Manual`. Ensure this parameter is correctly configured before proceeding with the installation.

```yaml
apiVersion: v1
baseDomain: cluster1.example.com
credentialsMode: Manual
compute:
- architecture: ppc64le
  hyperthreading: Enabled

```

--------------------------------

### Create a Quick Start YAML File

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Use `oc get` to create a YAML file for a new quick start based on an existing one.

```bash
$ oc get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml
```

--------------------------------

### Installation Completion Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_ibm_power/installing-restricted-networks-ibm-power

Example output indicating the cluster initialization process.

```text
INFO Waiting up to 30m0s for the cluster to initialize...
```

--------------------------------

### Example OpenShift Installation Log Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/validation_and_troubleshooting/validating-an-installation

This example shows the successful completion message and cluster access details, including console URL and credentials, found at the end of the installation log.

```log
...\ntime="2020-12-03T09:50:47Z" level=info msg="Install complete!"\ntime="2020-12-03T09:50:47Z" level=info msg="To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'"\ntime="2020-12-03T09:50:47Z" level=info msg="Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com"\ntime="2020-12-03T09:50:47Z" level=info msg="Login to the console with user: \"kubeadmin\", and password: \"password\""\ntime="2020-12-03T09:50:47Z" level=debug msg="Time elapsed per stage:"\ntime="2020-12-03T09:50:47Z" level=debug msg="    Infrastructure: 6m45s"\ntime="2020-12-03T09:50:47Z" level=debug msg="Bootstrap Complete: 11m30s"\ntime="2020-12-03T09:50:47Z" level=debug msg=" Bootstrap Destroy: 1m5s"\ntime="2020-12-03T09:50:47Z" level=debug msg=" Cluster Operators: 17m31s"\ntime="2020-12-03T09:50:47Z" level=info msg="Time elapsed: 37m26s"
```

--------------------------------

### Install mirror registry on local host

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/disconnected_installation_mirroring/installing-mirroring-creating-registry

Use this command to install the mirror registry on your local host. Replace `<host_example_com>` with your desired hostname and `<example_directory_name>` with the name for the example directory.

```bash
./mirror-registry install \
  --quayHostname <host_example_com> \
  --quayRoot <example_directory_name>
```

--------------------------------

### Quick Start Description Element YAML

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Example of the `description` element within a quick start's YAML file.

```yaml
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' 

```

--------------------------------

### Quick Start Card Title Example

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Use a verb to start the title and clearly communicate the user's goal.

```text
Create a serverless application.
```

--------------------------------

### Install Configuration with Additional Trust Bundle

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/security_and_compliance/certificate-types-and-descriptions

Example of an `install-config.yaml` file showing how to specify proxy settings and an `additionalTrustBundle` for custom CA certificates during installation.

```yaml
...
proxy:
  httpProxy: http://<username:password@proxy.example.com:123/>
  httpsProxy: http://<username:password@proxy.example.com:123/>
  noProxy: <123.example.com,10.88.0.0/16>
additionalTrustBundle: |
    -----BEGIN CERTIFICATE-----
   <MY_HTTPS_PROXY_TRUSTED_CA_CERT>
    -----END CERTIFICATE-----
...
```

--------------------------------

### Example version output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/storage/persistent-storage-using-local-storage

Sample output showing the installed operator version.

```text
lvms-operator.v4.15
```

--------------------------------

### Example Output of Operator Installation Verification

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/logging/cluster-logging-deploying

Shows a sample output from the 'oc get csv --all-namespaces' command, indicating the status and version of installed Operators.

```text
NAMESPACE                                          NAME                            DISPLAY                            VERSION          REPLACES                        PHASE
default                                            elasticsearch-operator.v5.8.3   OpenShift Elasticsearch Operator   5.8.3            elasticsearch-operator.v5.8.2   Succeeded
```

--------------------------------

### Example Output of Operator Installation Verification

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/updating_clusters/performing-a-cluster-update

This is an example of the expected output when verifying the OpenShift Update Service Operator installation. The 'PHASE' should be 'Succeeded'.

```text
NAME                             DISPLAY                    VERSION   REPLACES   PHASE
update-service-operator.v4.6.0   OpenShift Update Service   4.6.0                Succeeded
...
```

--------------------------------

### Example PlatformOperator Status Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/operators/administrator-tasks

This is an example of the status output for a successfully installed platform Operator, showing conditions like `InstallSuccessful` and `Installed` status.

```yaml
...
status:
  activeBundleDeployment:
    name: service-mesh-po
  conditions:
  - lastTransitionTime: "2022-10-24T17:24:40Z"
    message: Successfully applied the service-mesh-po BundleDeployment resource
    reason: InstallSuccessful
    status: "True" 
...
type: Installed
...
```

--------------------------------

### View Quick Start API Documentation

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Use `oc explain` to view the API documentation for ConsoleQuickStart resources.

```bash
$ oc explain consolequickstarts
```

--------------------------------

### Limit Access to Quick Start (Operator Installation)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Restricts access to a quick start, requiring users to have 'list' permissions for 'OperatorGroup' and 'PackageManifest' resources, enabling Operator installation.

```yaml
accessReviewResources:
  - group: operators.coreos.com
    resource: operatorgroups
    verb: list
  - group: packages.operators.coreos.com
    resource: packagemanifests
    verb: list

```

--------------------------------

### Example kernel boot parameters output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/scalability_and_performance/using-node-tuning-operator

This is an example of the output you might see when checking the `/proc/cmdline` file on a tuned node. It shows parameters like `hugepagesz` and `hugepages` that indicate successful tuning.

```text
BOOT_IMAGE=(hd0,gpt3)/ostree/rhcos-... hugepagesz=2M hugepages=50
```

--------------------------------

### Example Output for `oc get clusterversion`

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/support/summarizing-cluster-specifications

This is an example of the output you can expect when running the `oc get clusterversion` command, showing the cluster's name, version, availability, and status.

```text
NAME      VERSION   AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.13.8    True        False         8h      Cluster version is 4.13.8
```

--------------------------------

### Configure grub.cfg for CoreOS

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_a_single_node

Example configuration file for /var/lib/tftpboot/boot/grub2/grub.cfg to boot CoreOS via PXE.

```text
default=0
fallback=1
timeout=1
if [ ${net_default_mac} == fa:b0:45:27:43:20 ]; then
menuentry "CoreOS (BIOS)" {
   echo "Loading kernel"
   linux "/rhcos/kernel" ip=dhcp rd.neednet=1 ignition.platform.id=metal ignition.firstboot coreos.live.rootfs_url=http://192.168.10.5:8000/install/rootfs.img ignition.config.url=http://192.168.10.5:8000/ignition/sno.ign
   echo "Loading initrd"
   initrd  "/rhcos/initramfs.img"
}
fi
```

--------------------------------

### Example Output of oc get nodes

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/postinstallation_configuration/post-install-node-tasks

Example output showing the newly created node.

```text
NAME                           STATUS   ROLES    AGE     VERSION
ip-10-0-128-78.ec2.internal    Ready    worker   117m    v1.28.5
ip-10-0-146-113.ec2.internal   Ready    master   127m    v1.28.5
ip-10-0-153-35.ec2.internal    Ready    worker   118m    v1.28.5
ip-10-0-176-58.ec2.internal    Ready    master   126m    v1.28.5
ip-10-0-217-135.ec2.internal   Ready    worker   2m57s   v1.28.5 
ip-10-0-225-248.ec2.internal   Ready    master   127m    v1.28.5
ip-10-0-245-59.ec2.internal    Ready    worker   116m    v1.28.5
```

--------------------------------

### Example Subscription Object with Specific Starting Operator Version

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/postinstallation_configuration/post-install-preparing-for-users

This example demonstrates how to define a Subscription object in OpenShift, specifying the channel, approval strategy, source, and a particular starting CSV version for an Operator.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: example-operator
  namespace: example-operator
spec:
  channel: stable-3.7
  installPlanApproval: Manual 

```

```yaml
  name: example-operator
  source: custom-operators
  sourceNamespace: openshift-marketplace
  startingCSV: example-operator.v3.7.10 

```

--------------------------------

### Example Output of Pod Verification

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/logging/cluster-logging-deploying

This is an example output showing the status of pods in the 'openshift-logging' namespace after installation.

```text
$ oc get pods -n openshift-logging
NAME                                               READY   STATUS    RESTARTS   AGE
cluster-logging-operator-fb7f7cf69-8jsbq           1/1     Running   0          98m
collector-222js                                    2/2     Running   0          18m
collector-g9ddv                                    2/2     Running   0          18m
collector-hfqq8                                    2/2     Running   0          18m
collector-sphwg                                    2/2     Running   0          18m
collector-vv7zn                                    2/2     Running   0          18m
collector-wk5zz                                    2/2     Running   0          18m
logging-view-plugin-6f76fbb78f-n2n4n               1/1     Running   0          18m
lokistack-sample-compactor-0                       1/1     Running   0          42m
lokistack-sample-distributor-7d7688bcb9-dvcj8      1/1     Running   0          42m
lokistack-sample-gateway-5f6c75f879-bl7k9          2/2     Running   0          42m
lokistack-sample-gateway-5f6c75f879-xhq98          2/2     Running   0          42m
lokistack-sample-index-gateway-0                   1/1     Running   0          42m
lokistack-sample-ingester-0                        1/1     Running   0          42m
lokistack-sample-querier-6b7b56bccc-2v9q4          1/1     Running   0          42m
lokistack-sample-query-frontend-84fb57c578-gq2f7   1/1     Running   0          42m
```

--------------------------------

### Create Installation Configuration

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_alibaba/installing-alibaba-customizations

Run this command to create the initial `install-config.yaml` file. Specify the directory where installation files will be stored.

```bash
./openshift-install create install-config --dir <installation_directory>
```

--------------------------------

### Example configuration file

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installation_configuration/index

Content of the simple-kmod.conf file.

```text
KMOD_CONTAINER_BUILD_CONTEXT="https://github.com/kmods-via-containers/kvc-simple-kmod.git"
KMOD_CONTAINER_BUILD_FILE=Dockerfile.rhel
KMOD_SOFTWARE_VERSION=dd1a7d4
KMOD_NAMES="simple-kmod simple-procfs-kmod"
```

--------------------------------

### Sample install-config.yaml configuration

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_any_platform/index

A partial example of the required install-config.yaml file structure for cluster deployment.

```yaml
apiVersion: v1
baseDomain: example.com 

compute: 

- hyperthreading: Enabled 

  name: worker
  replicas: 0 

controlPlane: 
```

--------------------------------

### Example output for getting cert-manager pod

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift

Example output showing the cert-manager controller pod status and age.

```text
NAME                          READY   STATUS    RESTARTS   AGE
cert-manager-bd7fbb9fc-wvbbt  1/1     Running   0          15m39s
```

--------------------------------

### Bootupctl Status Output Examples

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/updating_clusters

Example output for x86_64 and aarch64 architectures.

```text
Component EFI
  Installed: grub2-efi-x64-1:2.04-31.el8_4.1.x86_64,shim-x64-15-8.el8_1.x86_64
  Update: At latest version
```

```text
Component EFI
  Installed: grub2-efi-aa64-1:2.02-99.el8_4.1.aarch64,shim-aa64-15.4-2.el8_1.aarch64
  Update: At latest version
```

--------------------------------

### Create a new project using the CLI

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/building_applications/projects

Use the oc new-project command to initialize a new project with optional display name and description metadata.

```bash
$ oc new-project <project_name> \
    --description="<description>" --display-name="<display_name>"
```

```bash
$ oc new-project hello-openshift \
    --description="This is an example project" \
    --display-name="Hello OpenShift"
```

--------------------------------

### Configure Agent-Based Installation Inputs

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_an_on-premise_cluster_with_the_agent-based_installer/installing-with-agent-based-installer

Example configuration for network interfaces, root device hints, and network settings in YAML format.

```yaml
    interfaces:
      - name: eno1
        macAddress: 00:ef:44:21:e6:a5
    rootDeviceHints: 
      deviceName: /dev/sdb
    networkConfig: 
      interfaces:
        - name: eno1
          type: ethernet
          state: up
          mac-address: 00:ef:44:21:e6:a5
          ipv4:
            enabled: true
            address:
              - ip: 192.168.111.80
                prefix-length: 23
            dhcp: false
      dns-resolver:
        config:
          server:
            - 192.168.111.1
      routes:
        config:
          - destination: 0.0.0.0/0
            next-hop-address: 192.168.111.2
            next-hop-interface: eno1
            table-id: 254
EOF
```

--------------------------------

### Quick Start Conclusion Element YAML

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Example of the `conclusion` element within a quick start's YAML file.

```yaml
...
summary:
  failed: Try the steps again.
  success: Your Spring application is running.
title: Run the Spring application
conclusion: >-
  Your Spring application is deployed and ready. 

```

--------------------------------

### Example Output for MachineConfigPool Status

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/nodes/working-with-nodes

Example output from 'oc get machineconfigpool' showing the status of machine config pools.

```bash
NAME     CONFIG                                   UPDATED   UPDATING

```

--------------------------------

### Create a Quick Start Resource

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Use `oc create` to create a quick start resource in the cluster from a YAML file.

```bash
$ oc create -f my-quick-start.yaml
```

--------------------------------

### Quick Start Duration Minutes Element YAML

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Example of the `durationMinutes` element within a quick start's YAML file.

```yaml
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10 

```

--------------------------------

### Example Output for KubeletConfig Creation

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/nodes/working-with-nodes

Confirms that the KubeletConfig custom resource has been successfully created.

```bash
kubeletconfig.machineconfiguration.openshift.io/gc-container created
```

--------------------------------

### Sample install-config.yaml files for RHOSP

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_openstack

Reference examples for single-stack and dual-stack cluster configurations on OpenStack.

```yaml
apiVersion: v1
baseDomain: example.com
controlPlane:
  name: master
  platform: {}
  replicas: 3
compute:
- name: worker
  platform:
    openstack:
      type: ml.large
  replicas: 3
metadata:
  name: example
networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  machineNetwork:
  - cidr: 10.0.0.0/16
  serviceNetwork:
  - 172.30.0.0/16
  networkType: OVNKubernetes
platform:
  openstack:
    cloud: mycloud
    externalNetwork: external
    computeFlavor: m1.xlarge
    apiFloatingIP: 128.0.0.1
fips: false
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
```

```yaml
apiVersion: v1
baseDomain: example.com
controlPlane:
  name: master
  platform: {}
  replicas: 3
compute:
- name: worker
  platform:
    openstack:
      type: ml.large
  replicas: 3
metadata:
  name: example
networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  - cidr: fd01::/48
    hostPrefix: 64
  machineNetwork:
  - cidr: 192.168.25.0/24
  - cidr: fd2e:6f44:5dd8:c956::/64
  serviceNetwork:
  - 172.30.0.0/16
  - fd02::/112
  networkType: OVNKubernetes
platform:
  openstack:
    cloud: mycloud
    externalNetwork: external
    computeFlavor: m1.xlarge
    apiVIPs:
    - 192.168.25.10
    - fd2e:6f44:5dd8:c956:f816:3eff:fec3:5955
    ingressVIPs:
    - 192.168.25.132
    - fd2e:6f44:5dd8:c956:f816:3eff:fe40:aecb
    controlPlanePort:
      fixedIPs:
      - subnet:
          name: openshift-dual4
      - subnet:
          name: openshift-dual6
      network:
        name: openshift-dual
fips: false
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
```

--------------------------------

### Quick Start Display Name Element YAML

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/web_console/creating-quick-start-tutorials

Example of the `displayName` element within a quick start's YAML file.

```yaml
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring 

```

--------------------------------

### Prepare installation work directory

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_a_single_node/index

Commands to create and navigate to the directory for storing installation configuration files.

```bash
$ mkdir -p ~/sno-work
```

```bash
$ cd ~/sno-work
```

--------------------------------

### Example cert-manager Pod Output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift

This is an example output from the `oc get pods` command, showing the status and age of a cert-manager pod.

```text
NAME                          READY   STATUS    RESTARTS   AGE
cert-manager-bd7fbb9fc-wvbbt  1/1     Running   0          15m39s

```

--------------------------------

### SSH agent output

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_alibaba

Example output after starting the ssh-agent.

```text
Agent pid 31874
```

--------------------------------

### Sample install-config.yaml for Platform-Agnostic Installation

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_any_platform/installing-platform-agnostic

This snippet shows a sample install-config.yaml file. Customize parameters like baseDomain, compute, controlPlane, metadata, networking, platform, fips, pullSecret, and sshKey for your specific installation.

```yaml
apiVersion: v1
baseDomain: example.com

compute:
- hyperthreading: Enabled
  name: worker
  replicas: 0

controlPlane:
  hyperthreading: Enabled
  name: master
  replicas: 3

metadata:
  name: test

networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  networkType: OVNKubernetes
  serviceNetwork:
  - 172.30.0.0/16

platform:
  none: {}

fips: false

pullSecret: '{"auths": ...}'

sshKey: 'ssh-ed25519 AAAA...'
```

--------------------------------

### Preserve Partitions by Label (ISO)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_any_platform/installing-platform-agnostic

Use this command to preserve any partition with a label starting with 'data' during an ISO installation. The installer will maintain these partitions.

```bash
# coreos-installer install --ignition-url http://10.0.2.2:8080/user.ign \
        --save-partlabel 'data*' /dev/disk/by-id/scsi-<serial_number>
```

--------------------------------

### Example node sizing environment variables

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/nodes/working-with-nodes

This is an example output showing the calculated system-reserved memory and CPU allocated to the node.

```bash
SYSTEM_RESERVED_MEMORY=3Gi
SYSTEM_RESERVED_CPU=0.08
```

--------------------------------

### Watch Agent Installation Process

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/edge_computing/ztp-sno-additional-worker-node

Continuously monitor the agent installation process for worker nodes, observing the different stages from starting to completion.

```bash
$ oc get agent -n example-sno --watch
```

--------------------------------

### Example output for image mirroring configuration

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_an_on-premise_cluster_with_the_agent-based_installer/index

Example configuration snippet to be added to install-config.yaml after mirroring images.

```yaml
To use the new mirrored repository to install, add the following
section to the install-config.yaml:

imageContentSources:
```

--------------------------------

### Download and prepare the OpenShift installer

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installing_on_a_single_node

Commands to download the installer binary, extract it, and make it executable.

```bash
$ curl -k https://mirror.openshift.com/pub/openshift-v4/clients/ocp/$OCP_VERSION/openshift-install-linux.tar.gz -o openshift-install-linux.tar.gz
```

```bash
$ tar zxvf openshift-install-linux.tar.gz
```

```bash
$ chmod +x openshift-install
```

--------------------------------

### Example MachineConfigPools Output (Updated)

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/postinstallation_configuration/post-install-node-tasks

Example output of 'oc get machineconfigpools' after a configuration change is complete, showing the 'UPDATED' column as True.

```text
NAME     CONFIG                        UPDATED   UPDATING   DEGRADED
master   master-9cc2c72f205e103bb534   False     True       False
worker   worker-8cecd1236b33ee3f8a5e   True      False      False
```

--------------------------------

### Install KVC framework

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installation_configuration/index

Install the KVC framework instance and reload systemd configuration.

```bash
$ cd kmod-via-containers/
```

```bash
$ sudo make install
```

```bash
$ sudo systemctl daemon-reload
```

--------------------------------

### Example Output of oc get MachineConfig

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/postinstallation_configuration/post-install-machine-configuration-tasks

This is an example output showing the list of MachineConfigs present in the cluster, including the newly added '99-worker-kargs-mpath'.

```text
NAME                                               GENERATEDBYCONTROLLER                      IGNITIONVERSION   AGE
00-master                                          52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
00-worker                                          52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
01-master-container-runtime                        52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
01-master-kubelet                                  52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
01-worker-container-runtime                        52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
01-worker-kubelet                                  52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
99-master-generated-registries                     52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
99-master-ssh                                                                                 3.2.0             40m
99-worker-generated-registries                     52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
99-worker-kargs-mpath                              52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             105s
99-worker-ssh                                                                                 3.2.0             40m
rendered-master-23e785de7587df95a4b517e0647e5ab7   52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
rendered-worker-5d596d9293ca3ea80c896a1191735bb1   52dd3ba6a9a527fc3ab42afac8d12b693534c8c9   3.4.0             33m
```

--------------------------------

### Create installation directory

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/installing_on_ibm_power/installing-restricted-networks-ibm-power

Create a dedicated directory to store installation assets. Do not reuse directories to avoid issues with expiring certificates.

```bash
$ mkdir <installation_directory>
```

--------------------------------

### Install and build kernel module

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html-single/installation_configuration

Install the service instance and build the kernel module.

```bash
$ sudo make install
```

```bash
$ sudo kmods-via-containers build simple-kmod $(uname -r)
```

--------------------------------

### Example Output of Network CR

Source: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/networking/openshift-sdn-network-plugin

This is an example of the output from 'oc get networks.operator.openshift.io -o yaml', showing the applied configuration including kubeProxyConfig settings.

```yaml
apiVersion: v1
items:
- apiVersion: operator.openshift.io/v1
  kind: Network
  metadata:
    name: cluster
  spec:
    clusterNetwork:
    - cidr: 10.128.0.0/14
      hostPrefix: 23
    defaultNetwork:
      type: OpenShiftSDN
    kubeProxyConfig:
      iptablesSyncPeriod: 30s
      proxyArguments:
        iptables-min-sync-period:
        - 30s
    serviceNetwork:
    - 172.30.0.0/16
  status: {}
kind: List
```
Tokens:
Raw