web-terminal-operator

Web Terminal Operator

The Web Terminal Operator provides users with the ability to create a terminal instance embedded in the OpenShift Console.

Note: The OpenShift console integration that allows easily creating web terminal instances and logging in automatically is available in OpenShift 4.5.3 and higher. In previous versions of OpenShift, the operator can be installed but web terminals will have to be created and accessed manually.

Where to report bugs or propose features?

If you face any issues with installing the Web Terminal Operator or using it, have any ideas about what could be done better, please let us know by creating a jira issue at https://issues.redhat.com/browse/WTO

Deploying next operator from next images

After every commit in master index and bundle images are built and pushed to: quay.io/repository/wto/web-terminal-operator-index:next quay.io/repository/wto/web-terminal-operator-metadata:next

To try them you can just do

make install

and wait until Operator is installed on the cluster.

Deploying the operator from next images

After every commit in master, the index and bundle images are built and pushed to quay.io/repository/wto/web-terminal-operator-index:next and quay.io/repository/wto/web-terminal-operator-metadata:next

This repo includes a Makefile to simplify deploying the Operator to a cluster:

The commands above require being logged in to the cluster as a cluster-admin. See make help for a full list of supported environment variables and rules available.

Deploying the operator from local sources

In order to deploy the operator from this repo directly, you need to first create the olm bundle and index, push that to a docker registry, and then create a CatalogSource referencing those images.

This can be done in one step using the Makefile build_install rule:

BUNDLE_IMG=#<your bundle image>
INDEX_IMG=#<your index image>
make build_install

This will build and push images defined by the environment variables BUNDLE_IMG and INDEX_IMG, and register a CatalogSource on the cluster. You may need to set the repos used for the index and bundle to be public to ensure they can be accessed from the cluster.

If you already have the index image pushed to your registry, then you can use the make install or make register_catalogsource rules with the environment variables defined above to install those images on the cluster.

Configuring the custom default container

As cluster admin you're able to configure the default container that is used in terminal's devworkspaces with the following entry in configmap:

oc patch configmap devworkspace-controller -n openshift-operators --patch "
data:
  devworkspace.default_dockerimage.redhat-developer.web-terminal: |
      name: dev
      image: quay.io/wto/web-terminal-tooling:latest
      memoryLimit: 128Mi
      command: ['tail']
      args: ['-f', '/dev/null']
      env:
      - name: PS1
        value: '\[\e[34m\]>\[\e[m\]\[\e[33m\]>\[\e[m\]'
"

oc patch configmap devworkspace-controller -n openshift-operators --patch "
data:
  devworkspace.default_dockerimage.redhat-developer.web-terminal: |
    memoryLimit: 128Mi
    container:
      name: dev
      image: quay.io/wto/web-terminal-tooling:latest
      command: ['tail']
      args: ['-f', '/dev/null']
      env:
      - name: PS1
        value: '\[\e[34m\]>\[\e[m\]\[\e[33m\]>\[\e[m\]'
"

Removing the operator from a cluster

To remove the WebTerminal Operator and the CatalogSource use

make uninstall unregister_catalogsource

Manifests generation

Prereq: The latest compatible operator sdk https://github.com/operator-framework/operator-sdk/releases/tag/v0.17.2

Execute

  make gen_terminal_csv

Related Projects

• The Web Terminal Operator is powered by the devworkspace-operator

Source Syncing