OpenShift Sandboxed Containers ユーザーガイド

手順

1. NodeFeatureDiscovery リソースを作成して、Kata コンテナーの実行に適したノード機能を検出します。

   1. 次の YAML を nfd.yaml ファイルに保存します。

      apiVersion: nfd.openshift.io/v1
      kind: NodeFeatureDiscovery
      metadata:
        name: nfd-kata
        namespace: openshift-nfd
      spec:
        operand:
          image: quay.io/openshift/origin-node-feature-discovery:4.10
          imagePullPolicy: Always
          servicePort: 12000
        workerConfig:
          configData: |
            sources:
               custom:
                 - name: "feature.node.kubernetes.io/runtime.kata"
                   matchOn:
                     - cpuId: ["SSE4", "VMX"]
                       loadedKMod: ["kvm", "kvm_intel"]
                     - cpuId: ["SSE4", "SVM"]
                       loadedKMod: ["kvm", "kvm_amd"]

   2. NodeFeatureDiscovery カスタムリソース (CR) を作成します。

      $ oc create -f nfd.yaml

      出力例

      nodefeaturediscovery.nfd.openshift.io/nfd-kata created

      feature.node.kubernetes.io/runtime.kata=true ラベルが、資格のあるすべてのワーカーノードに適用されます。

2. KataConfig リソースで checkNodeEligibility フィールドを true に設定して、機能を有効にします。次に例を示します。

   1. 次の YAML を kata-config.yaml ファイルに保存します。

      apiVersion: kataconfiguration.openshift.io/v1
      kind: KataConfig
      metadata:
        name: example-kataconfig
      spec:
        checkNodeEligibility: true

   2. KataConfig CR を作成します。

      $ oc create -f kata-config.yaml

      出力例

      kataconfig.kataconfiguration.openshift.io/example-kataconfig created

手順

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword フィールドに OpenShift sandboxed containers と入力します。
3. OpenShift sandboxed containers タイルを選択します。
4. Operator についての情報を確認してから、Install をクリックします。

5. Install Operator ページで以下を行います。

   1. 選択可能な Update Channel オプションの一覧から stable を選択します。

   2. Installed Namespace で Operator recommend Namespace が選択されていることを確認します。これにより、Operator が必須の openshift-sandboxed-containers-operator namespace にインストールされます。この namespace がまだ存在しない場合は、自動的に作成されます。

      注記

      OpenShift Sandboxed Containers Operator を openshift-sandboxed-containers-operator 以外の namespace にインストールしようとすると、インストールに失敗します。

   3. Approval Strategy で Automatic が選択されていることを確認します。Automatic がデフォルト値であり、新しい z-stream リリースが利用可能になると、OpenShift Sandboxed Containers への自動更新が有効になります。
6. Install をクリックします。

検証

1. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. OpenShift Sandboxed Containers Operator がインストール済みの Operator リストに表示されていることを確認します。

手順

1. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. Operator のリストから OpenShift Sandboxed Containers Operator を選択します。
3. KataConfig タブで、Create KataConfig をクリックします。

4. Create KataConfig ページで、次の詳細を入力します。

   • Name: KataConfig リソースの名前を入力します。デフォルトでは、名前は example-kataconfig として定義されています。
   • Labels (オプション): 関連する識別属性を KataConfig リソースに入力します。各ラベルはキーと値のペアを表します。
   • checkNodeEligibility (オプション、ピア Pod には該当しない): kata を RuntimeClass として実行するノードの適格性を、Node Feature Discovery Operator (NFD) を使用して検出するには、このチェックボックスを選択します。詳細は、「クラスターノードが OpenShift Sandboxed Containers を実行する資格があるかどうかを確認する」を参照してください。
   • EnablePeerPods (ピア Pod の場合): ピア Pod を有効にし、パブリッククラウド環境で OpenShift Sandboxed Containers を使用するには、このチェックボックスをオンにします。

   • kataConfigPoolSelector: デフォルトでは、kata はすべてのノードに RuntimeClass としてインストールされます。選択したノードにのみ kata を RuntimeClass としてインストールする場合は、matchExpression を追加する必要があります。

     1. kataConfigPoolSelector エリアを展開します。
     2. kataConfigPoolSelector で、matchExpressions を展開します。これは、ラベルセレクターの要件のリストです。
     3. Add matchExpressions をクリックします。
     4. key フィールドに、セレクターの適用先のラベルキーを追加します。
     5. operator フィールドに、ラベル値に対するキーの関係を追加します。有効な演算子は、In、NotIn、Exists、DoesNotExist です。
     6. values エリアを展開し、Add value をクリックします。
     7. Value フィールドで、true または false を key ラベル値として入力します。
   • logLevel: kata を RuntimeClass として実行しているノードに対して、取得するログデータのレベルを定義します。詳細は、「OpenShift Sandboxed Containers データの収集」を参照してください。
