A Web UI for interacting with Airship-managed clusters
Go to file
Schiefelbein, Andrew f59f2bc6eb Update documentation for TLS and authentication
Change-Id: Iac283b4feb17b5a9ddaf4d50d4fa53b77d29a4a3
2020-09-03 14:28:13 -05:00
.github Update Airship vulnerability link 2020-05-18 21:22:07 +00:00
certs update makefile to build docker images 2020-07-08 08:45:00 -05:00
client Merge "Refactor yaml explorer" 2020-09-02 20:30:42 +00:00
cmd Simplify, refactor and rename to bring in line with CTL 2020-08-04 14:26:51 -05:00
docs Update documentation for TLS and authentication 2020-09-03 14:28:13 -05:00
etc Add TLS to the UI 2020-08-24 16:43:18 -05:00
pkg Merge "Refactor yaml explorer" 2020-09-02 20:30:42 +00:00
playbooks Added unit-tests in Makefile 2020-07-22 14:06:02 -04:00
roles/docker-install Update zuul gates to use docker-image 2020-07-09 13:12:10 -05:00
tools Update documentation for TLS and authentication 2020-09-03 14:28:13 -05:00
util Refactor yaml explorer 2020-09-01 14:47:11 -07:00
.gitignore Add TLS to the UI 2020-08-24 16:43:18 -05:00
.gitreview Add a .gitreview 2019-12-06 16:02:18 -06:00
.golangci.yaml [linters] Aligning linter config with airshipctl 2020-06-19 11:38:46 -05:00
.zuul.yaml Update zuul gates to use docker-image 2020-07-09 13:12:10 -05:00
Dockerfile update makefile to build docker images 2020-07-08 08:45:00 -05:00
go.mod Update documentation for TLS and authentication 2020-09-03 14:28:13 -05:00
go.sum Refactor yaml explorer 2020-09-01 14:47:11 -07:00
LICENSE Incorporate the whitespace linter from the CTL project 2020-07-22 13:40:32 -05:00
Makefile Update documentation for TLS and authentication 2020-09-03 14:28:13 -05:00
README.md Update documentation for TLS and authentication 2020-09-03 14:28:13 -05:00
tox.ini Publish documentation 2020-05-11 21:21:41 +00:00

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

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