Chapter 5. Deploying OpenShift sandboxed containers on Google Cloud

Procedure

1. In the web console, navigate to Operators OperatorHub.
2. In the Filter by keyword field, type OpenShift sandboxed containers.
3. Select the OpenShift sandboxed containers Operator tile and click Install.
4. On the Install Operator page, select stable from the list of available Update Channel options.

5. Verify that Operator recommended Namespace is selected for Installed Namespace. This installs the Operator in the mandatory openshift-sandboxed-containers-operator namespace. If this namespace does not yet exist, it is automatically created.

   Note

   Attempting to install the OpenShift sandboxed containers Operator in a namespace other than openshift-sandboxed-containers-operator causes the installation to fail.

6. Verify that Automatic is selected for Approval Strategy. Automatic is the default value, and enables automatic updates to OpenShift sandboxed containers when a new z-stream release is available.
7. Click Install.
8. Navigate to Operators Installed Operators to verify that the Operator is installed.

Procedure

1. Set the project ID variable by running the following command:

   $ export GCP_PROJECT_ID="<project_id>"

   Copy to Clipboard Toggle word wrap

2. Log in to Google Cloud by running the following command:

   $ gcloud auth login

   Copy to Clipboard Toggle word wrap

3. Set the Google Cloud project ID by running the following command:

   $ gcloud config set project ${GCP_PROJECT_ID}

   Copy to Clipboard Toggle word wrap

4. Open port 15150 by running the following command:

   $ gcloud compute firewall-rules create allow-port-15150-restricted \
      --project=${GCP_PROJECT_ID} \
      --network=default \
      --allow=tcp:15150 \
      --source-ranges=<external_ip_cidr-1>[,<external_ip_cidr-2>,...] 

   1

   Copy to Clipboard Toggle word wrap

   1

   Specify one or more IP addresses or ranges in CIDR format, separated by commas. For example, 203.0.113.5/32,198.51.100.0/24.

Procedure

1. In the Google Cloud console, navigate to IAM & Admin Service Accounts Keys and save your key as a JSON file.

2. Convert the JSON file to a single line string by running the following command:

   $ cat <key_file>.json | jq -c .

   Copy to Clipboard Toggle word wrap
3. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
4. Click the OpenShift sandboxed containers Operator tile.
5. Click the Import icon (+) on the top right corner.

6. In the Import YAML window, paste the following YAML manifest:

   apiVersion: v1
   kind: Secret
   metadata:
     name: peer-pods-secret
     namespace: openshift-sandboxed-containers-operator
   type: Opaque
   stringData:
     GCP_CREDENTIALS: "<gc_service_account_key_json>" 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <gc_service_account_key_json> with the single-line string you created from the Google Cloud service account key JSON file.

7. Click Save to apply the changes.
8. Navigate to Workloads Secrets to verify the peer pods secret.

Procedure

1. Log in to your Compute Engine instance to set the following environmental variables:

   1. Get the project ID by running the following command:

      $ GCP_PROJECT_ID=$(gcloud config get-value project)

      Copy to Clipboard Toggle word wrap

   2. Get the zone by running the following command:

      $ GCP_ZONE=$(gcloud config get-value compute/zone)

      Copy to Clipboard Toggle word wrap

   3. Retrieve a list of network names by running the following command:

      $ gcloud compute networks list --format="value(name)"

      Copy to Clipboard Toggle word wrap

   4. Specify the network by running the following command:

      $ GCP_NETWORK=<network_name> 

      1

      Copy to Clipboard Toggle word wrap

      1

      Replace <network_name> with the name of the network.

2. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
3. Select the OpenShift sandboxed containers Operator from the list of operators.
4. Click the Import icon (+) in the top right corner.

