Chapter 2. Installing CodeReady Workspaces on OpenShift 3 using the Operator
Operators are a method of packaging, deploying, and managing a OpenShift application which also provide the following:
- Repeatability of installation and upgrade.
- Constant health checks of every system component.
- Over-the-air (OTA) updates for OpenShift components and ISV content.
- A place to encapsulate knowledge from field engineers and spread it to all users.
This chapter describes how to install CodeReady Workspaces on OpenShift 3 using the CLI management tool and the Operator method.
2.1. Installing CodeReady Workspaces on OpenShift 3 using the Operator
This section describes how to install CodeReady Workspaces on OpenShift 3 with the CLI management tool to install via the Operator with SSL (HTTPS) enabled.
As of 2.1.1, SSL/TLS is enabled by default as it is required by the Che-Theia IDE.
Prerequisites
- A running instance of OpenShift 3.11.
- Administrator rights on this OpenShift 3 instance.
-
The
oc
OpenShift 3.11 CLI management tool is installed and configured. See Installing the OpenShift 3.11 CLI. To check the version of theoc
tool, use theoc version
command. -
The
crwctl
CLI management tool is installed. See Installing thecrwctl
CLI management tool.
Procedure
Log in to OpenShift. See Basic Setup and Login.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login
$ oc login
Run the following command to create the CodeReady Workspaces instance:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow crwctl server:start -n <openshift_namespace>
$ crwctl server:start -n <openshift_namespace>
NoteTo create the CodeReady Workspaces instance on OpenShift clusters that have not been configured with a valid certificate for the routes, run the
crwctl
command with the--self-signed-cert
flag.
Verification steps
The output of the previous command ends with:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Command server:start has completed successfully.
Command server:start has completed successfully.
-
Navigate to the CodeReady Workspaces cluster instance:
https://codeready-<openshift_deployment_name>.<domain_name>
. The domain uses Let’s Encrypt ACME certificates.