OpenShift Console

Codename: "Bridge"

quay.io/openshift/origin-console

The console is a more friendly kubectl in the form of a single page webapp. It also integrates with other services like monitoring, chargeback, and OLM. Some things that go on behind the scenes include:

• Proxying the Kubernetes API under /api/kubernetes
• Providing additional non-Kubernetes APIs for interacting with the cluster
• Serving all frontend static assets
• User Authentication

Quickstart

Dependencies:

1. node.js >= 14 & yarn >= 1.20
2. go >= 1.16+
3. oc or kubectl and an OpenShift or Kubernetes cluster
4. jq (for contrib/environment.sh)
5. Google Chrome/Chromium or Firefox for integration tests

Build everything:

This project uses Go modules, so you should clone the project outside of your GOPATH. To build both the frontend and backend, run:

./build.sh

Backend binaries are output to ./bin.

Configure the application

The following instructions assume you have an existing cluster you can connect to. OpenShift 4.x clusters can be installed using the OpenShift Installer. More information about installing OpenShift can be found at https://try.openshift.com/. You can also use CodeReady Containers for local installs, or native Kubernetes clusters.

OpenShift (no authentication)

For local development, you can disable OAuth and run bridge with an OpenShift user's access token. If you've installed OpenShift 4.0, run the following commands to login as the kubeadmin user and start a local console for development. Make sure to replace /path/to/install-dir with the directory you used to install OpenShift.

oc login -u kubeadmin -p $(cat /path/to/install-dir/auth/kubeadmin-password)
source ./contrib/oc-environment.sh
./bin/bridge

The console will be running at localhost:9000.

If you don't have kubeadmin access, you can use any user's API token, although you will be limited to that user's access and might not be able to run the full integration test suite.

OpenShift (with authentication)

If you need to work on the backend code for authentication or you need to test different users, you can set up authentication in your development environment. Registering an OpenShift OAuth client requires administrative privileges for the entire cluster, not just a local project. You must be logged in as a cluster admin such as system:admin or kubeadmin.

To run bridge locally connected to an OpenShift cluster, create an OAuthClient resource with a generated secret and read that secret:

oc process -f examples/console-oauth-client.yaml | oc apply -f -
oc get oauthclient console-oauth-client -o jsonpath='{.secret}' > examples/console-client-secret

If the CA bundle of the OpenShift API server is unavailable, fetch the CA certificates from a service account secret. Otherwise copy the CA bundle to examples/ca.crt:

oc get secrets -n default --field-selector type=kubernetes.io/service-account-token -o json | \
    jq '.items[0].data."ca.crt"' -r | python -m base64 -d > examples/ca.crt
# Note: use "openssl base64" because the "base64" tool is different between mac and linux

Finally run the console and visit localhost:9000:

./examples/run-bridge.sh

CodeReady Containers

If you want to use CodeReady for local development, first make sure it is set up, and the OpenShift cluster is started.

To login to the cluster's API server, you can use the following command:

oc login -u kubeadmin -p $(cat ~/.crc/machines/crc/kubeadmin-password) https://api.crc.testing:6443

… or, alternatively, use the CRC daemon UI (Copy OC Login Command --> kubeadmin) to get the cluster-specific command.

Finally, prepare the environment, and run the console:

source ./contrib/environment.sh
./bin/bridge

Native Kubernetes

If you have a working kubectl on your path, you can run the application with:

export KUBECONFIG=/path/to/kubeconfig
source ./contrib/environment.sh
./bin/bridge

The script in contrib/environment.sh sets sensible defaults in the environment, and uses kubectl to query your cluster for endpoint and authentication information.