5. In the Import YAML window, paste the following YAML manifest:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: peer-pods-cm
     namespace: openshift-sandboxed-containers-operator
   data:
     CLOUD_PROVIDER: "gcp"
     PROXY_TIMEOUT: "5m"
     GCP_PROJECT_ID: "<gcp_project_id>" 

   1

   
     GCP_ZONE: "<gcp_zone>" 

   2

   
     GCP_MACHINE_TYPE: "e2-medium" 

   3

   
     GCP_NETWORK: "<gcp_network>" 

   4

   
     PEERPODS_LIMIT_PER_NODE: "10" 

   5

   
     TAGS: "key1=value1,key2=value2" 

   6

   
     DISABLECVM: "true"

   Copy to Clipboard Toggle word wrap

   1

   Specify the project ID you want to use.

   2

   Specify the GCP_ZONE value that you retrieved. This zone will run the workload.

   3

   Specify the machine type that matches the requirements of your workload.

   4

   Specify the GCP_NETWORK value you retrieved.

   5

   Specify the maximum number of peer pods that can be created per node. The default value is 10.

   6

   You can configure custom tags as key:value pairs for pod VM instances to track peer pod costs or to identify peer pods in different clusters.

6. Click Save to apply the changes.
7. Navigate to Workloads ConfigMaps to view the new config map.

Procedure

1. Clone the OpenShift sandboxed containers repository by running the following command:

   $ git clone https://github.com/openshift/sandboxed-containers-operator.git

   Copy to Clipboard Toggle word wrap

2. Navigate to sandboxed-containers-operator/config/peerpods/podvm/bootc by running the following command:

   $ cd sandboxed-containers-operator/config/peerpods/podvm/bootc

   Copy to Clipboard Toggle word wrap

3. Log in to registry.redhat.io by running the following command:

   $ podman login registry.redhat.io

   Copy to Clipboard Toggle word wrap

   You must log in to registry.redhat.io, because the podman build process must access the Containerfile.rhel container image hosted on the registry.

4. Set the image path for your container registry by running the following command:

   $ IMG="<container_registry_url>/<username>/podvm-bootc:latest"

   Copy to Clipboard Toggle word wrap

5. Build the pod VM bootc image by running the following command:

   $ podman build -t ${IMG} -f Containerfile.rhel .

   Copy to Clipboard Toggle word wrap

6. Log in to your container registry by running the following command:

   $ podman login <container_registry_url>

   Copy to Clipboard Toggle word wrap

7. Push the image to your container registry by running the following command:

   $ podman push ${IMG}

   Copy to Clipboard Toggle word wrap

   For testing and development, you can make the image public.

8. Verify the podvm-bootc image by running the following command:

   $ podman images

   Copy to Clipboard Toggle word wrap

   Example output

   REPOSITORY                               TAG     IMAGE ID      CREATED         SIZE
   example.com/example_user/podvm-bootc     latest  88ddab975a07  2 seconds ago   1.82 GB

   Copy to Clipboard Toggle word wrap

Procedure

1. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
2. Select the OpenShift sandboxed containers Operator from the list of operators.
3. Click the Import icon (+) in the top right corner.

4. In the Import YAML window, paste the following YAML manifest:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: gc-podvm-image-cm
     namespace: openshift-sandboxed-containers-operator
   data:
     IMAGE_TYPE: pre-built
     PODVM_IMAGE_URI: <container_registry_url>/<username>/podvm-bootc:latest
     IMAGE_BASE_NAME: "podvm-image"
     IMAGE_VERSION: "0-0-0"
   
     INSTALL_PACKAGES: "no"
     DISABLE_CLOUD_CONFIG: "true"
     UPDATE_PEERPODS_CM: "yes"
     BOOT_FIPS: "no"
   
     BOOTC_BUILD_CONFIG: |
       [[customizations.user]]
       name = "peerpod"
       password = "peerpod"
       groups = ["wheel", "root"]
   
       [[customizations.filesystem]]
       mountpoint = "/"
       minsize = "5 GiB"
   
       [[customizations.filesystem]]
       mountpoint = "/var/kata-containers"
       minsize = "15 GiB"

   Copy to Clipboard Toggle word wrap
