4.10. ダッシュボードの設定

手順

1. サンプル設定で JSON ファイルを作成します。ファイルにはオブジェクトの配列が含まれている必要があります。各オブジェクトはサンプルを表します。

   cat > my-samples.json <<EOF
   [
     {
       "displayName": "<display_name>", 

   1

   
       "description": "<description>", 

   2

   
       "tags": <tags>, 

   3

   
       "url": "<url>", 

   4

   
       "icon": {
         "base64data": "<base64data>", 

   5

   
         "mediatype": "<mediatype>" 

   6

   
       }
     }
   ]
   EOF

   Copy to Clipboard Toggle word wrap

   1

   サンプルの表示名。

   2

   サンプルの説明。

   3

   タグの JSON 配列 (例: ["java", "spring"])。

   4

   devfile を含むリポジトリーへの URL。

   5

   アイコンの base64 でエンコードされたデータ。

   6

   アイコンのメディアタイプ。たとえば image/png。

2. サンプル設定で ConfigMap を作成します。

   oc create configmap getting-started-samples --from-file=my-samples.json -n openshift-devspaces

   Copy to Clipboard Toggle word wrap

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

   oc label configmap getting-started-samples app.kubernetes.io/part-of=che.eclipse.org app.kubernetes.io/component=getting-started-samples -n openshift-devspaces

   Copy to Clipboard Toggle word wrap
4. OpenShift Dev Spaces Dashboard ページを更新して、新しいサンプルを表示します。

手順

