Installing a Codewind remote deployment all-in-one

Codewind includes a CLI to simplify the installation process. Find the cwctl CLI in your HOME directory under the ~/.codewind/<version> path.

Use the following command to install an all-in-one deployment with a new Keycloak and a new Codewind service:

cwctl --insecure install remote

This command requires various flags to specify where and what to install.

Deploying Codewind with CWCTL

  1. Open a new terminal window on your local workstation.
  2. Go to your home directory and then to the Codewind CLI:
cd ~/.codewind/0.8.0

Ensure that you are logged in to your Kubernetes or OpenShift cluster:

$ kubectl get namespaces


$ oc get namespaces

If the command is successful, you see a list of current namespaces. If not, ensure that you are logged into your Kubernetes or OpenShift cluster.

Determine your Cloud ingress domain

The CLI command requires an ingress domain. Enter the oc get routes -n default command and find your ingress domain based on any of the existing routes:

NAME               HOST/PORT                                                                                                          PATH      SERVICES           PORT               TERMINATION   WILDCARD
registry-console             registry-console   registry-console   passthrough   None

In the example the ingress domain is:

Running the CLI command

Determine the following values for your cloud deployment:

  • namespace: The cwctl command creates the namespace if it does not yet exist.
  • kadminuser and kadminpass: Initial Keycloak administrator user name and password.
  • kdevuser and kdevpass: A developer username and password that will be granted access to this deployment of Codewind. The cwctl command creates the user and adds it to the realm if it does not exist.
  • ingress: The ingress domain for your cloud environment.

Codewind on IBM Public Cloud requires Keycloak and Codewind to be installed separately. For deploying in IBM Public Cloud, follow the instructions in Install Codewind components and authentication services individually. If you are not deploying in IBM Pubic Cloud, to install Codewind, enter the following example command:

./cwctl --insecure install remote \
--namespace codewind-0001 \
--krealm codewind  \
--kclient codewind \
--kadminuser admin \
--kadminpass passw0rd \
--kdevuser developer \
--kdevpass passw0rd  \

This command performs the following actions:

  • Deploys Codewind into the codewind-0001 namespace.
  • Configures Keycloak with a realm called codewind.
  • Configures a client prefix of codewind.
  • Creates an initial Keycloak administrator user called admin with password passw0rd.
  • Creates an initial Codewind user called developer with password passw0rd.
  • Uses the ingress appropriate to the deployment environment.

Running the command, you see the following example output:

INFO[0000] Checking namespace codewind-0001 exists
INFO[0000] Creating codewind-0001 namespace
INFO[0000] Using namespace : codewind-0001
INFO[0000] Container images :
INFO[0000] eclipse/codewind-pfe-amd64:latest
INFO[0000] eclipse/codewind-performance-amd64:latest
INFO[0000] eclipse/codewind-keycloak-amd64:latest
INFO[0000] eclipse/codewind-gatekeeper-amd64:latest
INFO[0000] Running on OpenShift: true
INFO[0156] Waiting for Codewind Gatekeeper to start on
INFO[0159] Waiting for Codewind PFE to start
INFO[0159] Codewind is available at:

Codewind is successfully deployed and is available.

Make a note of the address provided because you need it for configuring your IDE in the next step, for example:

Next step: Connect your VSCode or Eclipse IDE to the new Codewind deployment.