5. Click Save to apply the changes.
6. Navigate to Workloads ConfigMaps to view the new config map.

Procedure

1. Create a policy.rego file with your custom policy. The following example shows all configurable APIs, with exec and log enabled for demonstration:

   package agent_policy
   
   import future.keywords.in
   import input
   
   default CopyFileRequest := false
   default CreateContainerRequest := false
   default CreateSandboxRequest := true
   default DestroySandboxRequest := true
   default ExecProcessRequest := true  # Enabled to allow exec API
   default GetOOMEventRequest := true
   default GuestDetailsRequest := true
   default OnlineCPUMemRequest := true
   default PullImageRequest := true
   default ReadStreamRequest := true   # Enabled to allow log API
   default RemoveContainerRequest := true
   default RemoveStaleVirtiofsShareMountsRequest := true
   default SignalProcessRequest := true
   default StartContainerRequest := true
   default StatsContainerRequest := true
   default TtyWinResizeRequest := true
   default UpdateEphemeralMountsRequest := true
   default UpdateInterfaceRequest := true
   default UpdateRoutesRequest := true
   default WaitProcessRequest := true
   default WriteStreamRequest := false

   Copy to Clipboard Toggle word wrap

   This policy enables the exec (ExecProcessRequest) and log (ReadStreamRequest) APIs. Adjust the true or false values to customize the policy further based on your needs.

2. Convert the policy.rego file to a Base64-encoded string by running the following command:

   $ base64 -w0 policy.rego

   Copy to Clipboard Toggle word wrap

   Save the output for use in the yaml file.

3. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
4. Select the OpenShift sandboxed containers Operator from the list of operators.
5. Click the Import icon (+) in the top right corner.

6. In the Import YAML window, paste the following YAML manifest and add the Base64-encoded policy to it:

   apiVersion: v1
   kind: Pod
   metadata:
     name: <pod_name>
     annotations:
       io.katacontainers.config.agent.policy: <base64_encoded_policy>
   spec:
     runtimeClassName: kata-remote
     containers:
     - name: <container_name>
       image: registry.access.redhat.com/ubi9/ubi:latest
       command:
       - sleep
       - "36000"
       securityContext:
         privileged: false
         seccompProfile:
           type: RuntimeDefault

   Copy to Clipboard Toggle word wrap
7. Click Save to apply the changes.

Procedure

1. In the OpenShift Container Platform web console, navigate to Operators Installed Operators.
2. Select the OpenShift sandboxed containers Operator.
3. On the KataConfig tab, click Create KataConfig.

4. Enter the following details:

   • Name: Optional: The default name is example-kataconfig.
   • Labels: Optional: Enter any relevant, identifying attributes to the KataConfig resource. Each label represents a key-value pair.
   • enablePeerPods: Select for public cloud, IBM Z®, and IBM® LinuxONE deployments.

   • kataConfigPoolSelector. Optional: To install kata-remote on selected nodes, add a match expression for the labels on the selected nodes:

     1. Expand the kataConfigPoolSelector area.
     2. In the kataConfigPoolSelector area, expand matchExpressions. This is a list of label selector requirements.
     3. Click Add matchExpressions.
     4. In the Key field, enter the label key the selector applies to.
     5. In the Operator field, enter the key’s relationship to the label values. Valid operators are In, NotIn, Exists, and DoesNotExist.
     6. Expand the Values area and then click Add value.
     7. In the Value field, enter true or false for key label value.
   • logLevel: Define the level of log data retrieved for nodes with the kata-remote runtime class.

5. Click Create. The KataConfig CR is created and installs the kata-remote runtime class on the worker nodes.

   Wait for the kata-remote installation to complete and the worker nodes to reboot before verifying the installation.

Verification

