OKD

https://docs.okd.io/latest/
Admin
OKD is the community distribution of Kubernetes that powers OpenShift, providing an open-source...
Tokens:8,331,939
Snippets:58,356
Trust Score:9.9
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install command example

Source: https://docs.okd.io/latest/installing/installing_bare_metal/upi/installing-bare-metal.html

Example command for installing with ignition.

```bash
coreos-installer install --ignition-url http://10.0.2.2:8080/user.ign \


```

```text
system:admin
```

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

### Example installation output

Source: https://docs.okd.io/latest/edge_computing/ztp-sno-additional-worker-node.html

This output shows the progression of the worker node installation stages from starting to completion.

```text
NAME                                   CLUSTER   APPROVED   ROLE     STAGE
671bc05d-5358-8940-ec12-d9ad22804faa   example-sno   true       master   Done
[...]
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Starting installation
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Installing
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Writing image to disk
[...]
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Waiting for control plane
[...]
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Rebooting
14fd821b-a35d-9cba-7978-00ddf535ff37   example-sno   true       worker   Done
```

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

### Example image-based-installation-config.yaml file

Source: https://docs.okd.io/latest/edge_computing/image_base_install/ibi-factory-image-based-install.html

A configured example of the installation configuration file.

```yaml
apiVersion: v1beta1
kind: ImageBasedInstallationConfig
metadata:
  name: example-image-based-installation-config
seedImage: quay.io/repo-id/seed:latest
seedVersion: "4.22.0"
extraPartitionStart: "-240G"
installationDisk: /dev/disk/by-id/wwn-0x62c...
sshKey: 'ssh-ed25519 AAAA...'
pullSecret: '{"auths": ...}'
networkConfig:
    interfaces:
      - name: ens1f0
        type: ethernet
        state: up
        ipv4:
          enabled: true
          dhcp: false
          auto-dns: false
          address:
            - ip: 192.168.200.25
              prefix-length: 24
        ipv6:
          enabled: false
    dns-resolver:
      config:
        server:
          - 192.168.15.47
          - 192.168.15.48
    routes:
      config:
      - destination: 0.0.0.0/0
        metric: 150
        next-hop-address: 192.168.200.254
        next-hop-interface: ens1f0
```

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

### Example coreos-installer command for bootstrap node

Source: https://docs.okd.io/latest/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.html

A concrete example of initializing a bootstrap node installation to /dev/sda.

```bash
$ sudo coreos-installer install --ignition-url=http://192.168.1.2:80/installation_directory/bootstrap.ign /dev/sda \
--ignition-hash=sha512-a5a2d43879223273c9b60af66b44202a1d1248fc01cf156c46d4a79f552b6bad47bc8cc78ddf0116e80c59d2ea9e32ba53bc807afbca581aa059311def2c3e3b
```

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

### Install with coreos-installer

Source: https://docs.okd.io/latest/installing/installing_bare_metal/upi/installing-bare-metal.html

Example command to install using an Ignition URL and output a custom initramfs image.

```bash
coreos-installer install --ignition-url http://10.0.2.2:8080/user.ign \

    -o rhcos-<version>-custom-initramfs.x86_64.img
```

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

### Example FCOS installation command

Source: https://docs.okd.io/latest/machine_management/user_infra/adding-bare-metal-compute-user-infra.html

A concrete example of installing FCOS to /dev/sda using a specific Ignition file URL and SHA512 digest.

```bash
$ sudo coreos-installer install --ignition-url=http://192.168.1.2:80/installation_directory/worker.ign /dev/sda --ignition-hash=sha512-a5a2d43879223273c9b60af66b44202a1d1248fc01cf156c46d4a79f552b6bad47bc8cc78ddf0116e80c59d2ea9e32ba53bc807afbca581aa059311def2c3e3b
```

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

### InstallPlan object example

Source: https://docs.okd.io/latest/operators/understanding/olm/olm-understanding-olm.html

An example of an InstallPlan resource defining the installation of a specific Operator version.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: InstallPlan
metadata:
  name: install-abcde
  namespace: operators
spec:
  approval: Automatic
  approved: true
  clusterServiceVersionNames:
    - my-operator.v1.0.1
  generation: 1
