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:
- node.js >= 8 & yarn >= 1.3.2
- go >= 1.8 & glide >= 0.12.0 (
go get github.com/Masterminds/glide
) & glide-vc - kubectl and a k8s cluster
jq
(forcontrib/environment.sh
)- Google Chrome/Chromium >= 60 (needs --headless flag) for integration tests
Build everything:
./build.sh
Backend binaries are output to /bin
.
Configure the application
OpenShift
Registering an OpenShift OAuth client requires administrative privileges for the entire cluster, not just a local project. Run the following command to log in as cluster admin:
oc login -u system:admin
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."service-ca.crt"' -r | python -m base64 -d > examples/ca.crt
# Note: use "openssl base64" because the "base64" tool is different between mac and linux
Set the OPENSHIFT_API
environment variable to tell the script the API endpoint:
export OPENSHIFT_API="https://127.0.0.1:8443"
Finally run the console and visit localhost:9000:
./examples/run-bridge.sh
OpenShift (without OAuth)
For local development, you can also disable OAuth and run bridge with an OpenShift user's access token. Run the following commands to create an admin user and start bridge for a cluster up environment:
oc login -u system:admin
oc adm policy add-cluster-role-to-user cluster-admin admin
oc login -u admin
source ./contrib/oc-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_BEARER_TOKEN
environment variable when running Bridge.
Images
The builder-run.sh
script will run any command from a docker container to ensure a consistent build environment.
For example to build with docker run:
./builder-run.sh ./build.sh
The docker image used by builder-run is itself built and pushed by the
script push-builder
, which uses the file Dockerfile-builder
to
define an image. To update the builder-run build environment, first make
your changes to Dockerfile-builder
, then run push-builder
, and
then update the BUILDER_VERSION variable in builder-run
to point to
your new image. Our practice is to manually tag images builder images in the form
Builder-v$SEMVER
once we're happy with the state of the push.
Compile, Build, & Push Image
(Almost no reason to ever do this manually, Jenkins handles this automation)
Build an image, tag it with the current git sha, and pushes it to the quay.io/coreos/tectonic-console
repo.
Must set env vars DOCKER_USER
and DOCKER_PASSWORD
or have a valid .dockercfg
file.
./build-docker-push.sh
Jenkins automation
Master branch:
- Runs a build, pushes an image to Quay tagged with the commit sha
Pull requests:
- Runs a build when PRs are created or PR commits are pushed
- Comment with
Jenkins rebuild
to manually trigger a re-build - Comment with
Jenkins push
to push an image to Quay, tagged with:pr_[pr #]_build_[jenkins build #]
If changes are ever required for the Jenkins job configuration, apply them to both the regular console job and PR image job.
Hacking
See CONTRIBUTING for workflow & convention details.
See STYLEGUIDE for file format and coding style guide.
Dev Dependencies
go, glide, glide-vc, 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:
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. You must reload the page in your browser!
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.
Tests
Run all unit tests:
./test.sh
Run backend tests:
./test-backend.sh
Run frontend tests:
./test-frontend.sh
Integration Tests
Integration tests are run in a headless Chrome driven by protractor. Requirements include Chrome, a working cluster, kubectl, and bridge itself (see building above).
Note: If you are running integration tests against OpenShift, you should start bridge using oc-environment.sh to skip the login page.
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-gui
Run integration tests on an OpenShift cluster:
yarn run test-gui-openshift
This will include the normal k8s CRUD tests and CRUD tests for OpenShift resources. It doesn't include ALM tests since it assumes ALM is not set up on an OpenShift cluster.
Hacking Integration Tests
Remove the --headless
flag to Chrome (chromeOptions) in frontend/integration-tests/protractor.conf.ts
to see what the tests are actually doing.
Dependency Management
Dependencies should be pinned to an exact semver, sha, or git tag (eg, no ^).
Backend
Whenever making vendor changes:
- Finish updating dependencies & writing changes
- Commit everything except
vendor/
(eg,server: add x feature
) - Make a second commit with only
vendor/
(eg,vendor: revendor
)
Add new backend dependencies:
- Edit
glide.yaml
./revendor.sh
Update existing backend dependencies:
- Edit the
glide.yaml
file to the desired version (most likely a git hash) - Run
./revendor.sh
- Verify update was successful.
glide.lock
will have been updated to reflect the changes toglide.yaml
and the package will have been updated invendor
.
Frontend
Add new frontend dependencies:
yarn add <package@version>
Update existing frontend dependencies:
yarn upgrade <package@version>
Supported Browsers
We support the latest versions of the following browsers:
- Edge
- Chrome
- Safari
- Firefox
IE 11 and earlier is not supported.