-
Notifications
You must be signed in to change notification settings - Fork 33
docs: add Udash documentation and document relative paths #3687
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
olblak
wants to merge
4
commits into
updatecli:master
Choose a base branch
from
olblak:udash/documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
22 changes: 22 additions & 0 deletions
22
assets/code_example/docs/core/configuration/relativepaths.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: Keep the chart image tag in sync | ||
|
|
||
| options: | ||
| # "Chart.yaml" and "values.yaml" below are looked up next to this manifest, | ||
| # whatever directory updatecli was started from. | ||
| relativepaths: manifest | ||
|
|
||
| sources: | ||
| version: | ||
| name: Read the chart version | ||
| kind: yaml | ||
| spec: | ||
| file: Chart.yaml | ||
| key: $.version | ||
|
|
||
| targets: | ||
| tag: | ||
| name: Report it as the image tag | ||
| kind: yaml | ||
| spec: | ||
| file: values.yaml | ||
| key: $.image.tag |
5 changes: 5 additions & 0 deletions
5
assets/code_example/docs/udash/dashboards/updatecli-compose.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| policies: | ||
| - name: Rust dependencies | ||
| policy: ghcr.io/updatecli/policies/autodiscovery/cargo:0.9.1@sha256:237c49b0541ad1a5ce9bcdfef0a525dd47ff854436dee61985b56f2c981c828d | ||
| values: | ||
| - values.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "AUTH_ENABLED": false, | ||
| "API_BASE_URL": "/api", | ||
| "APP_BASE_PATH": "/", | ||
| "MAX_HISTORY_DAYS": 30 | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| server: | ||
| auth: | ||
| # No authentication: anyone reaching this instance can read and write reports. | ||
| # Fine on a laptop, never on anything reachable from outside. | ||
| mode: "none" | ||
|
|
||
| database: | ||
| uri: postgres://udash:password@db:5432/udash?sslmode=disable | ||
| migrationdisabled: false |
50 changes: 50 additions & 0 deletions
50
assets/code_example/docs/udash/quick-start/docker-compose.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| services: | ||
| db: | ||
| image: postgres:18@sha256:5a5a84b19854a9ffaa54082c166ff4ec27473a361e496e5ea167f298f2da9722 | ||
| restart: always | ||
| environment: | ||
| - POSTGRES_USER=udash | ||
| - POSTGRES_PASSWORD=password | ||
| - POSTGRES_DB=udash | ||
| expose: | ||
| - 5432 | ||
|
|
||
| server: | ||
| image: ghcr.io/updatecli/udash:v0.18.2@sha256:899c2e3a7bf8b4aea588ba4ca398ce4ca1626479ab96881aa69ad6a18964fae1 | ||
| command: server start | ||
| restart: always | ||
| environment: | ||
| - GIN_MODE=release | ||
| volumes: | ||
| - "./udash/config.yaml:/home/udash/.udash/config.yaml" | ||
| expose: | ||
| - 8080 | ||
| labels: | ||
| - "traefik.enable=true" | ||
| - "traefik.http.routers.server.rule=PathPrefix(`/api/`)" | ||
| - "traefik.http.routers.server.service=server" | ||
| - "traefik.http.services.server.loadbalancer.server.port=8080" | ||
|
|
||
| front: | ||
| image: ghcr.io/updatecli/udash-front:v0.26.0@sha256:21d5c66f6872907f5a83da1a07bde6fa1b46bd74d7e56898b52f0a6b5a8e7654 | ||
| restart: always | ||
| volumes: | ||
| - "./udash-front/config.json:/usr/share/nginx/html/config.json" | ||
| expose: | ||
| - 80 | ||
| labels: | ||
| - "traefik.enable=true" | ||
| - "traefik.http.routers.front.rule=PathPrefix(`/`)" | ||
| - "traefik.http.routers.front.service=front" | ||
| - "traefik.http.services.front.loadbalancer.server.port=80" | ||
|
|
||
| traefik: | ||
| image: traefik:v3.7@sha256:24841fe2de7304c149343d877d2923b4c8800a38ba015dea9174c23b20e344a0 | ||
| command: | ||
| - "--providers.docker=true" | ||
| - "--providers.docker.exposedbydefault=false" | ||
| - "--entrypoints.web.address=:80" | ||
| ports: | ||
| - "80:80" | ||
| volumes: | ||
| - "/var/run/docker.sock:/var/run/docker.sock:ro" | ||
3 changes: 3 additions & 0 deletions
3
assets/code_example/docs/udash/quick-start/updatecli-compose.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| policies: | ||
| - name: Discover what could be updated here | ||
| policy: ghcr.io/updatecli/policies/autodiscovery/all:0.7.0@sha256:09bd79160f4ecda4d8323b25815a733d39334c22544aaa6ac5859f0d3ef9fa79 |
37 changes: 37 additions & 0 deletions
37
assets/code_example/docs/udash/sending-reports/updatecli.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: Bump the base image | ||
| pipelineid: docker/base-image | ||
|
|
||
| labels: | ||
| ecosystem: docker | ||
| monitor: active | ||
|
|
||
| # The scm files the reports under this Git repository in Udash. | ||
| scms: | ||
| default: | ||
| kind: github | ||
| spec: | ||
| owner: my-org | ||
| repository: my-service | ||
| branch: main | ||
| token: '{{ requiredEnv "GITHUB_TOKEN" }}' | ||
|
|
||
| sources: | ||
| alpine: | ||
| name: Get the latest Alpine version | ||
| kind: dockerimage | ||
| spec: | ||
| image: alpine | ||
| versionfilter: | ||
| kind: semver | ||
|
|
||
| targets: | ||
| dockerfile: | ||
| name: Update the Alpine base image | ||
| kind: dockerfile | ||
| scmid: default | ||
| sourceid: alpine | ||
| spec: | ||
| file: Dockerfile | ||
| instruction: | ||
| keyword: FROM | ||
| matcher: alpine |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: "Udash" | ||
| description: "Publish your Updatecli pipeline reports to Udash, the Updatecli dashboard, and follow update activity across every repository." | ||
| lead: "" | ||
| date: 2026-08-07T10:00:00+02:00 | ||
| lastmod: 2026-09-24T10:00:00+02:00 | ||
| draft: false | ||
| images: [] | ||
| sidebar: | ||
| collapsed: true | ||
| --- | ||
|
|
||
| Updatecli tells you what changed on one run, in one repository. [Udash](https://github.com/updatecli/udash) | ||
| keeps those runs, so you can see the same information across every repository and over time. | ||
|
|
||
| To see it in use, browse [updatecli.uda.sh](https://updatecli.uda.sh), the public instance the | ||
| Updatecli project publishes its own pipeline reports to. | ||
|
|
||
| {{< alert icon="⚠️" text="Udash is experimental, and so is the Updatecli side of it. Publishing reports requires the <code>--experimental</code> flag, and both the API and the interface can change without going through the usual deprecation cycle." >}} | ||
|
|
||
| - [Introduction](/docs/udash/introduction/) - what Udash is and how Updatecli feeds it. | ||
| - [Quick start](/docs/udash/quick-start/) - run Udash locally with Docker Compose and publish your | ||
| first report. | ||
| - [Sending reports](/docs/udash/sending-reports/) - connect Updatecli to an instance, locally or | ||
| from CI. | ||
| - [Dashboards](/docs/udash/dashboards/) - find your pipelines, filter them with labels, and share a | ||
| view. | ||
|
|
||
| Deploying, configuring, and securing a Udash instance, the agent, and the API are documented in the | ||
| [updatecli/udash](https://github.com/updatecli/udash) repository. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.