Dashboards
Description
Udash has three main screens: the reports list, a single report, and the Git dashboard. Labels from your Updatecli manifests drive the filters on all of them. You can try every screen described here on updatecli.uda.sh, the public instance the Updatecli project publishes to.
The home page also has a Get Started panel with the commands to connect Updatecli to this instance, filled in with its own URLs. Send that page to a colleague you are onboarding.
Reports
At /pipeline/reports, the reports for one Git repository and branch, with a summary of their
latest status.
| Filter | What it does |
|---|---|
Git repository and branch | Narrows to one repository, and optionally one branch. Only pipelines with an |
Labels | Key and value pairs. See Filtering by label. |
Pipeline result | Success, Changed, Failed, or Skipped. Empty means all of them. |
Open pull request | Whether the pipeline left a pull request open. A successful pipeline can still be waiting on a pull request nobody merged. |
Date range | Opens on the most recent day. Widen it to look further back. |
Tip |
|
A single report
At /pipeline/reports/<id>, the full run: its sources, conditions, targets, and actions with the
configuration each one ran with, the changelog Updatecli retrieved, and the console output. This
is the page Updatecli links to at the end of a run.
Git dashboard
At /scm/dashboard, the status of every Git repository and branch at once, which answers "how up
to date is this codebase". A label filter here turns it into a dashboard for one team or one
ecosystem across the whole organisation.
Only pipelines with an scm appear here.
Filtering by label
Udash has no saved dashboards or groups. A group of pipelines is whatever a label filter selects, and the labels come from your manifests.
| Filter | Selects |
|---|---|
A key and a value | Pipelines whose label has exactly that value. Case matters. |
A key with no value | Pipelines that carry the key, whatever its value. |
Several rows | Pipelines matching all of them. |
There is no OR, so "every docker or helm pipeline" cannot be one view. The rules match the
--labels flag of Updatecli.
Choosing labels
Start from the views you want, and give each question its own key:
| View you want | Label that produces it |
|---|---|
Everything the platform team owns |
|
Every container image, in every repository |
|
The pipelines that must never fall behind |
|
The platform team’s patch updates |
|
Separate keys can be combined into narrower views later. A single group: platform-docker label
cannot be split back into a team and an ecosystem.
Keep the values few and stable. A label holding a version number or a file path fills the filter with values nobody picks.
These keys come from the suggested vocabulary. It is a recommendation, and neither Updatecli nor Udash validates labels. Following it helps pipelines written by different people line up under the same filter.
Labels on pipelines you do not write
Labels on an autodiscovery manifest are copied onto every pipeline it generates, see
Labels and autodiscovery.
Many published policies take their pipeline labels from a pipeline.labels value:
policies:
- name: Rust dependencies
policy: ghcr.io/updatecli/policies/autodiscovery/cargo:0.9.1@sha256:237c49b0541ad1a5ce9bcdfef0a525dd47ff854436dee61985b56f2c981c828d
values:
- values.yaml
scm:
enabled: true
kind: github
owner: my-org
repository: my-crate
branch: main
# Pull request labels, applied on GitHub. Udash never sees these.
labels:
- dependencies
# Pipeline labels, stored with every report and offered by the Udash filters.
pipeline:
labels:
ecosystem: cargo
policy: autodiscovery
team: platform
Important | The top-level |
Renaming a label
Reports keep the labels they were published with. After renaming team: infra to
team: platform, the new value only matches reports published since the change.
Sharing a view
The whole filter, labels included, is stored in the URL. Once a view shows what you want, copy the address and share it. A list of such links, one per team or ecosystem, is the closest Udash has to saved dashboards.
Go further
Labels - the
labelsfield and the suggested vocabulary.Sending reports - the
scmand labels these views depend on.updatecli/udash - the API, for querying reports programmatically.