d053e593ac
This change: 1. Reads location of airship config file from "airshipConfigPath" key in airshipui.json 2. If key does not exist, it is added to airshipui.json along with the default path of $HOME/.airship/config 3. If a user initializes or specifies a config file in a different location, that location will be written to airshipui.json and will be used in place of the default Change-Id: I1d4282be26729427d14de8b60778a347f5e4f681 |
||
---|---|---|
.github | ||
certs | ||
client | ||
cmd | ||
docs | ||
etc | ||
pkg | ||
playbooks | ||
roles/docker-install | ||
sqlite | ||
tools | ||
util | ||
.gitignore | ||
.gitreview | ||
.golangci.yaml | ||
.zuul.yaml | ||
Dockerfile | ||
go.mod | ||
go.sum | ||
LICENSE | ||
Makefile | ||
README.md | ||
tox.ini |
Airship UI
Airship UI is a browser based application that is designed to allow you to interact with Airship components, find and connect to the kubernetes cluster and use plugins to tie together a singular dashboard to view addons without the need to go to a separate url or application.
Prerequisites
- A working kubernetes or airship installation
- Go 1.13+
Getting Started
git clone https://opendev.org/airship/airshipui
cd airshipui
make # Note running behind a proxy can cause issues, notes on solving is in the Appendix of the Developer's Guide
bin/airshipui
Once AirshipUI has started you should be able to browse to it at https://localhost:10443
Adding Additional Functionality
Airship UI can be seamlessly integrated with service dashboards and other web-based tools by providing the necessary configuration in etc/airshipui.json.
To add service dashboards, create a section at the top-level of airshipui.json as follows:
"dashboards": [
{
"name": "Ceph",
"baseURL": "https://ceph-dash.example.domain",
"path": ""
},
{
"name": "Horizon",
"baseURL": "http://horizon",
"path": "dashboard/auth/login"
}
]
In the above example, the configuration for Horizon specifies a service dashboard available at 'http://horizon/dashboard/auth/login'."
Developer's Guide
Instructions on setting up a development environment and more details can be found in the Developer's Guide