管理ガイド

手順

1. オプション: この OpenShift クラスターに OpenShift Dev Spaces をデプロイした場合は、以前の OpenShift Dev Spaces インスタンスが削除されていることを確認してください。

   $ dsc server:delete

   Copy to Clipboard Toggle word wrap

2. OpenShift Dev Spaces インスタンスを作成します。

   $ dsc server:deploy --platform openshift

   Copy to Clipboard Toggle word wrap

検証手順

1. OpenShift Dev Spaces インスタンスのステータスを確認します。

   $ dsc server:status

   Copy to Clipboard Toggle word wrap

2. OpenShift Dev Spaces クラスターインスタンスに移動します。

   $ dsc dashboard:open

   Copy to Clipboard Toggle word wrap

手順

1. OpenShift Web コンソールの 管理者 ビューで、Operators → OperatorHub に移動し、Red Hat OpenShift Dev Spaces を検索します。

2. Red Hat OpenShift Dev Spaces Operator をインストールします。

   ヒント

   Web コンソールを使用した OperatorHub からのインストール を参照してください。

   Important

   Red Hat OpenShift Dev Spaces Operator は、Dev Workspace Operator に依存します。Red Hat OpenShift Dev Spaces Operator を手動でデフォルト以外の namespace にインストールする場合は、Dev Workspace Operator も同じ namespace にインストールされていることを確認してください。これは、Operator Lifecycle Manager が、Red Hat OpenShift Dev Spaces Operator namespace 内の依存関係として Dev Workspace Operator をインストールしようとすることから、Dev Spaces Operator が別の namespace にインストールされている場合は、Dev Workspace Operator は 2 つの競合するインストールとなる可能性があるため、確認が必要となります。

1. 次のように、OpenShift で openshift-devspaces プロジェクトを作成します。

   oc create namespace openshift-devspaces

   Copy to Clipboard Toggle word wrap
2. Operators → Installed Operators → Red Hat OpenShift Dev Spaces インスタンスの仕様 → Create CheCluster → YAML view に移動します。
3. YAML view で、namespace: openshift-operators を namespace: openshift-devspaces に置き換えます。

4. Create を選択します。

   ヒント

   インストールされた Operator からのアプリケーションの作成 を参照してください。

1. Red Hat OpenShift Dev Spaces インスタンスの仕様 で、devspaces に移動し、Details タブに移動します。

1. Message の下に None があることを確認します。これはエラーがないことを意味します。
2. Red Hat OpenShift Dev Spaces URL で、OpenShift Dev Spaces インスタンスの URL が表示されるまで待ち、URL を開いて OpenShift Dev Spaces ダッシュボードを確認します。
3. Resources タブで、OpenShift Dev Spaces デプロイメントのリソースとそのステータスを表示します。

手順

1. ミラーリングスクリプトをダウンロードして実行し、カスタム Operator カタログをインストールし、関連するイメージをミラーリングします (prepare-restricted-environment.sh)。

   $ bash prepare-restricted-environment.sh \
     --devworkspace_operator_index registry.redhat.io/redhat/redhat-operator-index:v4.16\
     --devworkspace_operator_version "v0.30.0" \
     --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.16" \
     --prod_operator_package_name "devspaces" \
     --prod_operator_bundle_name "devspacesoperator" \
     --prod_operator_version "v3.16.0" \
     --my_registry "<my_registry>" 

   1

   Copy to Clipboard Toggle word wrap

   1

   イメージがミラーリングされるプライベート Docker レジストリー

2. 前の手順で で che-operator-cr-patch.yaml に指定した設定で OpenShift Dev Spaces をインストールします。

   $ dsc server:deploy \
     --platform=openshift \
     --olm-channel stable \
     --catalog-source-name=devspaces-disconnected-install \
     --catalog-source-namespace=openshift-marketplace \
     --skip-devworkspace-operator \
     --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml

   Copy to Clipboard Toggle word wrap
3. OpenShift Dev Spaces namespace からユーザープロジェクト内のすべての Pod への受信トラフィックを許可します。「ネットワークポリシーの設定」 を参照してください。

検証

1. 設定されたプロパティーの値を確認します。

   $ oc get configmap che -o jsonpath='{.data.<configured_property>}' \
   -n openshift-devspaces

   Copy to Clipboard Toggle word wrap

手順

1. クラスター上の CheCluster カスタムリソースを編集します。

   $ oc edit checluster/devspaces -n openshift-devspaces

   Copy to Clipboard Toggle word wrap
2. ファイルを保存して閉じ、変更を適用します。

検証

1. 設定されたプロパティーの値を確認します。

   $ oc get configmap che -o jsonpath='{.data.<configured_property>}' \
   -n openshift-devspaces

   Copy to Clipboard Toggle word wrap

