Check out what's in the latest release of Kabanero Learn More

Installing Codewind in CodeReady Workspaces

Eclipse Codewind enables you to develop microservice applications from application stacks in an IDE. CodeReady Workspaces provides a containerized IDE for cloud native application development on an OpenShift cluster.

Prerequisites

CodeReady Workspaces requires at least two 1Gi ReadWriteOnce (RWO) persistent volumes on the cluster to install and a 1Gi RWO volume for each created workspace.

Each Codewind workspace also requires at least one 1Gi ReadWriteMany (RWX) persistent volume.

Installing CodeReady Workspaces

To install CodeReady Workspaces, set Spec.codeReadyWorkspaces.enable: true in the Kabanero custom resource (Kabanero CR) instance and apply it. To edit the Kabanero CR, you can run oc edit kabanero -n kabanero from the command line.

The following sample shows a Kabanero CR instance configuration:

apiVersion: kabanero.io/v1alpha2
kind: Kabanero
metadata:
  name: kabanero
spec:
  version: "0.9.0"
  codeReadyWorkspaces:
    enable: true
    operator:
      customResourceInstance:
        tlsSupport: true
        selfSignedCert: true
  stacks:
    repositories:
    - name: central
      https:
        url: https://github.com/kabanero-io/kabanero-stack-hub/releases/download/0.9.0/kabanero-stack-hub-index.yaml

Configuring CodeReady Workspaces

The Kabanero CR instance provides additional fields that allow you to configure your installation of CodeReady Workspaces.

  • If you want to install CodeReady Workspaces with TLS Support, set Spec.codeReadyWorkspaces.operator.customResourceInstance.tlsSupport to true. Note: If your OpenShift cluster’s router is set up with self-signed certificates, Spec.codeReadyWorkspaces.operator.instance.selfSignedCert must also be set to true.

  • If you want to use your OpenShift accounts with CodeReady Workspaces, set up permanent users (accounts other than kube:admin) and then set Spec.codeReadyWorkspaces.operator.customResourceInstance.openShiftOAuth to true. Consult Kabanero Custom Resource for the full list of configurable fields.

Using CodeReady Workspaces with self-signed certificates

If CodeReady Workspaces is set up to use the self-signed certificates provided by the OpenShift cluster’s router, then you must do the following:

Google Chrome:

  1. Access the CodeReady Workspaces route in your browser.

  2. Download the route’s certificate to your system.

  3. Go to Settings → Privacy and Security → Manage certificates.

  4. Import the certificate into your system and set its trust to Always trust.

Firefox (version 71 or newer):

  1. Access the CodeReady Workspaces route in your browser.

  2. View the route’s certificate in your browser.

  3. Download the certificate titled ingress-operator.

  4. Go to Preferences → Privacy and Security → View certificates.

  5. Import the ingress-operator certificate as an authority into Firefox.

Installing Codewind

When CodeReady Workspaces is installed on your OpenShift cluster, complete the following steps:

  1. Log in to CodeReady Workspaces.

  2. Click Create Workspace.

  3. For Name, give your workspace some meaningful name.

  4. For Select Stack, select Codewind.

  5. Click Create & Open to create and start Codewind in CodeReady Workspaces.

CodeReady Workspaces starts Codewind and installs the Codewind plugins. This process might take a couple of minutes for all of the necessary components to be pulled and started.

Consult the Codewind on Che documentation for additional information and next steps.

Stopping or Uninstalling Codewind

If you need to stop the Codewind workspace, follow these steps:

  1. Log in to your CodeReady workspaces account and access the dashboard.

  2. Click on Workspaces in the sidebar.

  3. To pause the Codewind workspace: Select the Codewind workspace and under Actions click the Stop workspace button.

  4. To delete the Codewind workspace: Select the Codewind workspace and click the Delete button.

Troubleshooting

To troubleshoot Codewind, see the Codewind Troubleshooting page.

Edit This Page