Code Server OpenShift Container

This repository contains the source code for a code server (https://coder.com/docs/code-server/latest) container configured for Red Hat OpenShift Container Platform.

It also contains the Kubernetes resource files necessary to deploy a code server to an OpenShift cluster.

This repository contains two containers sharing a Persistent Volume Claim for storage:

• The Main Container (the VSCode container): this container is configured with

  • Code Server

  • OpenJDK 11

  • git

  • Maven

  • Google Chrome (headless, necessary for the browser preview extension)

• The Init Container. This container is run only once when the application is started for the first time. It will set up the code server environment. The init container uses the following environment variables:

  • CODE_WORKSPACE_NAME: The name of the workspace to create for code server (Lower and uppercase letters are allowed, no spaces allowed)

    - name: CODE_WORKSPACE_NAME
      value: MyWorkspace

  • CODE_PASSWORD: The password for the code server. If no password is specified a 16 character random password is generated and can be retrieved by examining the init container’s log

    Example

    - name: CODE_PASSWORD
      value: my_super_secret_password

  • CODE_REPO_LIST: A JSON list of repositories to clone into the environment. For private repositories encode the userid and password in the repository URL.

  Example

  - name: CODE_REPO_LIST:
    value: '[{"name":"app-mod-projects","url":"https://user1:openshift@gitea.apps.cluster-wkams.wkams.devel.opentlc.com/user1/app-mod-projects.git","branch":"main"}, {"name":"codeserver","url":"https://github.com/redhat-gpte-devopsautomation/codeserver.git","branch":"main"}]'

  • CODE_EXTENSIONS_LIST: a JSON list of extensions to be installed in code server. URL should contain the full download path.

    Example

    - name: CODE_EXTENSIONS_LIST
      value: '[{"filename":"auchenberg.vscode-browser-preview-0.7.2.vsix", "url": "https://gpte-public.s3.amazonaws.com/vscode-plugins/auchenberg.vscode-browser-preview-0.7.2.vsix"}]'

Releasing

Images are built and published automatically to quay.io/gpte-devops-automation by GitHub Actions when a version tag is pushed.

1. Update CODE_SERVER_VERSION (and optionally MAVEN_VERSION/OCP_VERSION) in build.sh.

2. Commit the change: git commit -am "Updated for Codeserver vX.Y.Z"

3. Tag and push:

   git tag vX.Y.Z
   git push origin main --tags

The workflow builds five images in parallel where possible:

• codeserver-init:vX.Y.Z and codeserver-init:latest

• codeserver:vX.Y.Z (base, no Java)

• codeserver:vX.Y.Z-java11, codeserver:vX.Y.Z-java17, codeserver:vX.Y.Z-java21

• codeserver:latest (alias for the java21 image)

All images are signed with cosign. The workflow requires QUAY_USERNAME and QUAY_ROBOT_TOKEN secrets configured in the repository settings.

Building

To build each container image locally, a build.sh shell script is provided. Adjust the script with your registry URL, log into your registry and simply run the build script. Note that the build script uses podman but it should also work with docker.

Deploying

The k8s directory has OpenShift manifests that can be applied to your cluster.

1. Adjust the variables in the file deployment.yaml to match your desired configuration.

2. Adjust the image locations in the file deployment.yaml to match your container registry.

3. Create a namespace to run code server in

4. Use oc apply -k k8s -n <yournamespace> to deploy the application