Welcome to KQueen UI documentation!

kqueen-ui package

Server

Api

Auth

Exceptions

Generic Views

Tests

Subpackages

Flask blueprints

Subpackages
kqueen_ui.blueprints.ui package
Submodules
kqueen_ui.blueprints.ui.forms module
kqueen_ui.blueprints.ui.utils module
kqueen_ui.blueprints.ui.test_utils module
kqueen_ui.blueprints.ui.views module
kqueen_ui.blueprints.ui.test_views module
Module contents
kqueen_ui.blueprints.registration package
Submodules
kqueen_ui.blueprints.registration.forms module
kqueen_ui.blueprints.registration.test_views module
kqueen_ui.blueprints.registration.views module
Module contents
Module contents

Module contents

Quickstart

Login

First log in using your username and password.

login screen

You can see overview page of fresh organization, without any running resources. Let’s create some.

empty overview screen

First cluster

First you need to create provisioner instance, which represents single endpoint in specific backend e.g. single GCE project or single AKS tenant. You can provision all your Kubernetes clusters through this provisioner instance or you can create another one for different project/tenant in the same backend and/or another backend.

create provisioner

After you provide the necessary informations and submit the form, you can see your provisioner on the overview screen, provisioner status represents the availability of the backend at the time of provisioner creation.

overview screen with created provisioner

Now we are set for deploying clusters to the selected backend. On the Cluster Deploy screen you need to select your existing provisioner and fill in parameters specific for backend implemented by your provisioner.

cluster deploy

After you submit the form, you can see your new cluster on the overview page in the “Deploying” state.

overview screen with deploying cluster

Review your cluster

You can check the cluster detail page for more informations about your workload. Right after the deployment you need to wait before the cluster is provisioned.

cluster detail during provisioning

Then you can see all your running deployments, pods and services as well as images and volumes in the Status tab of this detail page. In the Topology tab you can see your resources in graph visualization of your choice.

cluster detail status
cluster detail topology

Manage users in your Organization

You can review your organization from the Manage Organization page.

top bar menu
empty manage organization page

Admin user can invite more users to his organization as member users. Just hit the Invite Member button and fill in new member’s e-mail address.

invite member form

New members are considered inactive until they set their password via link provided in the e-mail. This e-mail can be resent with the Resend invitation button next to the respective user if needed.

manage organization page with pending user

After they set the password, new users are considered active and can log into the application.

manage organization page with active user

Indices and tables