Dashboard Tour
The dashboard is where you prepare what your pipelines need, and where you read what they did. This page walks through it in the order you will likely use it, then lists every page.
Your First Steps
A pipeline run needs three things from the dashboard: somewhere to run, a key to report with, and a place to look at the results.
- Connect a cloud account, on the Clouds page. Cadence.CI starts the machines of your steps in that account, and stops them afterwards. See Connect a Cloud.
- Create a run token, on the Keys page. Your CI job or your machine gives it to the program, which then reports its runs and asks for machines. See Keys.
- Launch your program, then open Runs or Groups to follow it. See View Results.
The Quickstart does these three steps with the CI/CD template.
Later, as your pipelines grow, you may:
- store secrets on Cadence.CI, such as deploy keys, with rules saying which runs read them (Secrets);
- keep caches and artifacts in a bucket of your own, copied to a second one if you like (Storage);
- check your quotas and move to another plan (Organization and Plan).
The Pages
The menu groups the pages in three parts.
Execution: what ran.
| Page | What it shows |
|---|---|
| Groups | Each execution group: a direct run and every run it started, with the resources they requested over time. |
| Runs | Every run, newest first, with its status, entrypoint, resources and duration. |
Resources: what your pipelines use.
| Page | What it shows |
|---|---|
| Clouds | Your connected cloud accounts, the machines Cadence.CI started in them, and the providers you can connect. |
| Clusters | Clusters you operate yourself, when you use them (see Deploying Clusters). |
| Storage | Where caches and artifacts are kept, the caches, the artifacts, and the storages you can add. |
| Keys | The tokens your CI jobs, programs and other systems use to reach Cadence.CI. |
| Secrets | The secrets stored on Cadence.CI, the rules saying which runs read them, and every access. |
Account: you and your organization.
| Page | What it shows |
|---|---|
| Profile | Your name, language, country and time zone, and the organizations you belong to, to switch between them. |
| Organization | Its members, its plan, and how much of each quota it uses. |
| Upgrade | The checkout, to move to another plan. |
The Integration Browser, under Tools, opens programs in your browser to explore them, examples included.
Roles
Each member of an organization holds a role. The pages show the same things to everyone, and hide the actions a role does not allow.
| Action | Member | Operator | Administrator |
|---|---|---|---|
| Read runs, groups, caches and artifacts | ✓ | ✓ | ✓ |
| Connect clouds, write secrets, delete caches, change the access and expiry of artifacts, manage cache scopes | ✓ | ✓ | |
| Invite members, add storage, create artifact tokens, lock and delete artifacts, remove cache scopes, read leaked token reports | ✓ |
How the Pages Look
Every page follows the same layout, so that what you learn on one applies to the others:
- the title, with one short line saying what the page is for; the info icon at its end gives the details, which this documentation repeats at length;
- the page’s own actions on the right of the title, such as Get Artifact Token on the Storage page or Get Cluster Token on the Clusters page, which lead to the Keys page with the right form open;
- sections, each with its title and its short line;
- tiles for the things you connect, cloud accounts and storages alike, with what they are, where they are, and their state;
- tables for lists, where a line opens its details.
Going Further
- Concepts: the words used across the dashboard.
- What Goes Through Cadence.CI: what Cadence.CI receives, and what stays in your account.