Skip to content

jtk54/deck

This branch is 7124 commits behind spinnaker/deck:master.

Folders and files

NameName
Last commit message
Last commit date
Mar 1, 2017
Aug 25, 2016
Mar 17, 2017
Jan 25, 2017
Feb 3, 2017
Feb 28, 2017
Dec 16, 2015
Jan 19, 2017
Sep 21, 2016
Jan 25, 2017
Dec 23, 2015
Feb 3, 2017
Jul 17, 2014
Mar 8, 2017
Jul 21, 2015
Nov 9, 2016
Sep 1, 2016
Feb 9, 2017
Feb 7, 2017
Aug 21, 2014
Jan 25, 2017
Feb 14, 2017
Mar 15, 2017
Nov 15, 2015
Sep 7, 2014
Nov 23, 2015
Mar 7, 2017
Feb 21, 2017
Mar 16, 2017
Sep 22, 2015
Sep 8, 2014
Mar 2, 2017
Dec 14, 2016
Mar 5, 2017
Mar 17, 2017
Apr 29, 2016
Mar 9, 2017
Oct 29, 2016

Repository files navigation

Spinnaker UI

Build Status

Prerequisites

Make sure that node and npm are installed on your system (download). The minimum versions for each are listed in package.json.

Quick Start

Run the following commands (in the deck directory) to get all dependencies installed in deck and to start the server:

  • npm install

  • npm start

The app will start up on localhost:9000.

Environment variables

Environment variables can be used to configure application behavior. The following lists those variables and their possible values:

  • AUTH enable/disable authentication (default is disabled, enable by setting AUTH=enabled).

  • TIMEZONE set the default timezone (default is 'America/Los_Angeles' - see http://momentjs.com/timezone/docs/#/data-utilities/ for options)

  • DECK_CERT enable SSL (set to the fully qualified path to cert file, and DECK_KEY must be set to the fully qualified path to the key file)

The following external resources can be specified with environment variables:

  • API_HOST overrides the default Spinnaker API host.

  • AUTH_ENABLED determines whether Deck will attempt to authenticate users via Gate.

For example, API_HOST=http://spinnaker.prod.netflix.net npm start will run Deck with http://spinnaker.prod.netflix.net as the API host.

Testing

To run the tests within the application, run npm 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 npm start

Building & Deploying

To build the application, run npm run build. The built application lives in build/.

Conventions

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.

About

Management UI for Spinnaker

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.0%
  • HTML 27.6%
  • TypeScript 19.2%
  • CSS 2.7%
  • Other 0.5%