1. エディター定義設定で my-editor-definition-devfile.yaml YAML ファイルを作成します。

   重要

   metadata.attributes の publisher および version の実際の値を指定してください。これらは、publisher/name/version 形式のエディター名とともにエディター ID を構築するために使用されます。

   以下に、オプションの値も含め、サポートされている値を示します。

   # Version of the devile schema
   schemaVersion: 2.2.2
   # Meta information of the editor
   metadata:
     # (MANDATORY) The editor name
     # Must consist of lower case alphanumeric characters, '-' or '.'
     name: editor-name
     displayName: Display Name
     description: Run Editor Foo on top of Eclipse Che
     # (OPTIONAL) Array of tags of the current editor. The Tech-Preview tag means the option is considered experimental and is not recommended for production environments. While it can include new features and improvements, it may still contain bugs or undergo significant changes before reaching a stable version.
     tags:
       - Tech-Preview
     # Additional attributes
     attributes:
       title: This is my editor
       # (MANDATORY) The publisher name
       publisher: publisher
       # (MANDATORY) The editor version
       version: version
       repository: https://github.com/editor/repository/
       firstPublicationDate: '2024-01-01'
       iconMediatype: image/svg+xml
       iconData: |
         <icon-content>
   # List of editor components
   components:
     # Name of the component
     - name: che-code-injector
       # Configuration of devworkspace-related container
       container:
         # Image of the container
         image: 'quay.io/che-incubator/che-code:insiders'
         # The command to run in the dockerimage component instead of the default one provided in the image
         command:
           - /entrypoint-init-container.sh
         # (OPTIONAL) List of volumes mounts that should be mounted in this container
         volumeMounts:
             # The name of the mount
           - name: checode
             # The path of the mount
             path: /checode
         # (OPTIONAL) The memory limit of the container
         memoryLimit: 256Mi
         # (OPTIONAL) The memory request of the container
         memoryRequest: 32Mi
         # (OPTIONAL) The CPU limit of the container
         cpuLimit: 500m
         # (OPTIONAL) The CPU request of the container
         cpuRequest: 30m
     # Name of the component
     - name: che-code-runtime-description
       # (OPTIONAL) Map of implementation-dependant free-form YAML attributes
       attributes:
         # The component within the architecture
         app.kubernetes.io/component: che-code-runtime
         # The name of a higher level application this one is part of
         app.kubernetes.io/part-of: che-code.eclipse.org
         # Defines a container component as a "container contribution". If a flattened DevWorkspace has a container component with the merge-contribution attribute, then any container contributions are merged into that container component
         controller.devfile.io/container-contribution: true
       container:
         # Can be a dummy image because the component is expected to be injected into workspace dev component
         image: quay.io/devfile/universal-developer-image:latest
         # (OPTIONAL) List of volume mounts that should be mounted in this container
         volumeMounts:
             # The name of the mount
           - name: checode
             # (OPTIONAL) The path in the component container where the volume should be mounted. If no path is defined, the default path is the is /<name>
             path: /checode
         # (OPTIONAL) The memory limit of the container
         memoryLimit: 1024Mi
         # (OPTIONAL) The memory request of the container
         memoryRequest: 256Mi
         # (OPTIONAL) The CPU limit of the container
         cpuLimit: 500m
         # (OPTIONAL) The CPU request of the container
         cpuRequest: 30m
         # (OPTIONAL) Environment variables used in this container
         env:
           - name: ENV_NAME
             value: value
         # Component endpoints
         endpoints:
           # Name of the editor
           - name: che-code
             # (OPTIONAL) Map of implementation-dependant string-based free-form attributes
             attributes:
               # Type of the endpoint. You can only set its value to main, indicating that the endpoint should be used as the mainUrl in the workspace status (i.e. it should be the URL used to access the editor in this context)
               type: main
               # An attribute that instructs the service to automatically redirect the unauthenticated requests for current user authentication. Setting this attribute to true has security consequences because it makes Cross-site request forgery (CSRF) attacks possible. The default value of the attribute is false.
               cookiesAuthEnabled: true
               # Defines an endpoint as "discoverable", meaning that a service should be created using the endpoint name (i.e. instead of generating a service name for all endpoints, this endpoint should be statically accessible)
               discoverable: false
               # Used to secure the endpoint with authorization on OpenShift, so that not anyone on the cluster can access the endpoint, the attribute enables authentication.
               urlRewriteSupported: true
             # Port number to be used within the container component
             targetPort: 3100
             # (OPTIONAL) Describes how the endpoint should be exposed on the network (public, internal, none)
             exposure: public
             # (OPTIONAL) Describes whether the endpoint should be secured and protected by some authentication process
             secure: true
             # (OPTIONAL) Describes the application and transport protocols of the traffic that will go through this endpoint
             protocol: https
       # Mandatory name that allows referencing the component from other elements
     - name: checode
       # (OPTIONAL) Allows specifying the definition of a volume shared by several other components. Ephemeral volumes are not stored persistently across restarts. Defaults to false
       volume: {ephemeral: true}
   # (OPTIONAL) Bindings of commands to events. Each command is referred-to by its name
   events:
     # IDs of commands that should be executed before the devworkspace start. These commands would typically be executed in an init container
     preStart:
       - init-container-command
     # IDs of commands that should be executed after the devworkspace has completely started. In the case of Che-Code, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE within the browser
     postStart:
       - init-che-code-command
   # (OPTIONAL) Predefined, ready-to-use, devworkspace-related commands
   commands:
       # Mandatory identifier that allows referencing this command
     - id: init-container-command
       apply:
         # Describes the component for the apply command
         component: che-code-injector
       # Mandatory identifier that allows referencing this command
     - id: init-che-code-command
       # CLI Command executed in an existing component container
       exec:
         # Describes component for the exec command
         component: che-code-runtime-description
         # The actual command-line string
         commandLine: 'nohup /checode/entrypoint-volume.sh > /checode/entrypoint-logs.txt
           2>&1 &'

   Copy to Clipboard Toggle word wrap

2. エディター定義コンテンツを使用して ConfigMap を作成します。

   oc create configmap my-editor-definition --from-file=my-editor-definition-devfile.yaml -n openshift-devspaces

   Copy to Clipboard Toggle word wrap

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

   oc label configmap my-editor-definition app.kubernetes.io/part-of=che.eclipse.org app.kubernetes.io/component=editor-definition -n openshift-devspaces

   Copy to Clipboard Toggle word wrap
4. OpenShift Dev Spaces ダッシュボードページを更新して、新しい利用可能なエディターを確認します。

手順

1. 利用可能なエディターの ID を確認します。

   oc exec deploy/devspaces-dashboard -n openshift-devspaces  \
       -- curl -s http://localhost:8080/dashboard/api/editors | jq -r '.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"'

   Copy to Clipboard Toggle word wrap

2. defaultEditor を設定します。

   oc patch checluster/devspaces \
       --namespace openshift-devspaces \
       --type='merge' \
       -p '{"spec":{"devEnvironments":{"defaultEditor": "<default_editor>"}}}'

   1

   Copy to Clipboard Toggle word wrap

   1

   ワークスペースを作成するためのデフォルトのエディターは、プラグイン ID または URI を使用して指定できます。プラグイン ID は publisher/name/version の形式に従う必要があります。最初の手順で使用可能なエディター ID を参照してください。

手順

1. OpenShift Dev Spaces Operator がデプロイされている namespace を見つけます。

   OPERATOR_NAMESPACE=$(oc get pods -l app.kubernetes.io/component=devspaces-operator -o jsonpath={".items[0].metadata.namespace"} --all-namespaces)

   Copy to Clipboard Toggle word wrap

2. 利用可能なエディター定義ファイルを確認します。

   oc exec -n $OPERATOR_NAMESPACE deploy/devspaces-operator -- ls /tmp/editors-definitions

   Copy to Clipboard Toggle word wrap

   出力は以下の例のようになります。

   che-code-insiders.yaml
   che-code-latest.yaml
   che-idea-latest.yaml
   che-idea-next.yaml

   Copy to Clipboard Toggle word wrap

3. 非表示にするエディター定義を選択します。たとえば、che-idea-next.yaml エディターの定義を非表示にするには、エディター定義ファイル名を設定します。

   CHE_EDITOR_CONCEAL_FILE_NAME=che-idea-next.yaml

   Copy to Clipboard Toggle word wrap

4. 非表示にするエディター定義の ConfigMap 名を定義します。

   CHE_EDITOR_CONCEAL_CONFIGMAP_NAME=che-conceal-$CHE_EDITOR_CONCEAL_FILE_NAME

   Copy to Clipboard Toggle word wrap

5. ConfigMap を作成します。

   oc create configmap $CHE_EDITOR_CONCEAL_CONFIGMAP_NAME \
       --namespace $OPERATOR_NAMESPACE \
       --from-literal=$CHE_EDITOR_CONCEAL_FILE_NAME=""

   Copy to Clipboard Toggle word wrap

6. Operator サブスクリプション名と namespace (存在する場合) を確認します。

   SUBSCRIPTION=$(oc get subscriptions \
       --all-namespaces \
       --output json \
           | jq -r '.items[] | select(.spec.name=="devspaces")')
   SUBSCRIPTION_NAMESPACE=$(echo $SUBSCRIPTION | jq -r '.metadata.namespace')
   SUBSCRIPTION_NAME=$(echo $SUBSCRIPTION | jq -r '.metadata.name')

   Copy to Clipboard Toggle word wrap

