Red Hat CodeReady logo

Install to OCP or OSD

1. Download and unpack the deployment script

3 minutes

CodeReady Workspaces is distributed in the form of container images that need to be deployed on an instance of OpenShift. A deployment script is provided that automates the installation with various configuration options.

The file is available at developers.redhat.com/download-manager/file/codeready-workspaces-apb-installer-1.0.0.Beta1.tar.gz.


2. Run the deployment script

10 minutes

To run the deployment script with all the default settings, simply switch to the directory where you unpacked the file and run ./deploy.sh --deploy

To modify installation settings, change the config.json file. Configuration options include: 

  • Deploying with a self-signed certificate and OpenShift OAuth.

  • Deploying with external Red Hat SSO and enabled realm provisioning.

  • Deploying with external Red Hat SSO and PostgreSQL.

Note: Currently the script will not work if you unpack it into a path that contains a space. 


3. Confirm the CodeReady pod is running

3 minutes

Point your browser to the web UI of the OpenShift console (<OpenShift-IP>/console) to confirm the codeready pod has been successfully started. Once it is up and running, go to the URL displayed next to the pod name in the console. (That URL will be something like http://codeready-codeready.


Use the hosted version 

90 seconds

You can visit red.ht/che-factory to open a workspace that contains a sample Java application, Maven, Tomcat, and commands that automatically build and deploy the code when the workspace loads. It's a great way to get started without installing anything. 

(Requires a free Red Hat CodeReady Toolchain account, available at openshift.io.)

Last updated: February 5, 2019