Skip to content

Commit 52ce39a

Browse files
committed
TELCODOCS:1040 - remove kata monitor image
1 parent c7442a3 commit 52ce39a

3 files changed

+27
-29
lines changed

modules/sandboxed-containers-check-node-eligiblilty.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="sandboxed-containers-check-node-eligiblilty_{context}"]
77
= Checking whether cluster nodes are eligible to run {sandboxed-containers-first}
88

9-
Before running {sandboxed-containers-first}, you can check whether the nodes in your cluster are eligible to run Kata containers. Some cluster nodes might not comply with sandboxed containers' minimum requirements. The most common reason for node ineligibility is the lack of virtualization support on the node. If you attempt to run sandboxed workloads on ineligible nodes, you will experience errors. You can use the Node Feature Discovery Operator (NFD) and a `NodeFeatureDiscovery` resource to automatically check node eligibility.
9+
Before running {sandboxed-containers-first}, you can check whether the nodes in your cluster are eligible to run Kata containers. Some cluster nodes might not comply with sandboxed containers' minimum requirements. The most common reason for node ineligibility is the lack of virtualization support on the node. If you attempt to run sandboxed workloads on ineligible nodes, you will experience errors. You can use the Node Feature Discovery (NFD) Operator and a `NodeFeatureDiscovery` resource to automatically check node eligibility.
1010

1111
[NOTE]
1212
====

modules/sandboxed-containers-create-kata-config-resource-cli.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,10 @@ kind: KataConfig
4646
metadata:
4747
name: cluster-kataconfig
4848
spec:
49-
kataMonitorImage: registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:{sandboxed-containers-version}.0
49+
checkNodeEligibility: false <1>
50+
logLevel: info
5051
----
52+
<1> Set`checkNodeEligibility` to `true` to detect node eligibility to run `kata` as a `RuntimeClass`. For more information, see "Checking whether cluster nodes are eligible to run {sandboxed-containers-first}".
5153

5254
. (Optional) If you want to install `kata` as a `RuntimeClass` only on selected nodes, create a YAML file that includes the label in the manifest:
5355
+
@@ -58,7 +60,8 @@ kind: KataConfig
5860
metadata:
5961
name: cluster-kataconfig
6062
spec:
61-
kataMonitorImage: registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:{sandboxed-containers-version}.0
63+
checkNodeEligibility: false
64+
logLevel: info
6265
kataConfigPoolSelector:
6366
matchLabels:
6467
<label_key>: '<label_value>'

modules/sandboxed-containers-create-kataconfig-resource-web-console.adoc

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,36 +38,31 @@ Kata is installed on all worker nodes by default. If you want to install `kata`
3838

3939
. In the *KataConfig* tab, click *Create KataConfig*.
4040

41-
. In the *Create KataConfig* page, select to configure the `KataConfig` CR via *YAML view*.
41+
. In the *Create KataConfig* page, enter the following details:
42+
+
43+
* *Name*: Enter a name for the `KataConfig` resource. By default, the name is defined as `example-kataconfig`.
4244

43-
. Copy and paste the following manifest into the *YAML view*:
45+
* *Labels* (Optional): Enter any relevant, identifying attributes to the `KataConfig` resource. Each label represents a key-value pair.
4446
45-
+
46-
[source,yaml,subs="attributes+"]
47-
----
48-
apiVersion: kataconfiguration.openshift.io/v1
49-
kind: KataConfig
50-
metadata:
51-
name: cluster-kataconfig
52-
spec:
53-
kataMonitorImage: registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:{sandboxed-containers-version}.0
54-
----
55-
+
56-
If you want to install `kata` as a `RuntimeClass` only on selected nodes, include the label in the manifest:
47+
* *`checkNodeEligibility`* (Optional): Select this checkbox to use the Node Feature Discovery Operator (NFD) to detect node eligibility to run `kata` as a `RuntimeClass`. For more information, see "Checking whether cluster nodes are eligible to run {sandboxed-containers-first}".
5748
49+
* *`kataConfigPoolSelector`*: By default, `kata` is installed as a `RuntimeClass` on all nodes. If you want to install `kata` as a `RuntimeClass` only on selected nodes, you must add a *matchExpression*:
5850
+
59-
[source,yaml,subs="attributes+"]
60-
----
61-
apiVersion: kataconfiguration.openshift.io/v1
62-
kind: KataConfig
63-
metadata:
64-
name: cluster-kataconfig
65-
spec:
66-
kataMonitorImage: registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:{sandboxed-containers-version}.0
67-
kataConfigPoolSelector:
68-
matchLabels:
69-
<label_key>: '<label_value>'
70-
----
51+
.. Expand the *`kataConfigPoolSelector`* area.
52+
53+
.. In the *`kataConfigPoolSelector`*, expand *matchExpressions*. This is a list of label selector requirements.
54+
55+
.. Click *Add matchExpressions*.
56+
57+
.. In the *key* field, add the label key the selector applies to.
58+
59+
.. In the *operator* field, add the key's relationship to the label values. Valid operators are `In`, `NotIn`, `Exists`, and `DoesNotExist`.
60+
61+
.. Expand the *values* area, and then click *Add value*.
62+
63+
.. In the *Value* field, enter `true` or `false` for *key* label value.
64+
65+
* *`logLevel`*: Define the level of log data retrieved for nodes running `kata` as a `RuntimeClass`. For more information, see "Collecting {sandboxed-containers-first} data".
7166
7267
. Click *Create*.
7368

0 commit comments

Comments
 (0)