status:
  ...
  catalogSources: []
  conditions:
    - lastTransitionTime: '2021-01-01T20:17:27Z'
      lastUpdateTime: '2021-01-01T20:17:27Z'
      status: 'True'
      type: Installed
  phase: Complete
  plan:
    - resolving: my-operator.v1.0.1
      resource:
        group: operators.coreos.com
        kind: ClusterServiceVersion
        manifest: >-
        ...
        name: my-operator.v1.0.1
        sourceName: redhat-operators
        sourceNamespace: openshift-marketplace
        version: v1alpha1
      status: Created
    - resolving: my-operator.v1.0.1
      resource:
        group: apiextensions.k8s.io
        kind: CustomResourceDefinition
        manifest: >-
        ...
        name: webservers.web.servers.org
        sourceName: redhat-operators
        sourceNamespace: openshift-marketplace
        version: v1beta1
      status: Created
    - resolving: my-operator.v1.0.1
      resource:
        group: ''
        kind: ServiceAccount
        manifest: >-
        ...
        name: my-operator
        sourceName: redhat-operators
        sourceNamespace: openshift-marketplace
        version: v1
      status: Created
    - resolving: my-operator.v1.0.1
      resource:
        group: rbac.authorization.k8s.io
        kind: Role
        manifest: >-
        ...
        name: my-operator.v1.0.1-my-operator-6d7cbc6f57
        sourceName: redhat-operators
        sourceNamespace: openshift-marketplace
        version: v1
      status: Created
    - resolving: my-operator.v1.0.1
      resource:
        group: rbac.authorization.k8s.io
        kind: RoleBinding
        manifest: >-
        ...
        name: my-operator.v1.0.1-my-operator-6d7cbc6f57
        sourceName: redhat-operators
        sourceNamespace: openshift-marketplace
        version: v1
      status: Created
      ...
```

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

### Example installation configuration with proxy settings

Source: https://docs.okd.io/latest/security/certificate_types_descriptions/proxy-certificates.html

Example of the install-config.yaml file showing the proxy configuration and the additionalTrustBundle field.

```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 output for bootupctl status on x86_64

Source: https://docs.okd.io/latest/updating/updating_a_cluster/updating-bootloader-rhcos.html

Example output showing the installed versions and update status for EFI components.

```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
```

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

### View installation output for kubeadmin credentials

Source: https://docs.okd.io/latest/authentication/remove-kubeadmin.html

Example output from the installation program showing the kubeadmin login credentials.

```text
INFO Install complete!
INFO Run 'export KUBECONFIG=<your working directory>/auth/kubeconfig' to manage the cluster with 'oc', the OpenShift CLI.
INFO The cluster is ready when 'oc login -u kubeadmin -p <provided>' succeeds (wait a few minutes).
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.demo1.openshift4-beta-abcorp.com
INFO Login to the console with user: kubeadmin, password: <provided>
```

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

### Create install.ks kickstart file

Source: https://docs.okd.io/latest/virt/creating_vm/virt-configuring-ibm-secure-execution-vms-ibm-z.html

Create the kickstart file in /var/lib/libvirt/image/ to define partitioning and encryption settings.

```text
[trusted instance ~]
text
lang en_US.UTF-8
keyboard us
network --bootproto=dhcp
rootpw --plaintext <password>
timezone <>
firewall --enabled
selinux --enforcing
bootloader --location=mbr
reboot

# Wipe and partition the disk
clearpart --all --initlabel
zerombr

# /boot gets encrypted on post reboot
part /boot --fstype ext4 --size=512 --label=boot
# Root (/) is LUKS-encrypted
part / --fstype xfs --size=3000 --pbkdf=pbkdf2 --encrypted --passphrase <passphrase>
# SE (/se) Non Encrypted for encrypted boot image.
part /se --fstype xfs --size=512 --label=se
#Packages
%packages
@core
dracut
s390-tools
%end
```

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

### Example output for oc get csv -A

Source: https://docs.okd.io/latest/post_installation_configuration/day_2_core_cnf_clusters/updating/update-rhacm-talm-operator-coordination.html

This output displays the namespace, name, version, and phase of installed Operators.

```text
NAMESPACE                              NAME                                          VERSION   PHASE
openshift-sriov-network-operator       sriov-network-operator.v4.20.0                4.20.0    Succeeded
openshift-ptp                          ptp-operator.v4.20.0                          4.20.0    Succeeded
openshift-cluster-node-tuning-operator node-tuning-operator.v4.20.0                  4.20.0    Succeeded
```

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

### Example output for oc get nodes

Source: https://docs.okd.io/latest/installing/installing_sno/install-sno-installing-sno.html

The expected output after a successful installation, showing the control-plane node status as Ready.

```text
NAME                         STATUS   ROLES           AGE     VERSION
control-plane.example.com    Ready    master,worker   10m     v1.27.9+e36e183
```

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

### Example output for oc get subscription -A

Source: https://docs.okd.io/latest/post_installation_configuration/day_2_core_cnf_clusters/updating/update-rhacm-talm-operator-coordination.html