1. On the KataConfig tab, click the KataConfig CR to view its details.

2. Click the YAML tab to view the status stanza.

   The status stanza contains the conditions and kataNodes keys. The value of status.kataNodes is an array of nodes, each of which lists nodes in a particular state of kata-remote installation. A message appears each time there is an update.

3. Click Reload to refresh the YAML.

   When all workers in the status.kataNodes array display the values installed and conditions.InProgress: False with no specified reason, the kata-remote is installed on the cluster.

Procedure

1. Navigate to Workloads ConfigMaps.
2. Click the provider config map to view its details.
3. Click the YAML tab.

4. Check the status stanza of the YAML file.

   If the PODVM_IMAGE_NAME parameter is populated, the pod VM image was created successfully.

Troubleshooting

1. Retrieve the events log by running the following command:

   $ oc get events -n openshift-sandboxed-containers-operator --field-selector involvedObject.name=osc-podvm-image-creation

   Copy to Clipboard Toggle word wrap

2. Retrieve the job log by running the following command:

   $ oc logs -n openshift-sandboxed-containers-operator jobs/osc-podvm-image-creation

   Copy to Clipboard Toggle word wrap

Procedure

1. Add spec.runtimeClassName: kata-remote to the manifest of each pod-templated workload object as in the following example:

   apiVersion: v1
   kind: <object>
   # ...
   spec:
     runtimeClassName: kata-remote
   # ...

   Copy to Clipboard Toggle word wrap

   OpenShift Container Platform creates the workload object and begins scheduling it.

Procedure

1. Create an osc-namespace.yaml manifest file:

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-sandboxed-containers-operator

   Copy to Clipboard Toggle word wrap

2. Create the namespace by running the following command:

   $ oc apply -f osc-namespace.yaml

   Copy to Clipboard Toggle word wrap

3. Create an osc-operatorgroup.yaml manifest file:

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: sandboxed-containers-operator-group
     namespace: openshift-sandboxed-containers-operator
   spec:
     targetNamespaces:
     - openshift-sandboxed-containers-operator

   Copy to Clipboard Toggle word wrap

4. Create the operator group by running the following command:

   $ oc apply -f osc-operatorgroup.yaml

   Copy to Clipboard Toggle word wrap

5. Create an osc-subscription.yaml manifest file:

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: sandboxed-containers-operator
     namespace: openshift-sandboxed-containers-operator
   spec:
     channel: stable
     installPlanApproval: Automatic
     name: sandboxed-containers-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
     startingCSV: sandboxed-containers-operator.v1.9.0

   Copy to Clipboard Toggle word wrap

6. Create the subscription by running the following command:

   $ oc apply -f osc-subscription.yaml

   Copy to Clipboard Toggle word wrap

7. Verify that the Operator is correctly installed by running the following command:

   $ oc get csv -n openshift-sandboxed-containers-operator

   Copy to Clipboard Toggle word wrap

   This command can take several minutes to complete.

8. Watch the process by running the following command:

   $ watch oc get csv -n openshift-sandboxed-containers-operator

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                             DISPLAY                                  VERSION             REPLACES                   PHASE
   openshift-sandboxed-containers   openshift-sandboxed-containers-operator  1.9.0    1.8.1        Succeeded

   Copy to Clipboard Toggle word wrap

Procedure

1. Set the project ID variable by running the following command:

   $ export GCP_PROJECT_ID="<project_id>"

   Copy to Clipboard Toggle word wrap

2. Log in to Google Cloud by running the following command:

   $ gcloud auth login

   Copy to Clipboard Toggle word wrap

3. Set the Google Cloud project ID by running the following command:

   $ gcloud config set project ${GCP_PROJECT_ID}

   Copy to Clipboard Toggle word wrap

