Chapter 9. Configure workspaces globally

Procedure

1. Get the name of the OpenShift Dev Spaces namespace. The default is openshift-devspaces.

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

2. Configure the maxNumberOfWorkspacesPerUser in the CheCluster Custom Resource:

   spec:
     devEnvironments:
       maxNumberOfWorkspacesPerUser: <kept_workspaces_limit>

   where:

   <kept_workspaces_limit>

   The maximum number of workspaces per user. The default value, -1, allows users to keep an unlimited number of workspaces. Use a positive integer to set the maximum number of workspaces per user.

3. Apply the change:

   $ oc patch checluster/devspaces -n openshift-devspaces \
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfWorkspacesPerUser": <kept_workspaces_limit>}}}'

   where:

   -n

   The OpenShift Dev Spaces namespace that you got in step 1.

Procedure

1. Configure the maxNumberOfRunningWorkspacesPerCluster in the CheCluster Custom Resource:

   spec:
     devEnvironments:
       maxNumberOfRunningWorkspacesPerCluster: <running_workspaces_limit>

   where:

   <running_workspaces_limit>

   The maximum number of concurrently running workspaces across the entire Kubernetes cluster. This applies to all users in the system. The -1 value means there is no limit on the number of running workspaces.

2. Apply the change:

   $ oc patch checluster/devspaces -n openshift-devspaces \
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerCluster": <running_workspaces_limit>}}}'

Procedure

1. Get the name of the OpenShift Dev Spaces namespace. The default is openshift-devspaces.

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

2. Configure the maxNumberOfRunningWorkspacesPerUser in the CheCluster Custom Resource:

   spec:
     devEnvironments:
       maxNumberOfRunningWorkspacesPerUser: <running_workspaces_limit>

   where:

   <running_workspaces_limit>

   The maximum number of simultaneously running workspaces per user. The -1 value enables users to run an unlimited number of workspaces. The default value is 1.

3. Apply the change:

   $ oc patch checluster/devspaces -n openshift-devspaces \
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerUser": <running_workspaces_limit>}}}'

   where:

   -n

   The OpenShift Dev Spaces namespace that you got in step 1.

Procedure

1. Create a new ConfigMap with details about the Git server:

   $ oc create configmap che-git-self-signed-cert \
     --from-file=ca.crt=<path_to_certificate> \
     --from-literal=githost=<git_server_url> -n openshift-devspaces

   where:

   --from-file

   Path to the self-signed certificate.

   --from-literal

   Optional parameter to specify the Git server URL for example https://git.example.com:8443. When omitted, the self-signed certificate is used for all repositories over HTTPS.

   Note

   • Certificate files are typically stored as Base64 ASCII files, such as. .pem, .crt, .ca-bundle. All ConfigMaps that hold certificate files should use the Base64 ASCII certificate rather than the binary data certificate.
   • A certificate chain of trust is required. If the ca.crt is signed by a certificate authority (CA), the CA certificate must be included in the ca.crt file.

2. Add the required labels to the ConfigMap:

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

3. Configure OpenShift Dev Spaces operand to use self-signed certificates for Git repositories. See Section 5.3, “Use the CLI to configure the CheCluster Custom Resource”.

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

Procedure

1. Set nodeSelector in the CheCluster Custom Resource to schedule workspace Pods on specific nodes:

   spec:
     devEnvironments:
       nodeSelector:
         <key>: <value>

   This section must contain a set of key=value pairs for each node label to form the nodeSelector rule.

2. Set tolerations in the CheCluster Custom Resource to allow workspace Pods to be scheduled on tainted nodes. Tolerations work in the opposite way to nodeSelector. Instead of specifying which nodes the Pod is scheduled on, you specify which nodes the Pod cannot be scheduled on.

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

   Important

   nodeSelector must be configured during OpenShift Dev Spaces installation. This prevents existing workspaces from failing to run due to volumes affinity conflict caused by existing workspace PVC and Pod being scheduled in different zones.

   On large, multizone clusters, Pods and PVCs can be scheduled in different zones. To avoid this, create an additional StorageClass object (pay attention to the allowedTopologies field) to coordinate the PVC creation process.

   Pass the name of this newly created StorageClass to OpenShift Dev Spaces through the CheCluster Custom Resource. For more information, see: Section 13.2, “Configure storage classes”.

Procedure

1. Patch the CheCluster Custom Resource to configure the allowed source URLs:

   oc patch checluster/devspaces \
       --namespace openshift-devspaces \
       --type='merge' \
       -p \
   '{
      "spec": {
        "devEnvironments": {
          "allowedSources": {
            "urls": ["<url_1>", "<url_2>"]
          }
        }
      }
    }'

   where:

   urls

   The array of approved URLs for starting CDEs. Wildcards * are supported. For example, https://example.com/\* allows CDEs from any path within example.com.

Procedure

1. Configure the CheCluster custom resource to enable container run capabilities:

   oc patch checluster/devspaces -n openshift-devspaces \
     --type='merge' -p \
     '{"spec":{"devEnvironments":{"disableContainerRunCapabilities":false}}}'