Use the Platform dashboard

For platform teams. The Platform dashboard is a web site where you read the state of the control plane and manage provisioners. This page says what each page is for, so that you know where to look first.

The dashboard has its own address. It is a different address from the address of the control plane. The platform team that deploys the dashboard sets it in the setting public-url. Deploy the dashboard shows how.

Sign in

1. Open the address of the dashboard. The page shows Sign in to continue.
2. Choose Sign in. You sign in with your account at your identity provider.
3. The dashboard opens the page that you asked for.

What you can do depends on your role:

The menu on the left lists the five pages: Overview, Provisioners, Runs, Applications and Audit. On a narrow screen, the button Menu opens it. The header has a button for the colour theme and the button Sign out.

Every page has its own address. You can bookmark a page, open it in a new tab, and use the Back button of the browser.

Overview

The page Overview answers the question: is the control plane up, and what ran last? It has three blocks:

• Control plane shows the status Up, Down or Unknown. The dashboard reads the readiness check. Check health and follow a run explains it.
• Provisioners shows how many provisioners are registered, with a link to the list. When none is registered, it offers the link Register a provisioner.
• Latest runs shows the five newest runs, each with its short ID, its application, its environment, its kind and its status.

Provisioners

The page Provisioners lists the registered provisioners. The columns are Name, URL, Types and Async limit. The column Types shows how many types a provisioner claims. The column Async limit shows the longest wait, or None. The filter Name contains narrows the list. The filter is part of the address.

• Register a provisioner opens the form. Register a provisioner lists the fields.
• A click on a name opens the page of that provisioner. It shows the name, the address, the async limit, the ID and the table of its types. It also shows the time of the registration and the time of the last change.
• Edit opens the form with the current values. A change replaces the whole registration.
• Deregister opens a dialog. The dialog says that plan and apply for these types fail until another provisioner claims them. You must type the exact name of the provisioner before the button works.

Runs

The page Runs lists the plan and apply runs, newest first. The columns are Run, Application, Environment, Kind, Status and Started. The filters are Application id, Environment, Kind, Status, Started after and Started before. The filters are part of the address. The button Load more runs shows the next runs.

A click on a run opens its page:

• The top shows the status and the facts of the run: ID, kind, application, environment, the times and the trace ID. It also shows the role that started the run (Authority).
• When they apply, it shows the refusal reason, who abandoned the run, and the drift that was not checked.
• The table Groups has one line for each kind and type of resource, with the state, the time and the number of changes. Investigate a failed run explains it.
• The list Events is the log of the run.

A run that is still going updates by itself. The dashboard asks for new events every few seconds, and it announces them to a screen reader. The page shows Following live. while it does. The button Pause stops the follow, and Resume starts it again. The follow stops when the run ends, when you leave the page, when your session ends, and after 30 minutes. After 30 minutes, the button Continue following starts it again. The log shows the first 1000 events.

The page does not show a button to release a lock. Release a stuck apply lock uses the CLI.

Applications

The page Applications lists the registered applications with their owners. The columns are Application and Owner. The filter Owner id narrows the list. The list is in pages, and each page has buttons to move between the pages.

Audit

The page Audit lists who did what, newest first. The filters are the action, the outcome, the application ID, the run ID, and the times From and To. Read and manage the audit trail explains the columns and the actions.

What an owner sees

A person with the role owner:<team> sees the runs, the applications and the audit events of the applications of that team. The audit page hides the user ID of an operator. The pages Overview and Provisioners answer Operator role needed.

What the dashboard says when something fails

The dashboard shows its own fixed text for a failed call. It does not show the reason that the control plane gave. The text depends on the status of the answer:

In the form of a provisioner, a 409 says that a type is already claimed. A 400 tells you to check the name, the address, the types and the async limit. To see the exact reason, make the same call with curl. Register a provisioner lists the reasons.

When your session ends, the page shows Session ended with a link to sign in again. What you typed in a form stays on the page.

Tasks that you do with the CLI or the API

• Release an apply lock with joomiz runs abandon. Release a stuck apply lock shows how.
• Erase a person from the audit trail with POST /audit-erasures. Read and manage the audit trail shows how.
• Register an application, and plan and apply, with joomiz register, joomiz plan and joomiz apply.
• Add a type to the catalog. Own the catalog of types shows how.

Related pages

• Register a provisioner shows the form step by step.
• Investigate a failed run shows how to read a run.