A Web UI for interacting with Airship-managed clusters
Go to file
Schiefelbein, Andrew 9e0f39f624 Moving the plugin dropdown population to go instead of node.js
This moves the npm components that were loading the json file to
go so that it can be handled as messages over the websocket

This should serve as an example how to communicate with the backend

Change-Id: I9fdeb420123034a549333ddb3aad45eea663cb09
2020-05-05 14:45:38 -05:00
.github Add SECURITY.md 2020-02-20 17:08:20 -06:00
cmd/airshipui [WIP] transform airship ui into a standalone electron app 2020-04-30 08:54:09 -05:00
internal Moving the plugin dropdown population to go instead of node.js 2020-05-05 14:45:38 -05:00
playbooks Use ensure-* roles 2020-04-12 10:24:21 +02:00
tools This adds a plugin for OpenStack to the Airship UI 2020-03-26 13:27:52 -05:00
web Moving the plugin dropdown population to go instead of node.js 2020-05-05 14:45:38 -05:00
.gitignore [WIP] transform airship ui into a standalone electron app 2020-04-30 08:54:09 -05:00
.gitreview Add a .gitreview 2019-12-06 16:02:18 -06:00
.golangci.yaml [WIP] transform airship ui into a standalone electron app 2020-04-30 08:54:09 -05:00
.zuul.yaml Remove docker build for zuul jobs 2020-01-07 10:03:55 -08:00
DevelopersGuide.md Adding the npm commands to the docs 2020-05-01 13:24:22 -05:00
LICENSE Initial commit 2019-09-20 09:08:48 -07:00
Makefile Updated documentation and removed openstack go client 2020-04-30 14:33:10 -05:00
README.md Merge "Adding the npm commands to the docs" 2020-05-01 20:16:46 +00:00
go.mod [WIP] transform airship ui into a standalone electron app 2020-04-30 08:54:09 -05:00
go.sum [WIP] transform airship ui into a standalone electron app 2020-04-30 08:54:09 -05:00

README.md

Airship UI

Airship UI is an electron 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 for each.

Prerequisites

Getting Started

git clone https://opendev.org/airship/airshipui
cd airshipui
make build
cd web
npm install
npm install --save-dev electron
npm install electron-json-config

Adding Additional Functionality

Airship UI can be seamlessly integrated with dashboards and other web-based tools by making the application aware of their service URLs. To do this, create the file $HOME/.airshipui/plugins.json with the following structure:

{
  "external_dashboards":
    [
      {
        "name":"Ceph",
        "url":"https://127.0.0.1:51515"
      },
      {
        "name":"Octant",
        "url":"http://127.0.0.1:7777"
      }
    ]
}

Once the file is in place, dashboards can be accessed through the Plugins drop-down menu in the Airship UI navigation bar. Dashboards can be added or removed while the application is running, and changes will take effect after the current view is refreshed.

Developer's Guide

Instructions on setting up a development environment and more details can be found in the Developer's Guide