This output displays the namespace, subscription name, package, source, and channel for installed Operators.

```text
NAMESPACE                              NAME                                PACKAGE                  SOURCE             CHANNEL
openshift-sriov-network-operator       sriov-network-operator-subscription sriov-network-operator   redhat-operators   stable-4.20
openshift-ptp                          ptp-operator-subscription           ptp-operator             redhat-operators   stable-4.20
```

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

### Example installation log output

Source: https://docs.okd.io/latest/installing/validation_and_troubleshooting/validating-an-installation.html

This snippet shows the expected format of the installation log, including cluster access credentials and timing information.

```text
...
time="2020-12-03T09:50:47Z" level=info msg="Install complete!"
time="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'"
time="2020-12-03T09:50:47Z" level=info msg="Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com"
time="2020-12-03T09:50:47Z" level=info msg="Login to the console with user: \"kubeadmin\", and password: \"password\""
time="2020-12-03T09:50:47Z" level=debug msg="Time elapsed per stage:"
time="2020-12-03T09:50:47Z" level=debug msg="    Infrastructure: 6m45s"
time="2020-12-03T09:50:47Z" level=debug msg="Bootstrap Complete: 11m30s"
time="2020-12-03T09:50:47Z" level=debug msg=" Bootstrap Destroy: 1m5s"
time="2020-12-03T09:50:47Z" level=debug msg=" Cluster Operators: 17m31s"
time="2020-12-03T09:50:47Z" level=info msg="Time elapsed: 37m26s"
```

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

### Example install-config.yaml configuration file

Source: https://docs.okd.io/latest/installing/installing_ibm_cloud/installing-ibm-cloud-private.html

Example of the install-config.yaml file with the credentialsMode parameter set to Manual.

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

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

### useQuickStartContext hook example

Source: https://docs.okd.io/latest/web_console/dynamic-plugin/dynamic-plugins-reference.html

Provides quick start context values to interoperate with console quick start functionality. The example shows a button that sets the active quick start.

```typescript
const OpenQuickStartButton = ({ quickStartId }) => {
   const { setActiveQuickStart } = useQuickStartContext();
   const onClick = React.useCallback(() => {
       setActiveQuickStart(quickStartId);
   }, [quickStartId]);
   return <button onClick={onClick}>{t('Open Quick Start')}</button>
};
```

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

### Create the live installation ISO

Source: https://docs.okd.io/latest/edge_computing/image_base_install/ibi-factory-image-based-install.html

Execute the command to build the ISO using the configuration in the working directory.

```bash
$ openshift-install image-based create image --dir ibi-iso-workdir
```

```text
INFO Consuming Image-based Installation ISO Config from target directory
INFO Creating Image-based Installation ISO with embedded ignition
```

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

### Example install-config.yaml with userTags

Source: https://docs.okd.io/latest/installing/installing_azure/ipi/installing-azure-customizations.html

An example configuration showing user-defined tags for createdBy and environment.

```yaml
apiVersion: v1
baseDomain: example.com
#...
platform:
  azure:
    userTags:
      createdBy: user
      environment: dev
#...
```

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

### Remove installation directory

Source: https://docs.okd.io/latest/installing/validation_and_troubleshooting/installing-troubleshooting.html

Deletes the installation directory to ensure a clean state before starting a new installation.

```bash
$ rm -rf <installation_directory>
```

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

### Get Install Plan

Source: https://docs.okd.io/latest/networking/networking_operators/metallb-operator/metallb-upgrading-operator.html

List existing install plans in the namespace to identify the manual install plan.

```bash
$ oc -n metallb-system get installplan
```

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

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

### Example pipelines-operator.yaml CR

Source: https://docs.okd.io/latest/extensions/ce/managing-ce.html

An example configuration for installing the pipelines operator.

```yaml
apiVersion: olm.operatorframework.io/v1
kind: ClusterExtension
metadata:
  name: pipelines-operator
spec:
  namespace: pipelines
  serviceAccount:
    name: pipelines-installer
  source:
    sourceType: Catalog
    catalog:
      packageName: openshift-pipelines-operator-rh
      version: "1.14.x"
```

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

### Create installation directory

Source: https://docs.okd.io/latest/installing/installing_oci/installing-oci-agent-based-installer.html

Create a directory to store the configuration files.

```bash
$ mkdir ~/<directory_name>
```

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

### Create hello-world namespace

Source: https://docs.okd.io/latest/backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.html

Create the namespace for the sample application.

```bash
$ oc create namespace hello-world
```

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

### Start yarn