4. Open port 15150 by running the following command:

   $ gcloud compute firewall-rules create allow-port-15150-restricted \
      --project=${GCP_PROJECT_ID} \
      --network=default \
      --allow=tcp:15150 \
      --source-ranges=<external_ip_cidr-1>[,<external_ip_cidr-2>,...] 

   1

   Copy to Clipboard Toggle word wrap

   1

   Specify one or more IP addresses or ranges in CIDR format, separated by commas. For example, 203.0.113.5/32,198.51.100.0/24.

Procedure

1. Create a Google Cloud service account key and save it as a JSON file by running the following command:

   $ gcloud iam service-accounts keys create <key_filename>.json \
     --iam-account=<service_account_email_address>

   Copy to Clipboard Toggle word wrap

2. Convert the JSON file to a single line string by running the following command:

   $ cat <key_file>.json | jq -c .

   Copy to Clipboard Toggle word wrap

3. Create a peer-pods-secret.yaml manifest file according to the following example:

   apiVersion: v1
   kind: Secret
   metadata:
     name: peer-pods-secret
     namespace: openshift-sandboxed-containers-operator
   type: Opaque
   stringData:
     GCP_CREDENTIALS: "<gc_service_account_key_json>" 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <gc_service_account_key_json> with the single-line string you created from the Google Cloud service account key JSON file.

4. Create the secret by running the following command:

   $ oc apply -f peer-pods-secret.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to your Compute Engine instance to set the following environmental variables:

   1. Get the project ID by running the following command:

      $ GCP_PROJECT_ID=$(gcloud config get-value project)

      Copy to Clipboard Toggle word wrap

   2. Get the zone by running the following command:

      $ GCP_ZONE=$(gcloud config get-value compute/zone)

      Copy to Clipboard Toggle word wrap

   3. Retrieve a list of network names by running the following command:

      $ gcloud compute networks list --format="value(name)"

      Copy to Clipboard Toggle word wrap

   4. Specify the network by running the following command:

      $ GCP_NETWORK=<network_name> 

      1

      Copy to Clipboard Toggle word wrap

      1

      Replace <network_name> with the name of the network.

2. Create a peer-pods-cm.yaml manifest file according to the following example:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: peer-pods-cm
     namespace: openshift-sandboxed-containers-operator
   data:
     CLOUD_PROVIDER: "gcp"
     PROXY_TIMEOUT: "5m"
     GCP_PROJECT_ID: "<gcp_project_id>" 

   1

   
     GCP_ZONE: "<gcp_zone>" 

   2

   
     GCP_MACHINE_TYPE: "e2-medium" 

   3

   
     GCP_NETWORK: "<gcp_network>" 

   4

   
     PEERPODS_LIMIT_PER_NODE: "10" 

   5

   
     TAGS: "key1=value1,key2=value2" 

   6

   
     DISABLECVM: "true"

   Copy to Clipboard Toggle word wrap

   1

   Specify the project ID you want to use.

   2

   Specify the GCP_ZONE value that you retrieved. This zone will run the workload.

   3

   Specify the machine type that matches the requirements of your workload.

   4

   Specify the GCP_NETWORK value you retrieved.

   5

   Specify the maximum number of peer pods that can be created per node. The default value is 10.

   6

   You can configure custom tags as key:value pairs for pod VM instances to track peer pod costs or to identify peer pods in different clusters.

3. Create the config map by running the following command:

   $ oc apply -f peer-pods-cm.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Clone the OpenShift sandboxed containers repository by running the following command:

   $ git clone https://github.com/openshift/sandboxed-containers-operator.git

   Copy to Clipboard Toggle word wrap

2. Navigate to sandboxed-containers-operator/config/peerpods/podvm/bootc by running the following command:

   $ cd sandboxed-containers-operator/config/peerpods/podvm/bootc

   Copy to Clipboard Toggle word wrap

3. Log in to registry.redhat.io by running the following command:

   $ podman login registry.redhat.io

   Copy to Clipboard Toggle word wrap

   You must log in to registry.redhat.io, because the podman build process must access the Containerfile.rhel container image hosted on the registry.

