Troubleshooting deployment of Wazi for Dev Spaces

If you already installed the Operator into a project and created an instance, follow the steps below to troubleshoot the instance creation.

1. Log into your OpenShift web console

2. Expand the Home menu on the left and click Projects

3. Click on the project name where you deployed Wazi for Dev Spaces

4. Expand Workloads menu on the left and click Deployments

5. You should see a list of at least six deployments

   • codeready

   • devfile-registry

   • keycloak

   • plugin-registry

   • postgres

   • wazi-codeready-operator

6. You can click on each deployment and it will take you to the Deployment Details page.

7. On the Deployment Details page, click Events. This tab contains useful information including error events.

Each deployment has at least one pod. You can check logs for each pod in the web console as follows.

1. Log into your OpenShift web console

2. Expand the Home menu on the left and click Projects

3. Click on the project name where you deployed Wazi for Dev Spaces

4. Expand Workloads menu on the left and click Pods

   Here you will see at least six pods, with a pod corresponding to each deployment. A new pod will be added for each workspace a user creates. You can troubleshoot workspace creation by looking at workspace pod logs.

5. Click on any pod you want to examine. This will take you to the Pod Details page.

6. On the Pod Details page, view the Logs or Events tab to help you troubleshoot.

1. The postgres-data volume cannot be bounded and is waiting for the administrator to bound volume with registry-storage.

   • You might run into this issue if you have not set up the dynamic provisioning of the storage class on your cluster. To set up dynamic provisioning of storage class on your cluster, see StorageClass annotations.

   Then, verify there is a default storage class by using the following command:

   oc get sc

   Note: The word default will be listed after one of the storage classes listed.

   If there is no default storage class set, then set one by using the following command:

   oc patch sc <name of a storage class> -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "true"}}}'

2. Failed to pull image "docker.io/ibmcom/wazi-code-plugin": rpc error: code = Unknown desc= Error reading manifest : invalid status code from registry 500 (Bad Request), Error: ErrImagePull

   • While creating workspaces, you might come across unknown issues due to not having the image available on docker.io. In that case, we suggest you create an issue in the Wazi for Dev Spaces GitHub repository.

3. Failed to pull image "docker.io/ibmcom/wazi-code-dev-file": rpc error: code = Unknown desc= Error reading manifest : invalid status code from registry 500 (Bad Request), Error: ErrImagePull

   • While creating workspaces, you might come across unknown issues due to not having the image available on docker.io. In that case, we suggest you create an issue in the Wazi for Dev Spaces GitHub repository.

Working with a cluster sometimes requires a bit more patience waiting for deployment jobs to complete. Sometimes timeouts or other errors happen because of internet issues. Here are some common issues that you might run into and suggestions for how to solve them.

1. Failed. The specified namespace iam#username@gmail.com-codeready is invalid: a DNS-1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name', or '123-abc', reged used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')

   • IBM Wazi for Dev Spaces is built on top of Red Hat® CodeReady Workspaces. CodeReady Workspaces has limitations for username, which must consist of lowercase alphanumeric characters or -, and must start and end with an alphanumeric character. Therefore, while creating an account at the first-time login, make sure to follow username rules.

2. Failed to start workspace

   • Sometimes this error occurs when the workspace pod is not assigned to the project. Press F5 or click the refresh link that appears on the screen.

3. Error: Failed to run the workspace: "Workspace is going to be STOPPED. Reason: Workspace is not started in time. Trying interrupt runtime start"

   • Storage must be configured on the cluster during the workspace creation. To configure storage, follow this documentation. IBM Wazi for Dev Spaces claims a persistent volume to the cluster. OpenShift cluster on IBM Cloud® has the capability to provision storages dynamically when a project claims for the persistent volume. Depending on the IBM Cloud traffic, it spends a good amount of time to approve your claim and assign a storage to your workspace pod. You can refresh or press F5 to start over again.

4. Unable to create persistent volume on workspace pod

   • Storage must be configured on the cluster during the workspace creation. To configure storage, follow this documentation. IBM Wazi for Dev Spaces claims a persistent volume to the cluster. Your cluster might not have been configured for dynamic storage allocation. You need to create your workspace in an ephemeral mode. Ephemeral mode is a function that allows users to browse the web on a shared device or a personal laptop by using a profile that will not save any data or history after the browser is closed. Stop the workspace first, and take the following steps:

     1. Go to the Workspaces tab

     2. Click the middle configuration icon on the right side under the ACTIONS tab to open Workspace Configuration

     3. Open the Overview tab

     4. Turn on Ephemeral Mode and save and run your workspace again

5. Error: Failed to run the workspace: "Unrecoverable event occured: 'Failed', 'Failed to pull image "docker.io/ibmcom/wazi-code-codeready": rpc error: code = Unknown desc = Error reading manifest * in docker.io/ibmcom/wazi-code-codeready: manifest unknown: manifest unknown', 'workspace*.wazi-*-*'"

   • While creating workspaces, you might come across unknown issues due to not having the image available on docker.io. In that case, we suggest you create an issue in the Wazi CodeReady WorkSpaces GitHub repository.

Should you need to engage IBM Technical Support, refer to the Gathering Logs of Wazi page about how to collect the necessary information and send it to IBM Support.

We would love to hear what you think of this solution. For any questions, issues, or enhancement ideas, you can open an issue in the Wazi CodeReady WorkSpaces GitHub repository.

We are always looking for ways to improve.