pcrews / dcos-ui

The UI for The Datacenter Operating System

DC/OS UI

The User Interface for The Datacenter Operating System.

The DC/OS UI is used by datacenter operators to administer and manage a datacenter. Developers use DC/OS UI to manage, deploy and debug their applications. The DC/OS UI sits at the top of the DC/OS stack along with the CLI.

• Issue tracker. Use component dcos-ui.
• Documentation
• Apache License v2

Usage

You can choose from two ways of developing this repository.

• Locally
• Docker

Local Development

Requirements

Node 8.9.x and NPM 5.6.x (and above) are required. We suggest using nvm or n to keep multiple Node versions on your system.

DC/OS Installation Instructions:

1. Clone this repo:

git clone [e-mail]:dcos/dcos-ui.git && cd dcos-ui

2. Install dependencies:

npm i

3. Add developer files for config overrides:

npm run scaffold

This will create webpack/proxy.dev.js and src/js/config/Config.dev.ts. These files aren't tracked by git and provide a place to override proxy and general dcos-ui configuration.

Edit webpack/proxy.dev.js to point to the cluster address.

4. (optional) Using External Plugins:

DC/OS UI comes bundled with some internal plugins within the /plugins directory. You can also load more plugins from another directory and they will be loaded into DC/OS UI along with the internal plugins. To set a directory for external plugins run:

# for dcos-ui-plugins-private
npm config set externalplugins ../dcos-ui-plugins-private

# for your own plugins
npm config set externalplugins ../path/to/plugins

Note that dcos-ui-plugins-private currently must be set up at ../dcos-ui-plugins-private. You also might want to copy its Config.template.js to src/js/config/Config.dev.ts to enable the enterprise edition.

5. Start the development server:

npm start

6. Navigate to http://localhost:4200

7. (optional, not suggested) Follow the instructions here to install a local cluster.

Development with Docker

To start a development server run

docker-compose up -d
docker-compose exec toolchain /bin/bash # This opens bash inside of the docker container
npm start

Installing the nightly version on your cluster

As we ship the UI as a package you can install a nighly version on your cluster using this command:

dcos package repo remove dcos-ui-aws
dcos package repo add --index=0 dcos-ui-aws 'https://universe-converter.mesosphere.com/transform?url=https://dcos-ui-universe.s3.amazonaws.com/oss/dcos-ui/latest/stub-universe-dcos-ui.json'

This allows you to see the newest version of DC/OS UI in the Catalog.

Contributing

Contributing Guidelines

Testing

See more at the Testing section of the Contribution Guidelines.

License and Author

Copyright Mesosphere, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this repository except in compliance with the License.

The contents of this repository are solely licensed under the terms described in the LICENSE file included in this repository.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Authors are listed in Authors.md file.