7. 空のエディター定義を使用して Kubernetes リソースにパッチを適用し、ConfigMap をマウントします。パッチを適用するリソースは、Operator サブスクリプションの存在によって異なります。サブスクリプションが存在する場合は、サブスクリプションにパッチを適用する必要があります。サブスクリプションが存在しない場合は、Operator デプロイメントにパッチを適用します。

   if [[ -n $SUBSCRIPTION_NAMESPACE ]]; then
       if [[ $(oc get subscription $SUBSCRIPTION_NAME --namespace $SUBSCRIPTION_NAMESPACE --output jsonpath='{.spec.config}') == "" ]]; then
           oc patch subscription $SUBSCRIPTION_NAME \
             --namespace $SUBSCRIPTION_NAMESPACE \
             --type json \
             --patch '[{
                   "op":"add",
                   "path":"/spec/config",
                   "value": {}
               }]'
       fi
   
       if [[ $(oc get subscription $SUBSCRIPTION_NAME --namespace $SUBSCRIPTION_NAMESPACE --output jsonpath='{.spec.config.volumes}') == "" ]]; then
           oc patch subscription $SUBSCRIPTION_NAME \
             --namespace $SUBSCRIPTION_NAMESPACE \
             --type json \
             --patch '[{
                   "op":"add",
                   "path":"/spec/config/volumes",
                   "value": []
               }]'
       fi
   
       if [[ $(oc get subscription $SUBSCRIPTION_NAME --namespace $SUBSCRIPTION_NAMESPACE --output jsonpath='{.spec.config.volumeMounts}') == "" ]]; then
           oc patch subscription $SUBSCRIPTION_NAME \
             --namespace $SUBSCRIPTION_NAMESPACE \
             --type json \
             --patch '[{
                   "op":"add",
                   "path":"/spec/config/volumeMounts",
                   "value": []
               }]'
       fi
   
       oc patch subscription $SUBSCRIPTION_NAME \
         --namespace $SUBSCRIPTION_NAMESPACE \
         --type json \
         --patch '[{
           "op":"add",
           "path":"/spec/config/volumes/-",
           "value": {
               "name":"'$(echo ${CHE_EDITOR_CONCEAL_FILE_NAME%.*})'",
               "configMap": {
                   "name": "'$CHE_EDITOR_CONCEAL_CONFIGMAP_NAME'"
               }
           }
         },
         {
           "op":"add",
           "path":"/spec/config/volumeMounts/-",
           "value":{
               "name": "'$(echo ${CHE_EDITOR_CONCEAL_FILE_NAME%.*})'",
               "subPath":"'$CHE_EDITOR_CONCEAL_FILE_NAME'",
               "mountPath": "/tmp/editors-definitions/'$CHE_EDITOR_CONCEAL_FILE_NAME'"
           }
         }]'
   else
       oc patch deployment devspaces-operator \
         --namespace $OPERATOR_NAMESPACE \
         --type json \
         --patch '[{
           "op":"add",
           "path":"/spec/template/spec/volumes/-",
           "value": {
               "name":"'$(echo ${CHE_EDITOR_CONCEAL_FILE_NAME%.*})'",
               "configMap": {
                   "name": "'$CHE_EDITOR_CONCEAL_CONFIGMAP_NAME'"
               }
           }
       },
       {
           "op":"add",
           "path":"/spec/template/spec/containers/0/volumeMounts/-",
           "value":{
               "name": "'$(echo ${CHE_EDITOR_CONCEAL_FILE_NAME%.*})'",
               "subPath":"'$CHE_EDITOR_CONCEAL_FILE_NAME'",
               "mountPath": "/tmp/editors-definitions/'$CHE_EDITOR_CONCEAL_FILE_NAME'"
           }
       }
   ]'
   fi

   Copy to Clipboard Toggle word wrap

手順

1. シークレットを作成します。

   oc apply -f - <<EOF
   apiVersion: v1
   kind: Secret
   metadata:
     name: devspaces-dashboard-customization
     namespace: openshift-devspaces
     annotations:
       che.eclipse.org/mount-as: subpath
       che.eclipse.org/mount-path: /public/dashboard/assets/branding
     labels:
       app.kubernetes.io/component: devspaces-dashboard-secret
       app.kubernetes.io/part-of: che.eclipse.org
   data:
     loader.svg: <Base64_encoded_content_of_the_image> 

   1

   
   type: Opaque
   EOF

   Copy to Clipboard Toggle word wrap

   1

   行の折り返しが無効になっている Base64 エンコーディング。

2. devspaces-dashboard のロールアウトが完了するまで待ちます。