4. Set the image path for your container registry by running the following command:

   $ IMG="<container_registry_url>/<username>/podvm-bootc:latest"

   Copy to Clipboard Toggle word wrap

5. Build the pod VM bootc image by running the following command:

   $ podman build -t ${IMG} -f Containerfile.rhel .

   Copy to Clipboard Toggle word wrap

6. Log in to your container registry by running the following command:

   $ podman login <container_registry_url>

   Copy to Clipboard Toggle word wrap

7. Push the image to your container registry by running the following command:

   $ podman push ${IMG}

   Copy to Clipboard Toggle word wrap

   For testing and development, you can make the image public.

8. Verify the podvm-bootc image by running the following command:

   $ podman images

   Copy to Clipboard Toggle word wrap

   Example output

   REPOSITORY                               TAG     IMAGE ID      CREATED         SIZE
   example.com/example_user/podvm-bootc     latest  88ddab975a07  2 seconds ago   1.82 GB

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a config map manifest for the pod VM image named gc-podvm-image-cm.yaml with the following content:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: gc-podvm-image-cm
     namespace: openshift-sandboxed-containers-operator
   data:
     IMAGE_TYPE: pre-built
     PODVM_IMAGE_URI: <container_registry_url>/<username>/podvm-bootc:latest
     IMAGE_BASE_NAME: "podvm-image"
     IMAGE_VERSION: "0-0-0"
   
     INSTALL_PACKAGES: "no"
     DISABLE_CLOUD_CONFIG: "true"
     UPDATE_PEERPODS_CM: "yes"
     BOOT_FIPS: "no"
   
     BOOTC_BUILD_CONFIG: |
       [[customizations.user]]
       name = "peerpod"
       password = "peerpod"
       groups = ["wheel", "root"]
   
       [[customizations.filesystem]]
       mountpoint = "/"
       minsize = "5 GiB"
   
       [[customizations.filesystem]]
       mountpoint = "/var/kata-containers"
       minsize = "15 GiB"

   Copy to Clipboard Toggle word wrap

2. Create the config map by running the following command:

   $ oc apply -f gc-podvm-image-cm.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a policy.rego file with your custom policy. The following example shows all configurable APIs, with exec and log enabled for demonstration:

   package agent_policy
   
   import future.keywords.in
   import input
   
   default CopyFileRequest := false
   default CreateContainerRequest := false
   default CreateSandboxRequest := true
   default DestroySandboxRequest := true
   default ExecProcessRequest := true  # Enabled to allow exec API
   default GetOOMEventRequest := true
   default GuestDetailsRequest := true
   default OnlineCPUMemRequest := true
   default PullImageRequest := true
   default ReadStreamRequest := true   # Enabled to allow log API
   default RemoveContainerRequest := true
   default RemoveStaleVirtiofsShareMountsRequest := true
   default SignalProcessRequest := true
   default StartContainerRequest := true
   default StatsContainerRequest := true
   default TtyWinResizeRequest := true
   default UpdateEphemeralMountsRequest := true
   default UpdateInterfaceRequest := true
   default UpdateRoutesRequest := true
   default WaitProcessRequest := true
   default WriteStreamRequest := false

   Copy to Clipboard Toggle word wrap

   This policy enables the exec (ExecProcessRequest) and log (ReadStreamRequest) APIs. Adjust the true or false values to customize the policy further based on your needs.

2. Convert the policy.rego file to a Base64-encoded string by running the following command:

   $ base64 -w0 policy.rego

   Copy to Clipboard Toggle word wrap

   Save the output for use in the yaml file.

