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 提供实际值。它们用于构建编辑器 id 以及编辑器名称，格式为 publisher/name/version。

   您可以在下面找到支持的值，包括可选的值：

   # 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 Dashboard 页面，以查看新的可用编辑器。

流程

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 的格式应为： 发布者/名称/版本。请参阅第一步中的可用的编辑器 ID。

流程

1. 查找部署 OpenShift Dev Spaces Operator 的命名空间：

   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. 选择要 conceal 的编辑器定义。例如，要整合 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 订阅名称和命名空间（如果存在）：

   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. 创建 Secret：

   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 的推出完成。