5. Create をクリックします。

検証

1. KataConfig タブで、新しい KataConfig CR を選択します。
2. KataConfig ページで、YAML タブを選択します。

3. ステータスの installationStatus フィールドをモニターします。

   更新があるたびにメッセージが表示されます。リロード をクリックして、更新された KataConfig CR を表示します。

   Completed nodes の値がワーカーまたはラベル付けされたノードの数と等しくなると、インストールは完了です。ステータスには、インストールが完了したノードのリストも含まれます。

手順

1. Web コンソールの Administrator パースペクティブから、Workloads をデプロイメントし、作成するワークロードのタイプを選択します。
2. ワークロードページで、をクリックしてワークロードを作成します。

3. ワークロードの YAML ファイルで、コンテナーがリストされている spec フィールドに、runtimeClassName: kata を追加します。

   Pod オブジェクトの例

   apiVersion: v1
   kind: Pod
   metadata:
     name: hello-openshift
     labels:
       app: hello-openshift
   spec:
     runtimeClassName: kata
     containers:
       - name: hello-openshift
         image: quay.io/openshift/origin-hello-openshift
         ports:
           - containerPort: 8888
         securityContext:
           privileged: false
           allowPrivilegeEscalation: false
           runAsNonRoot: true
           runAsUser: 1001
           capabilities:
             drop:
               - ALL
           seccompProfile:
             type: RuntimeDefault

4. Save をクリックします。

手順

1. OpenShift Sandboxed Containers Operator の Namespace オブジェクトを作成します。

   1. 次のマニフェストを含む Namespace オブジェクト YAML ファイルを作成します。

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

   2. Namespace オブジェクトを作成します。

      $ oc create -f Namespace.yaml

2. OpenShift Sandboxed Containers Operator の OperatorGroup オブジェクトを作成します。

   1. 次のマニフェストを含む OperatorGroup オブジェクト YAML ファイルを作成します。

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

   2. OperatorGroup オブジェクトを作成します。

      $ oc create -f OperatorGroup.yaml

3. Subscription オブジェクトを作成して、Namespace を OpenShift Sandboxed Containers Operator にサブスクライブします。

   1. 次のマニフェストを含む Subscription オブジェクト YAML ファイルを作成します。

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: openshift-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.4.1

   2. Subscription オブジェクトを作成します。

      $ oc create -f Subscription.yaml

手順

1. 次のマニフェストで YAML ファイルを作成します。

   apiVersion: kataconfiguration.openshift.io/v1
   kind: KataConfig
   metadata:
     name: cluster-kataconfig
   spec:
     checkNodeEligibility: false 1
     logLevel: info

   1

   kata を RuntimeClass として実行するノードの適格性を検出するには、`checkNodeEligibility` を true に設定します。詳細は、「クラスターノードが OpenShift Sandboxed Containers を実行する資格があるかどうかを確認する」を参照してください。

2. (オプション) 選択したノードにのみ kata を RuntimeClass としてインストールする場合は、マニフェストにラベルを含む YAML ファイルを作成します。

   apiVersion: kataconfiguration.openshift.io/v1
   kind: KataConfig
   metadata:
     name: cluster-kataconfig
   spec:
     checkNodeEligibility: false
     logLevel: info
     kataConfigPoolSelector:
       matchLabels:
         <label_key>: '<label_value>' 1

   1

   kataConfigPoolSelector のラベルは単一値のみをサポートします。nodeSelector 構文はサポートされていません。

3. KataConfig リソースを作成します。

   $ oc create -f cluster-kataconfig.yaml

手順

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword フィールドに OpenShift sandboxed containers と入力します。
3. OpenShift sandboxed containers タイルを選択します。
4. Operator についての情報を確認してから、Install をクリックします。

5. Install Operator ページで以下を行います。

   1. 選択可能な Update Channel オプションの一覧から stable を選択します。

   2. Installed Namespace で Operator recommend Namespace が選択されていることを確認します。これにより、Operator が必須の openshift-sandboxed-containers-operator namespace にインストールされます。この namespace がまだ存在しない場合は、自動的に作成されます。

      注記

      OpenShift Sandboxed Containers Operator を openshift-sandboxed-containers-operator 以外の namespace にインストールしようとすると、インストールに失敗します。

   3. Approval Strategy で Automatic が選択されていることを確認します。Automatic がデフォルト値であり、新しい z-stream リリースが利用可能になると、OpenShift Sandboxed Containers への自動更新が有効になります。
6. Install をクリックします。

検証

1. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. OpenShift Sandboxed Containers Operator がインストール済みの Operator リストに表示されていることを確認します。

手順

1. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. Operator のリストから OpenShift Sandboxed Containers Operator を選択します。
3. KataConfig タブで、Create KataConfig をクリックします。

4. Create KataConfig ページで、次の詳細を入力します。

   • Name: KataConfig リソースの名前を入力します。デフォルトでは、名前は example-kataconfig として定義されています。
   • Labels (オプション): 関連する識別属性を KataConfig リソースに入力します。各ラベルはキーと値のペアを表します。
   • checkNodeEligibility (オプション、ピア Pod には該当しない): kata を RuntimeClass として実行するノードの適格性を、Node Feature Discovery Operator (NFD) を使用して検出するには、このチェックボックスを選択します。詳細は、「クラスターノードが OpenShift Sandboxed Containers を実行する資格があるかどうかを確認する」を参照してください。
   • EnablePeerPods (ピア Pod の場合): ピア Pod を有効にし、パブリッククラウド環境で OpenShift Sandboxed Containers を使用するには、このチェックボックスをオンにします。

   • kataConfigPoolSelector: デフォルトでは、kata-remote-cc はすべてのノードに RuntimeClass としてインストールされます。選択したノードにのみ kata-remote-cc を RuntimeClass としてインストールする場合は、matchExpression を追加する必要があります。

     1. kataConfigPoolSelector エリアを展開します。
     2. kataConfigPoolSelector で、matchExpressions を展開します。これは、ラベルセレクターの要件のリストです。
     3. Add matchExpressions をクリックします。
     4. key フィールドに、セレクターの適用先のラベルキーを追加します。
     5. operator フィールドに、ラベル値に対するキーの関係を追加します。有効な演算子は、In、NotIn、Exists、DoesNotExist です。
     6. values エリアを展開し、Add value をクリックします。
     7. Value フィールドで、true または false を key ラベル値として入力します。
   • logLevel:kata-remote-cc を RuntimeClass として実行しているノードに対して取得するログデータのレベルを定義します。詳細は、「OpenShift Sandboxed Containers データの収集」を参照してください。
5. Create をクリックします。

検証

1. KataConfig タブで、新しい KataConfig CR を選択します。
2. KataConfig ページで、YAML タブを選択します。

3. ステータスの installationStatus フィールドをモニターします。

   更新があるたびにメッセージが表示されます。リロード をクリックして、更新された KataConfig CR を表示します。

   Completed nodes の値がワーカーまたはラベル付けされたノードの数と等しくなると、インストールは完了です。ステータスには、インストールが完了したノードのリストも含まれます。

手順

1. Web コンソールの Administrator パースペクティブから、Workloads をデプロイメントし、作成するワークロードのタイプを選択します。
2. ワークロードページで、をクリックしてワークロードを作成します。

3. ワークロードの YAML ファイルで、コンテナーがリストされている spec フィールドに runtimeClassName: kata-remote-cc を追加します。

   Pod オブジェクトの例

   apiVersion: v1
   kind: Pod
   metadata:
     name: hello-openshift
     labels:
       app: hello-openshift
   spec:
     runtimeClassName: kata-remote-cc
     containers:
       - name: hello-openshift
         image: quay.io/openshift/origin-hello-openshift
         ports:
           - containerPort: 8888
         securityContext:
           privileged: false
           allowPrivilegeEscalation: false
           runAsNonRoot: true
           runAsUser: 1001
           capabilities:
             drop:
               - ALL
           seccompProfile:
             type: RuntimeDefault

4. Save をクリックします。

手順

1. OpenShift Sandboxed Containers Operator の Namespace オブジェクトを作成します。

   1. 次のマニフェストを含む Namespace オブジェクト YAML ファイルを作成します。

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

   2. Namespace オブジェクトを作成します。

      $ oc create -f Namespace.yaml

2. OpenShift Sandboxed Containers Operator の OperatorGroup オブジェクトを作成します。

   1. 次のマニフェストを含む OperatorGroup オブジェクト YAML ファイルを作成します。

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

   2. OperatorGroup オブジェクトを作成します。

      $ oc create -f OperatorGroup.yaml

3. Subscription オブジェクトを作成して、Namespace を OpenShift Sandboxed Containers Operator にサブスクライブします。

   1. 次のマニフェストを含む Subscription オブジェクト YAML ファイルを作成します。

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: openshift-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.4.1

   2. Subscription オブジェクトを作成します。

      $ oc create -f Subscription.yaml

手順

1. 次のマニフェストで YAML ファイルを作成します。

   apiVersion: kataconfiguration.openshift.io/v1
   kind: KataConfig
   metadata:
     name: cluster-kataconfig
   spec:
     enablePeerPods: true
     logLevel: info