3. Add the Base64-encoded policy to a my-pod.yaml pod specification file:

   apiVersion: v1
   kind: Pod
   metadata:
     name: <pod_name>
     annotations:
       io.katacontainers.config.agent.policy: <base64_encoded_policy>
   spec:
     runtimeClassName: kata-remote
     containers:
     - name: <container_name>
       image: registry.access.redhat.com/ubi9/ubi:latest
       command:
       - sleep
       - "36000"
       securityContext:
         privileged: false
         seccompProfile:
           type: RuntimeDefault

   Copy to Clipboard Toggle word wrap

4. Apply the pod manifest by running the following command:

   $ oc apply -f my-pod.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Create an example-kataconfig.yaml manifest file according to the following example:

   apiVersion: kataconfiguration.openshift.io/v1
   kind: KataConfig
   metadata:
     name: example-kataconfig
   spec:
     enablePeerPods: true
     logLevel: info
   #  kataConfigPoolSelector:
   #    matchLabels:
   #      <label_key>: '<label_value>' 

   1

   Copy to Clipboard Toggle word wrap

   1

   Optional: If you have applied node labels to install kata-remote on specific nodes, specify the key and value, for example, osc: 'true'.

2. Create the KataConfig CR by running the following command:

   $ oc apply -f example-kataconfig.yaml

   Copy to Clipboard Toggle word wrap

   The new KataConfig CR is created and installs kata-remote as a runtime class on the worker nodes.

   Wait for the kata-remote installation to complete and the worker nodes to reboot before verifying the installation.

3. Monitor the installation progress by running the following command:

   $ watch "oc describe kataconfig | sed -n /^Status:/,/^Events/p"

   Copy to Clipboard Toggle word wrap

   When the status of all workers under kataNodes is installed and the condition InProgress is False without specifying a reason, the kata-remote is installed on the cluster.

4. Verify the daemon set by running the following command:

   $ oc get -n openshift-sandboxed-containers-operator ds/osc-caa-ds

   Copy to Clipboard Toggle word wrap

5. Verify the runtime classes by running the following command:

   $ oc get runtimeclass

   Copy to Clipboard Toggle word wrap

   Example output

   NAME             HANDLER          AGE
   kata             kata             152m
   kata-remote      kata-remote      152m

   Copy to Clipboard Toggle word wrap

Procedure

1. Check the current limit by running the following command:

   $ oc get peerpodconfig peerpodconfig-openshift -n openshift-sandboxed-containers-operator \
   -o jsonpath='{.spec.limit}{"\n"}'

   Copy to Clipboard Toggle word wrap

2. Modify the limit attribute of the peerpodConfig CR by running the following command:

   $ oc patch peerpodconfig peerpodconfig-openshift -n openshift-sandboxed-containers-operator \
   --type merge --patch '{"spec":{"limit":"<value>"}}' 

   1

   Copy to Clipboard Toggle word wrap

   1

   Replace <value> with the limit you want to define.

Procedure

1. Obtain the config map you created for the peer pods:

   $ oc get configmap peer-pods-cm -n openshift-sandboxed-containers-operator -o yaml

   Copy to Clipboard Toggle word wrap

2. Check the status stanza of the YAML file.

   If the PODVM_IMAGE_NAME parameter is populated, the pod VM image was created successfully.

Troubleshooting

1. Retrieve the events log by running the following command:

   $ oc get events -n openshift-sandboxed-containers-operator --field-selector involvedObject.name=osc-podvm-image-creation

   Copy to Clipboard Toggle word wrap

2. Retrieve the job log by running the following command:

   $ oc logs -n openshift-sandboxed-containers-operator jobs/osc-podvm-image-creation

   Copy to Clipboard Toggle word wrap

Procedure

1. Add spec.runtimeClassName: kata-remote to the manifest of each pod-templated workload object as in the following example:

   apiVersion: v1
   kind: <object>
   # ...
   spec:
     runtimeClassName: kata-remote
   # ...

   Copy to Clipboard Toggle word wrap

   OpenShift Container Platform creates the workload object and begins scheduling it.