Chapter 8. Web terminal

Procedure

1. To launch the web terminal, click the command line terminal icon ( ) in the masthead of the console. A web terminal instance is displayed in the Command line terminal pane. This instance is automatically logged in with your credentials.

2. Select the project where the DevWorkspace CR must be created from the Project drop-down list. By default, the current project is selected.

   Note
   • The DevWorkspace CR is created only if it does not already exist.
   • The openshift-terminal project is the default project used for cluster administrators. They do not have the option to choose another project.
3. Click Start to initialize the web terminal using the selected project. After the web terminal is initialized, you can use the preinstalled CLI tools like oc, kubectl, odo, kn, tkn, helm, kubens, subctl, and kubectx in the web terminal.

Procedure

1. In the Administrator perspective of the web console, navigate to Operators Installed Operators.
2. Scroll the filter list or type a keyword into the Filter by name box to find the Web Terminal Operator.
3. Click the Options menu for the Web Terminal Operator, and then select Uninstall Operator.
4. In the Uninstall Operator confirmation dialog box, click Uninstall to remove the Operator, Operator deployments, and pods from the cluster. The Operator stops running and no longer receives updates.

5. Remove the custom resources:

   $ oc delete devworkspaces.workspace.devfile.io --all-namespaces \
       --selector 'console.openshift.io/terminal=true' --wait

   $ oc delete devworkspacetemplates.workspace.devfile.io --all-namespaces \
       --selector 'console.openshift.io/terminal=true' --wait

Procedure

1. Remove the DevWorkspace custom resources used by the Operator, along with any related Kubernetes objects:

   $ oc delete devworkspaces.workspace.devfile.io --all-namespaces --all --wait

   $ oc delete devworkspaceroutings.controller.devfile.io --all-namespaces --all --wait

   Warning

   If this step is not complete, finalizers make it difficult to fully uninstall the Operator.

2. Remove the CRDs used by the Operator:

   Warning

   The DevWorkspace Operator provides custom resource definitions (CRDs) that use conversion webhooks. Failing to remove these CRDs can cause issues in the cluster.

   $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceroutings.controller.devfile.io

   $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaces.workspace.devfile.io

   $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspacetemplates.workspace.devfile.io

   $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceoperatorconfigs.controller.devfile.io

3. Verify that all involved custom resource definitions are removed. The following command should not display any output:

   $ oc get customresourcedefinitions.apiextensions.k8s.io | grep "devfile.io"

4. Remove the devworkspace-webhook-server deployment, mutating, and validating webhooks:

   $ oc delete deployment/devworkspace-webhook-server -n openshift-operators

   $ oc delete mutatingwebhookconfigurations controller.devfile.io

   $ oc delete validatingwebhookconfigurations controller.devfile.io

   Note

   If you remove the devworkspace-webhook-server deployment without removing the mutating and validating webhooks, you can not use oc exec commands to run commands in a container in the cluster. After you remove the webhooks you can use the oc exec commands again.

5. Remove any remaining services, secrets, and config maps. Depending on the installation, some resources included in the following commands may not exist in the cluster.

   $ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server -n openshift-operators

   $ oc delete serviceaccounts devworkspace-webhook-server -n openshift-operators

   $ oc delete clusterrole devworkspace-webhook-server

   $ oc delete clusterrolebinding devworkspace-webhook-server

6. Uninstall the DevWorkspace Operator:

   1. In the Administrator perspective of the web console, navigate to Operators Installed Operators.
   2. Scroll the filter list or type a keyword into the Filter by name box to find the DevWorkspace Operator.
   3. Click the Options menu for the Operator, and then select Uninstall Operator.
   4. In the Uninstall Operator confirmation dialog box, click Uninstall to remove the Operator, Operator deployments, and pods from the cluster. The Operator stops running and no longer receives updates.