Clone, Build, Deploy Dashboard

You can deploy the dashboard on any machine with docker installed. It is recommended to deploy on your local machine forĀ  ease of use.


Steps to deploy dashboard:


First, clone the repo:

`git clone ssh://<Gerrit_Username>@gerrit.opnfv.org:29418/laas`


Next, we have to configure the deployment.

Copy the `config.env.sample` to `config.env`. For a development instance, you should only have to change a couple of lines. A commented example can be found below:

DASHBOARD_URL=http://127.0.0.1:8000  # for local deployment

# makes debugging and testing easier
DEBUG=True
TEST=True

# These do not need to be changed
POSTGRES_DB=sample_name
POSTGRES_USER=sample_user
POSTGRES_PASSWORD=sample_pass
DB_NAME=sample_name
DB_USER=sample_user
DB_PASS=sample_pass
DB_SERVICE=postgres
DB_PORT=5432

# This can be anything
SECRET_KEY=abc_secretKey_123

# If you have a local Jira you can connect to,
# contact the admin to fill in these fields.
# otherwise, ignore.
OAUTH_CONSUMER_KEY=sample_key
OAUTH_CONSUMER_SECRET=sample_secret
JIRA_URL=sample_url
JIRA_USER_NAME=sample_jira_user
JIRA_USER_PASSWORD=sample_jira_pass

# Does not need to change
RABBITMQ_DEFAULT_USER=opnfv
RABBITMQ_DEFAULT_PASS=opnfvopnfv

#Jenkins Build Server
JENKINS_URL=https://build.opnfv.org/ci

# Please leave empty. Don't spam people!
EMAIL_HOST=
EMAIL_PORT=
EMAIL_HOST_USER=
EMAIL_HOST_PASSWORD=
DEFAULT_FROM_EMAIL=webmaster@localhost



With the configuration file in place, we can run the deploy:

$ make data  # create database volume
$ make build  # build docker images
$ make dev-up  # run local deployment



API Documentation

This is the pdf generated from the swagger definition: