Skip to content

Latest commit

 

History

History
169 lines (118 loc) · 4.66 KB

README.md

File metadata and controls

169 lines (118 loc) · 4.66 KB
Raw

Tectonic Console

Codename: "Bridge"

Build Status

quay.io/coreos/tectonic-console

Console consists of a frontend webapp and a backend service which serves the following purposes:

  • Proxy the Kubernetes API
  • Provide additional non-Kubernetes APIs for interacting with the cluster
  • Serve all frontend static assets
  • User Authentication
  • Some additional proxying to the Dex API

Quickstart

Deps:

  1. nodejs >= 6.0 & npm >= 3 (use of nvm is recommended)
  2. go >= 1.6
  3. kubectl

Build everything:

./build

Backend binaries are output to /bin.

Configure the application

If you've got a working kubectl on your path, you can run the application with

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 enironment.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.

Docker

The builder-run script will run any command from a docker container to ensure a consistent build environment. For example to build with docker run:

./builder-run ./build

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 Docker Image

(Almost no reason to ever do this manually, Jenkins handles this automation)

Build a docker 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

Hacking

See CONTRIBUTING for workflow & convention details.

Dev Dependencies

go, glide, nodejs/npm, kubectl

Frontend Development

All frontend build tasks are defined in /frontend/gulpfile.js and are aliased to npm run gulp

Install Dependencies

The frontend uses node and npm to compile JS/JSX at build time. To install the build tools and dependencies:

npm install

JS is compiled into one of two bundles - one strictly for external dependencies and the other for our source. These bundles are not commited to git. You must run this command once, and every time the dependencies change.

Interactive Development

The following build task will watch the source code for changes and compile automatically. You must reload the page!

npm run dev

Alternatively you can use the Procfile if you're using foreman or goreman, which will start both the backend server and interactive dev mode in a single process.

goreman start

Tests

Run all tests:

./test

Run backend tests:

./test-backend

Run frontend tests:

./test-frontend

Dependency Management

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

Backend

Add new backend dependencies:

  1. Edit glide.yaml
  2. glide update -s -v -u

Update existing backend dependencies:

  1. Edit the glide.yaml file to the desired verison (most likely a git hash)
  2. Run glide update -u github.com/$ORG/$REPO
  3. Verify update was successful. glide.lock will have been updated to reflect the changes to glide.yaml and the package will have been updated in vendor.

Frontend

Add new frontend dependencies:

rm npm-shrinkwrap
npm install --save the-dependency
npm shrinkwrap
npm run gulp js-deps

Update existing frontend dependencies:

rm npm-shrinkwrap
npm install --save the-dependency
npm shrinkwrap
npm run gulp js-deps