手順

1. CheCluster レベルでの自動 namespace プロビジョニングを無効にします。

   devEnvironments:
     defaultNamespace:
       autoProvision: false

   Copy to Clipboard Toggle word wrap

2. 次のラベルとアノテーションを使用して、<username> ユーザーの <project_name> プロジェクトを作成します。

   kind: Namespace
   apiVersion: v1
   metadata:
     name: <project_name> 

   1

   
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-namespace
     annotations:
       che.eclipse.org/username: <username>

   Copy to Clipboard Toggle word wrap

   1

   選択したプロジェクト名を使用します。

手順

1. ターゲットメトリクスと必要なレプリカ数を指定して、デプロイメント用の HPA リソースを作成します。

   apiVersion: autoscaling/v2
   kind: HorizontalPodAutoscaler
   metadata:
     name: scaler
     namespace: openshift-devspaces
   spec:
     scaleTargetRef:
       apiVersion: apps/v1
       kind: Deployment
       name: <deployment_name> 

   1

   
     ...

   Copy to Clipboard Toggle word wrap

   1

   <deployment_name> には、以下のデプロイメントのいずれかに対応します。

   • devspaces
   • che-gateway
   • devspaces-dashboard
   • plugin-registry
   • devfile-registry

手順

1. OpenShift Dev Spaces namespace の名前を取得します。デフォルトは openshift-devspaces です。

   $ oc get checluster --all-namespaces \
     -o=jsonpath="{.items[*].metadata.namespace}"

   Copy to Clipboard Toggle word wrap

2. maxNumberOfWorkspacesPerUser を設定します。

   $ oc patch checluster/devspaces -n openshift-devspaces \

   1

   
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfWorkspacesPerUser": <kept_workspaces_limit>}}}'

   2

   Copy to Clipboard Toggle word wrap

   1

   ステップ 1 で取得した OpenShift Dev Spaces namespace 。

   2

   <kept_workspaces_limit> の値を選択します。

手順

1. OpenShift Dev Spaces namespace の名前を取得します。デフォルトは openshift-devspaces です。

   $ oc get checluster --all-namespaces \
     -o=jsonpath="{.items[*].metadata.namespace}"

   Copy to Clipboard Toggle word wrap

2. maxNumberOfRunningWorkspacesPerUser を設定します。

   $ oc patch checluster/devspaces -n openshift-devspaces \

   1

   
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerUser": <running_workspaces_limit>}}}'

   2

   Copy to Clipboard Toggle word wrap

   1

   ステップ 1 で取得した OpenShift Dev Spaces namespace 。

   2

   <running_workspaces_limit> の値を選択します。

手順