2. (オプション) kata-remote-cc を選択したノードにのみ RuntimeClass としてインストールする場合は、マニフェストにラベルを含む YAML ファイルを作成します。

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

   1

   kataConfigPoolSelector のラベルは単一値のみをサポートします。nodeSelector 構文はサポートされていません。

3. KataConfig リソースを作成します。

   $ oc create -f cluster-kataconfig.yaml

手順

1. Administrator パースペクティブから、Workloads → Pods に移動します。
2. Search by name フィールドを使用して、削除する Pod を検索します。
3. Pod 名をクリックして開きます。
4. Details ページで、Runtime class に kata が表示されていることを確認します。
5. Actions メニューをクリックし、Delete Pod を選択します。
6. 確認ウィンドウで Delete をクリックします。

手順

1. Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. Search by name フィールドを使用して、OpenShift Sandboxed Containers Operator を検索します。
3. Operator をクリックして開き、KataConfig タブを選択します。
4. KataConfig リソースの Options メニュー をクリックし、Delete KataConfig を選択します。
5. 確認ウィンドウで Delete をクリックします。

手順

1. Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. Search by name フィールドを使用して、OpenShift Sandboxed Containers Operator を検索します。
3. Operator の Options メニュー をクリックし、Uninstall Operator を選択します。
4. 確認ウィンドウで Uninstall をクリックします。

手順

1. Administrator パースペクティブから、Administration → Namespaces に移動します。
2. Search by name フィールドを使用して openshift-sandboxed-containers-operator namespace を検索します。

3. namespace の Options メニュー をクリックし、Delete Namespace を選択します。

   注記

   Delete Namespace オプションが選択できない場合には、namespace を削除するパーミッションがありません。

4. Delete Namespace ペインで、openshift-sandboxed-containers-operator と入力し、Delete をクリックします。
5. Delete をクリックします。

手順

1. Administrator パースペクティブから、Administration → CustomResourceDefinitions に移動します。
2. Search by name フィールドを使用して KataConfig を検索します。
3. KataConfig CRD の Options メニュー をクリックし、Delete CustomResourceDefinition を選択します。
4. 確認ウィンドウで Delete をクリックします。
5. KataConfig CRD がリストから消えるまで待ちます。これには数分の時間がかかる場合があります。

手順

1. 次のコマンドを実行して、kata を runtimeClass として使用する Pod を検索します。

   $ oc get pods -A -o json | jq -r '.items[] | select(.spec.runtimeClassName == "kata").metadata.name'

2. 各 Pod を削除するには、次のコマンドを実行します。

   $ oc delete pod <pod-name>

手順

1. 以下のコマンドを実行して KataConfig カスタムリソースを削除します。

   $ oc delete kataconfig <KataConfig_CR_Name>

手順

1. 次のコマンドを実行して、サブスクリプションから OpenShift Sandboxed Containers のクラスターサービスバージョン (CSV) 名をフェッチします。

   CSV_NAME=$(oc get csv -n openshift-sandboxed-containers-operator -o=custom-columns=:metadata.name)

2. 以下のコマンドを実行して、OpenShift Sandboxed Containers Operator サブスクリプションを Operator Lifecyle Manager (OLM) から削除します。

   $ oc delete subscription sandboxed-containers-operator -n openshift-sandboxed-containers-operator

3. 以下のコマンドを実行して、OpenShift Sandboxed Containers の CSV 名を削除します。

   $ oc delete csv ${CSV_NAME} -n openshift-sandboxed-containers-operator

4. 次のコマンドを実行して、OpenShift Sandboxed Containers の Operator グループ名を取得します。

   $ OG_NAME=$(oc get operatorgroup -n openshift-sandboxed-containers-operator -o=jsonpath={..name})

5. 次のコマンドを実行して、OpenShift Sandboxed Containers Operator グループ名を削除します。

   $ oc delete operatorgroup ${OG_NAME} -n openshift-sandboxed-containers-operator

6. 次のコマンドを実行して、OpenShift Sandboxed Containers の namespace を削除します。

   $ oc delete namespace openshift-sandboxed-containers-operator

手順

1. 次のコマンドを実行して、KataConfig CRD を削除します。

   $ oc delete crd kataconfigs.kataconfiguration.openshift.io

手順

1. Red Hat OpenShift の Administrator 観点から、Operators → Installed Operators に移動します。
2. OpenShift sandboxed containers Operator を選択し、KataConfig タブに移動します。
3. Search by name フィールドを使用して、KataConfig リソースを検索します。KataConfig リソースのデフォルト名は example-kataconfig です。
4. KataConfig リソースを選択し、KataConfig タブに移動します。

5. kataMonitorImage のバージョン番号を変更します。

       checkNodeEligibility: false
       kataConfigPoolSelector: null
       kataMonitorImage: 'registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:1.3.0'

6. Save をクリックします。