To configure the application to run by hand, (or if environment.sh doesn't work for some reason) you can manually provide a Kubernetes bearer token with the following steps.

First get the secret ID that has a type of kubernetes.io/service-account-token by running:

kubectl get secrets

then get the secret contents:

kubectl describe secrets/<secret-id-obtained-previously>

Use this token value to set the BRIDGE_K8S_AUTH_BEARER_TOKEN environment variable when running Bridge.

Operator

In OpenShift 4.x, the console is installed and managed by the console operator.

Hacking

See CONTRIBUTING for workflow & convention details.

See STYLEGUIDE for file format and coding style guide.

Dev Dependencies

go 1.16+, nodejs/yarn, kubectl

Frontend Development

All frontend code lives in the frontend/ directory. The frontend uses node, yarn, and webpack to compile dependencies into self contained bundles which are loaded dynamically at run time in the browser. These bundles are not committed to git. Tasks are defined in package.json in the scripts section and are aliased to yarn run <cmd> (in the frontend directory).

Install Dependencies

To install the build tools and dependencies:

cd frontend
yarn install

You must run this command once, and every time the dependencies change. node_modules are not committed to git.

Interactive Development

The following build task will watch the source code for changes and compile automatically. If you would like to disable hot reloading, set the environment variable HOT_RELOAD to false.

yarn run dev

If changes aren't detected, you might need to increase fs.inotify.max_user_watches. See https://webpack.js.org/configuration/watch/#not-enough-watchers. If you need to increase your watchers, it's common to see multiple errors beginning with Error from chokidar.

Unit Tests

Run all unit tests:

./test.sh

Run backend tests:

./test-backend.sh

Run frontend tests:

./test-frontend.sh

Debugging Unit Tests

1. cd frontend; yarn run build
2. Add debugger; statements to any unit test
3. yarn debug-test route-pages
4. Chrome browser URL: 'chrome://inspect/#devices', click on the 'inspect' link in Target (v10...) section.
5. Launches chrome-dev tools, click Resume button to continue
6. Will break on any debugger; statements

Integration Tests

Cypress

Cypress integration tests are implemented in Cypress.io.

Launch Cypress test runner:

cd frontend
oc login ...
yarn run test-cypress-console

This will launch the Cypress Test Runner UI in the console package, where you can run one or all cypress tests. By default, it will look for Chrome in the system and use it, but if you want to use Firefox instead, set BRIDGE_E2E_BROWSER_NAME environment variable in your shell with the value firefox.

Execute Cypress in different packages

An alternate way to execute cypress tests is via test-cypress.sh which takes a -p <package> parameter to allow execution in different packages. It also can run Cypress tests in the Test Runner UI or in -- headless mode:

console>./test-cypress.sh
Runs Cypress tests in Test Runner or headless mode
Usage: test-cypress [-p] <package> [-s] <filemask> [-h true]
  '-p <package>' may be 'console, 'olm' or 'devconsole'
  '-s <specmask>' is a file mask for spec test files, such as 'tests/monitoring/*'. Used only in headless mode when '-p' is specified.
  '-h true' runs Cypress in headless mode. When omitted, launches Cypress Test Runner
Examples:
  test-cypress.sh                                       // displays this help text
  test-cypress.sh -p console                            // opens Cypress Test Runner for console tests
  test-cypress.sh -p olm                                // opens Cypress Test Runner for OLM tests
  test-cypress.sh -h true                               // runs all packages in headless mode
  test-cypress.sh -p olm -h true                        // runs OLM tests in headless mode
  test-cypress.sh -p console -s 'tests/crud/*' -h true  // runs console CRUD tests in headless mode

More information on Console's Cypress usage

More information on DevConsole's Cypress usage

Protractor

Integration tests are run in a headless browser driven by protractor. Requirements include Chrome or Firefox, a working cluster, kubectl, and bridge itself (see building above). By default, it will look for Chrome in the system and use it, but if you want to use Firefox instead, set BRIDGE_E2E_BROWSER_NAME environment variable in your shell with the value firefox.

Setup (or any time you change node_modules - yarn add or yarn install)

cd frontend && yarn run webdriver-update

Run integration tests:

yarn run test-protractor

Run integration tests on an OpenShift cluster:

yarn run test-protractor-openshift

This will include the normal k8s CRUD tests and CRUD tests for OpenShift resources.

If you get Jasmine spec timeout errors during runs perhaps against a busy cluster or over slow network, you can try setting a bigger timeout in milliseconds to BRIDGE_JASMINE_TIMEOUT environment variable in your shell before running the tests. Default 120000 (2 minutes).

If your local Chrome version doesn't match the Chromedriver version from the console dependencies, override the version with:

yarn run webdriver-update --versions.chrome=77.0.3865.120

For Fedora, you can use:

yarn run webdriver-update-fedora

For macOS, you can use:

yarn run webdriver-update-macos

Hacking Protractor Tests

To see what the tests are actually doing, it is possible to run in non-headless mode by setting the NO_HEADLESS environment variable:

$ NO_HEADLESS=true ./test-protractor.sh <suite>

To use a specific binary version of chrome, it is possible to set the CHROME_BINARY_PATH environment variable:

$ CHROME_BINARY_PATH="/usr/bin/chromium-browser" ./test-protractor.sh <suite>

To avoid skipping remaining portion of tests upon encountering the first failure, NO_FAILFAST environment variable can be used:

$ NO_FAILFAST=true ./test-protractor.sh <suite>

Debugging Protractor Tests

1. cd frontend; yarn run build
2. Add debugger; statements to any e2e test
3. yarn run debug-protractor-suite --suite <suite-to-debug>
4. Chrome browser URL: 'chrome://inspect/#devices', click on the 'inspect' link in Target (v10...) section.
5. Launches chrome-dev tools, click Resume button to continue
6. Will break on any debugger; statements
7. Pauses browser when not using --headless argument!

How the Integration Tests Run in CI

The end-to-end tests run against pull requests using ci-operator. The tests are defined in this manifest in the openshift/release repo and were generated with ci-operator-prowgen.

CI runs the test-prow-e2e.sh script, which runs test-cypress.sh and 'test-protractor.sh e2e', which runs the protractor e2e test suite.

Cypress in CI

The CI executes test-cypress.sh to run all Cypress tests, in all 'packages' (console, olm, and devconsole), in -- headless mode via:

test-cypress.sh -h true

For more information on test-cypress.sh usage please see Execute Cypress in different packages

Protractor in CI

'test-protractor.sh e2e' runs the protractor e2e test suite defined in protractor.conf.ts You can simulate an e2e run against an existing cluster with the following commands (replace /path/to/install-dir with your OpenShift install directory):

$ oc apply -f ./frontend/integration-tests/data/htpasswd-secret.yaml
$ oc patch oauths cluster --patch "$(cat ./frontend/integration-tests/data/patch-htpasswd.yaml)" --type=merge
$ export BRIDGE_BASE_ADDRESS="$(oc get consoles.config.openshift.io cluster -o jsonpath='{.status.consoleURL}')"
$ export BRIDGE_KUBEADMIN_PASSWORD=$(cat "/path/to/install-dir/auth/kubeadmin-password")
$ ./test-protractor.sh e2e

If you don't want to run the entire e2e tests, you can use a different suite from protractor.conf.ts. For instance,

$ ./test-protractor.sh <suite>

Internationalization

See INTERNATIONALIZATION for information on our internationalization tools and guidelines.

Deploying a Custom Image to an OpenShift Cluster

Once you have made changes locally, these instructions will allow you to push changes to an OpenShift cluster for others to review. This involves building a local image, pushing the image to an image registry, then updating the OpenShift cluster to pull the new image.

Prerequisites

1. Docker v17.05 or higher for multi-stage builds
2. An image registry like quay.io or Docker Hub

Steps

1. Create a repository in the image registry of your choice to hold the image.
2. Build Image docker build -t <your-image-name> <path-to-repository | url>. For example:

docker build -t quay.io/myaccount/console:latest .

3. Push image to image registry docker push <your-image-name>. Make sure docker is logged into your image registry! For example:

docker push quay.io/myaccount/console:latest

4. Put the console operator in unmanaged state:

oc patch consoles.operator.openshift.io cluster --patch '{ "spec": { "managementState": "Unmanaged" } }' --type=merge

5. Update the console Deployment with the new image:

oc set image deploy console console=quay.io/myaccount/console:latest -n openshift-console

6. Wait for the changes to rollout:

oc rollout status -w deploy/console -n openshift-console

You should now be able to see your development changes on the remote OpenShift cluster!

When done, you can put the console operator back in a managed state to remove the custom image:

oc patch consoles.operator.openshift.io cluster --patch '{ "spec": { "managementState": "Managed" } }' --type=merge

Dependency Management

Dependencies should be pinned to an exact semver, sha, or git tag (eg, no ^).

Backend

Whenever making vendor changes:

1. Finish updating dependencies & writing changes
2. Commit everything except vendor/ (eg, server: add x feature)
3. Make a second commit with only vendor/ (eg, vendor: revendor)

Adding new or updating existing backend dependencies:

1. Edit the go.mod file to the desired version (most likely a git hash)
2. Run go mod tidy && go mod vendor
3. Verify update was successful. go.sum will have been updated to reflect the changes to go.mod and the package will have been updated in vendor.

Frontend

Add new frontend dependencies:

yarn add <package@version>

Update existing frontend dependencies:

yarn upgrade <package@version>

To upgrade yarn itself, download a new yarn release from https://github.com/yarnpkg/yarn/releases, replace the release in frontend/.yarn/releases with the new version, and update yarn-path in frontend/.yarnrc.

Supported Browsers

We support the latest versions of the following browsers:

• Edge
• Chrome
• Safari
• Firefox

IE 11 and earlier is not supported.