Run the following commands (in the deck directory) to get all dependencies installed in deck and to start the server:
yarn run start
The app will start up on localhost:9000.
Environment variables can be used to configure application behavior. The following lists those variables and their possible values:
AUTHenable/disable authentication (default is disabled, enable by setting
TIMEZONEset the default timezone (default is 'America/Los_Angeles' - see http://momentjs.com/timezone/docs/#/data-utilities/ for options)
DECK_CERTenable SSL (set to the fully qualified path to cert file, and
DECK_KEYmust be set to the fully qualified path to the key file)
The following external resources can be specified with environment variables:
API_HOSToverrides the default Spinnaker API host.
AUTH_ENABLEDdetermines whether Deck will attempt to authenticate users via Gate.
API_HOST=http://spinnaker.prod.netflix.net yarn run start will run Deck with
http://spinnaker.prod.netflix.net as the API host.
To run the tests within the application, run
yarn run test.
Developing things locally? You will want to run gate locally (which runs on port 8084) as well. It’s the gateway to clouddriver. Then run deck like this:
API_HOST=http://localhost:8084 yarn run start
Building & Deploying
To build the application, run
yarn run build. The built application lives in
It’s a work in progress, but please try to follow the conventions here.
Customizing the UI
It’s certainly doable - we’re in the middle of some significant changes to our build process, which should make it easier. For now, you can look at the netflix module to get an idea how we are customizing Deck internally. Expect a lot of this to change, though, as we figure out better, cleaner hooks and integration points. And we’re happy to provide new integration points (or accept pull requests) following those existing conventions if you need an integration point that doesn’t already exist.