1. Git サーバーの詳細情報を使用して新規の ConfigMap を作成します。

   $ oc create configmap che-git-self-signed-cert \
     --from-file=ca.crt=<path_to_certificate> \  

   1

   
     --from-literal=githost=<git_server_url> -n openshift-devspaces  

   2

   Copy to Clipboard Toggle word wrap

   1

   自己署名証明書へのパス。

   2

   Git サーバーの URL を指定するオプションのパラメーター (例: https://git.example.com:8443)。省略すると、自己署名証明書が HTTPS 経由のすべてのリポジトリーに使用されます。

   注記
   • 証明書ファイルは、通常、以下のような Base64 ASCII ファイルとして保存されます。.pem, .crt, .ca-bundle.証明書ファイルを保持するすべての ConfigMap はバイナリーデータ証明書ではなく Base64 ASCII 証明書を使用する必要があります。
   • 証明書の信頼チェーンが必要です。ca.crt が認証局 (CA) によって署名されている場合は、CA 証明書が ca.crt ファイルに含まれている必要があります。

2. 必要なラベルを ConfigMap に追加します。

   $ oc label configmap che-git-self-signed-cert \
     app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspaces

   Copy to Clipboard Toggle word wrap

3. Git リポジトリーに自己署名証明書を使用するように OpenShift Dev Spaces オペランドを設定します。「CLI を使用して CheCluster カスタムリソースの設定」 を参照してください。

   spec:
     devEnvironments:
       trustedCerts:
         gitTrustedCertsConfigMapName: che-git-self-signed-cert

   Copy to Clipboard Toggle word wrap

手順

1. NodeSelector の使用

   OpenShift Dev Spaces は、CheCluster カスタムリソースを使用して nodeSelector を設定します。

   spec:
     devEnvironments:
       nodeSelector:
         key: value

   Copy to Clipboard Toggle word wrap

   このセクションには、nodeSelector ルールを形成するために、各 ノードラベル の key=value ペアのセットが含まれている必要があります。

2. テイントおよび容認の使用

   これは nodeSelector とは逆の働きをします。Pod がスケジュールされるノードを指定する代わりに、Pod がスケジュールされないノードを指定します。詳細は、https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration を参照してください。

   OpenShift Dev Spaces は、CheCluster カスタムリソースを使用して tolerations を設定します。

   spec:
     devEnvironments:
       tolerations:
         - effect: NoSchedule
           key: key
           value: value
           operator: Equal

   Copy to Clipboard Toggle word wrap

手順

1. 以下の ConfigMap を作成して、すべてのユーザー namespace に複製します。設定可能性を高めるために、追加のラベルとアノテーションを追加して ConfigMap をカスタマイズできます。その他の可能なラベルとアノテーションについては、ボリューム、configmap、シークレットの自動マウント を参照してください。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: user-configmap
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
   data:
     ...

   Copy to Clipboard Toggle word wrap

   例3.16 ユーザーワークスペースに settings.xml ファイルをマウント

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: user-settings-xml
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.m2
   data:
     settings.xml: |
       <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
         <localRepository>/home/user/.m2/repository</localRepository>
         <interactiveMode>true</interactiveMode>
         <offline>false</offline>
       </settings>

   Copy to Clipboard Toggle word wrap

2. 以下の Secret を作成して、それをすべてのユーザー namespace に複製します。設定可能性を高めるために、追加のラベルとアノテーションを追加して Secret をカスタマイズできます。その他の可能なラベルとアノテーションについては、ボリューム、configmap、シークレットの自動マウント を参照してください。

   kind: Secret
   apiVersion: v1
   metadata:
     name: user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
   data:
     ...

   Copy to Clipboard Toggle word wrap

   例3.17 ユーザーワークスペースに証明書をマウントする

   kind: Secret
   apiVersion: v1
   metadata:
     name: user-certificates
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /etc/pki/ca-trust/source/anchors
   stringData:
     trusted-certificates.crt: |
       ...

   Copy to Clipboard Toggle word wrap

   注記

   ワークスペースの起動時に update-ca-trust コマンドを実行して証明書をインポートします。これは手動で実行することも、devfile の postStart イベントにこのコマンドを追加することで実行することもできます。devfile でのイベントバインディングの追加 を参照してください。

   例3.18 環境変数をユーザーワークスペースにマウントする

   kind: Secret
   apiVersion: v1
   metadata:
     name: user-env
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: env
   stringData:
     ENV_VAR_1: value_1
     ENV_VAR_2: value_2

   Copy to Clipboard Toggle word wrap

3. 以下の PersistentVolumeClaim を作成して、それをすべてのユーザー namespace に複製します。

   設定可能性を高めるために、追加のラベルとアノテーションを追加して PersistentVolumeClaim をカスタマイズできます。その他の可能なラベルとアノテーションについては、ボリューム、configmap、シークレットの自動マウント を参照してください。

   'PersistentVolumeClaim' を変更するには、一度削除し、openshift-devspaces namespace に新しいものを作成します。

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
   spec:
     ...

   Copy to Clipboard Toggle word wrap

   例3.19 PersistentVolumeClaim をユーザーワークスペースにマウント

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/mount-to-devworkspace: 'true'
     annotations:
       controller.devfile.io/mount-path: /home/user/data
       controller.devfile.io/read-only: 'true'
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 5Gi
     volumeMode: Filesystem

   Copy to Clipboard Toggle word wrap

手順

1. リンクに移動して、プルする関連コンテナーイメージのリストを収集します。

   • https://<openshift_dev_spaces_fqdn>/plugin-registry/v3/external_images.txt
   • https://<openshift_dev_spaces_fqdn>/devfile-registry/devfiles/external_images.txt

2. メモリー要求および制限パラメーターを定義して、コンテナーをプルし、プラットフォームに実行するのに十分なメモリーがあることを確認します。

   CACHING_MEMORY_REQUEST または CACHING_MEMORY_LIMIT の最小値を定義する場合は、プルする各コンテナーイメージの実行に必要なメモリー容量を考慮してください。

   CACHING_MEMORY_REQUEST または CACHING_MEMORY_LIMIT の最大値を定義する場合は、クラスターの DaemonSet Pod に割り当てられるメモリーの合計を考慮します。

   (memory limit) * (number of images) * (number of nodes in the cluster)

   Copy to Clipboard Toggle word wrap

   コンテナーのメモリー制限が 20Mi の 20 ノードで 5 つのイメージをプルする場合、2000Mi のメモリーが必要です。

3. Image Puller リポジトリーのクローンを作成し、OpenShift テンプレートが含まれるディレクトリーを取得します。

   $ git clone https://github.com/che-incubator/kubernetes-image-puller
   $ cd kubernetes-image-puller/deploy/openshift

   Copy to Clipboard Toggle word wrap

4. 以下のパラメーターを使用して、app.yaml、configmap.yaml および serviceaccount.yaml OpenShift テンプレートを設定します。

   Expand

   表3.37 app.yaml の Image Puller OpenShift テンプレートパラメーター

   値	使用方法	デフォルト
   DEPLOYMENT_NAME	ConfigMap の DEPLOYMENT_NAME の値	kubernetes-image-puller
   IMAGE	kubernetes-image-puller デプロイメントに使用されるイメージ	registry.redhat.io/devspaces/imagepuller-rhel8
   IMAGE_TAG	プルするイメージタグ	latest
   SERVICEACCOUNT_NAME	デプロイメントで作成され、使用される ServiceAccount の名前	kubernetes-image-puller

   Show more
   Expand

   表3.38 configmap.yaml の Image Puller OpenShift テンプレートパラメーター

   値	使用方法	デフォルト
   CACHING_CPU_LIMIT	ConfigMap の CACHING_CPU_LIMIT の値	.2
   CACHING_CPU_REQUEST	ConfigMap の CACHING_CPU_REQUEST の値	.05
   CACHING_INTERVAL_HOURS	ConfigMap の CACHING_INTERVAL_HOURS の値	"1"
   CACHING_MEMORY_LIMIT	ConfigMap の CACHING_MEMORY_LIMIT の値	"20Mi"
   CACHING_MEMORY_REQUEST	ConfigMap の CACHING_MEMORY_REQUEST の値	"10Mi"
   DAEMONSET_NAME	ConfigMap の DAEMONSET_NAME の値	kubernetes-image-puller
   DEPLOYMENT_NAME	ConfigMap の DEPLOYMENT_NAME の値	kubernetes-image-puller
   IMAGES	ConfigMap の IMAGES の値	{}
   NAMESPACE	ConfigMap の NAMESPACE の値	k8s-image-puller
   NODE_SELECTOR	ConfigMap の NODE_SELECTOR の値	"{}"

   Show more
   Expand

   表3.39 serviceaccount.yaml の Image Puller OpenShift テンプレートパラメーター

   値	使用方法	デフォルト
   SERVICEACCOUNT_NAME	デプロイメントで作成され、使用される ServiceAccount の名前	kubernetes-image-puller
   KIP_IMAGE	スリープバイナリーのコピー元である Image Puller イメージ	registry.redhat.io/devspaces/imagepuller-rhel8:latest

   Show more

5. Image Puller をホストする OpenShift プロジェクトを作成します。

   $ oc new-project <k8s-image-puller>

   Copy to Clipboard Toggle word wrap

6. テンプレートを処理してから適用し、Puller をインストールします。

   $ oc process -f serviceaccount.yaml | oc apply -f -
   $ oc process -f configmap.yaml | oc apply -f -
   $ oc process -f app.yaml | oc apply -f -

   Copy to Clipboard Toggle word wrap

検証手順

1. <kubernetes-image-puller> デプロイメントおよび <kubernetes-image-puller> DaemonSet があることを確認します。DaemonSet では、クラスター内の各ノードに Pod が必要です。

   $ oc get deployment,daemonset,pod --namespace <k8s-image-puller>

   Copy to Clipboard Toggle word wrap

2. <kubernetes-image-puller> ConfigMap の値を確認します。

   $ oc get configmap <kubernetes-image-puller> --output yaml

   Copy to Clipboard Toggle word wrap

手順

1. コミュニティーでサポートされている Kubernetes Image Puller Operator をインストールします。Web コンソールを使用した OperatorHub からのインストール を参照してください。
2. コミュニティーでサポートされている Kubernetes Image Puller Operator から KubernetesImagePuller オペランドを作成します。インストールされた Operator からのアプリケーションの作成 を参照してください。

手順

1. OpenShift Dev Spaces イメージを事前にプルするように Image Puller を設定します。

   oc patch checluster/devspaces \
       --namespace openshift-devspaces \
       --type='merge' \
       --patch '{
                 "spec": {
                   "components": {
                     "imagePuller": {
                       "enable": true
                     }
                   }
                 }
               }'

   Copy to Clipboard Toggle word wrap

手順

1. カスタムイメージを事前にプルするように Image Puller を設定します。

   oc patch checluster/devspaces \
       --namespace openshift-devspaces \
       --type='merge' \
       --patch '{
                 "spec": {
                   "components": {
                     "imagePuller": {
                       "enable": true,
                       "spec": {
                         "images": "NAME-1=IMAGE-1;NAME-2=IMAGE-2" 

   1

   
                       }
                     }
                   }
                 }
               }'

   Copy to Clipboard Toggle word wrap

   1

   セミコロンで区切られたイメージのリスト