Source: https://docs.okd.io/latest/web_console/dynamic-plugin/dynamic-plugins-get-started.html

Run this command after installing dependencies to start the yarn process.

```bash
$ yarn run start
```

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

### ClusterExtension resource example

Source: https://docs.okd.io/latest/extensions/ce/managing-ce.html

An example of the YAML output for a successfully installed ClusterExtension.

```yaml
apiVersion: olm.operatorframework.io/v1
kind: ClusterExtension
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"olm.operatorframework.io/v1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipes"},"spec":{"namespace":"pipelines","serviceAccount":{"name":"pipelines-installer"},"source":{"catalog":{"packageName":"openshift-pipelines-operator-rh","version":"<1.16"},"sourceType":"Catalog"}}}
  creationTimestamp: "2025-02-18T21:48:13Z"
  finalizers:
  - olm.operatorframework.io/cleanup-unpack-cache
  - olm.operatorframework.io/cleanup-contentmanager-cache
  generation: 2
  name: pipes
  resourceVersion: "90693"
  uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
spec:
  namespace: pipelines
  serviceAccount:
    name: pipelines-installer
  source:
    catalog:
      packageName: openshift-pipelines-operator-rh
      upgradeConstraintPolicy: CatalogProvided
      version: <1.16
    sourceType: Catalog
status:
  conditions:
  - lastTransitionTime: "2025-02-18T21:48:13Z"
    message: ""
    observedGeneration: 2
    reason: Deprecated
    status: "False"
    type: Deprecated
  - lastTransitionTime: "2025-02-18T21:48:13Z"
    message: ""
    observedGeneration: 2
    reason: Deprecated
    status: "False"
    type: PackageDeprecated
  - lastTransitionTime: "2025-02-18T21:48:13Z"
    message: ""
    observedGeneration: 2
    reason: Deprecated
    status: "False"
    type: ChannelDeprecated
  - lastTransitionTime: "2025-02-18T21:48:13Z"
    message: ""
    observedGeneration: 2
    reason: Deprecated
    status: "False"
    type: BundleDeprecated
  - lastTransitionTime: "2025-02-18T21:48:16Z"
    message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:8a593c1144709c9aeffbeb68d0b4b08368f528e7bb6f595884b2474bcfbcafcd
      successfully
    observedGeneration: 2
    reason: Succeeded
    status: "True"
    type: Installed
  - lastTransitionTime: "2025-02-18T21:48:16Z"
    message: desired state reached
    observedGeneration: 2
    reason: Succeeded
    status: "True"
    type: Progressing
  install:
    bundle:
      name: openshift-pipelines-operator-rh.v1.15.2
      version: 1.15.2
```

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

### Create a new project example

Source: https://docs.okd.io/latest/applications/projects/working-with-projects.html

An example of the oc new-project command with concrete values for the project name, description, and display name.

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

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

### Run coreos-installer

Source: https://docs.okd.io/latest/installing/installing_bare_metal/upi/installing-bare-metal.html

Example command to run the coreos-installer with an ignition URL.

```bash
coreos-installer install --ignition-url http://10.0.2.2:8080/user.ign \

sh-4.2# exit
```

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

### Get install plan name

Source: https://docs.okd.io/latest/networking/networking_operators/external_dns_operator/nw-installing-external-dns-operator-on-cloud-providers.html

Retrieve the name of the install plan from the subscription.

```bash
$ oc -n external-dns-operator \
  get subscription external-dns-operator \
  --template='{{.status.installplan.name}}{{"\n"}}'
```

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

### Verify Helm installation

Source: https://docs.okd.io/latest/applications/working_with_helm_charts/installing-helm.html

Check the installed version of Helm and view the example output.

```bash
$ helm version
```

```text
version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}
```

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

### oc start-build command examples

Source: https://docs.okd.io/latest/cli_reference/openshift_cli/developer-cli-commands.html

Commands to trigger new builds using various sources, build configurations, or previous builds, with options to follow logs or wait for completion.

```bash
  # Starts build from build config "hello-world"
  oc start-build hello-world

  # Starts build from a previous build "hello-world-1"
  oc start-build --from-build=hello-world-1

  # Use the contents of a directory as build input
  oc start-build hello-world --from-dir=src/

  # Send the contents of a Git repository to the server from tag 'v2'
  oc start-build hello-world --from-repo=../hello-world --commit=v2

  # Start a new build for build config "hello-world" and watch the logs until the build
  # completes or fails
  oc start-build hello-world --follow

  # Start a new build for build config "hello-world" and wait until the build completes. It
  # exits with a non-zero return code if the build fails
  oc start-build hello-world --wait
```
Tokens:
Raw