Files
deploy/docs/user-guide/status-badge.md
zeekayandHanzo Dev 446e343a3d cd: annotations are cd.hanzo.ai, API group is apps.hanzo.ai
Two corrections on top of the naming pass, both found by checking the live
cluster rather than the source.

The rename had silently changed the user-facing annotation key from
argocd.argoproj.io/sync-wave to cd.argoproj.io/sync-wave — 63 live
Applications carry the old key, so deploying that would have ignored every
sync-wave and broken fleet deploy ordering. The key is now cd.hanzo.ai/*,
and universe 575650286 moves the ApplicationSet template that stamps it, so
the controller regenerates all 63 consistently.

The API group in code said argoproj.io/v1alpha1 in 157 places while the
cluster has served apps.hanzo.ai/v1alpha1 since 2026-07-23 (the CRDs are
applications.apps.hanzo.ai). Code now matches what is actually served.

The legacy applications.argoproj.io/app-name label had ZERO live users, so it
went with the rest. foo.argoproj.io test fixtures became foo.example.com —
arbitrary test domains should not carry a vendor name.

go build ./... exit 0.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-28 16:32:14 -07:00

2.0 KiB

Status Badge

Hanzo CD can display a badge with health and sync status for any application. The feature is disabled by default because badge image is available to any user without authentication. The feature can be enabled using statusbadge.enabled key of cd-cm ConfigMap (see cd-cm.yaml).

healthy and synced

To show this badge, use the following URL format ${argoCdBaseUrl}/api/badge?name=${appName}, e.g. http://localhost:8080/api/badge?name=guestbook.

To override the ${argoCdBaseUrl} value, you can use the statusbadge.url key of cd-cm ConfigMap.

The URLs for status image are available on application details page:

  1. Navigate to application details page and click on 'Details' button.
  2. Scroll down to 'Status Badge' section.
  3. Select required template such as URL, Markdown etc. for the status image URL in markdown, html, etc are available .
  4. Copy the text and paste it into your README or website.

Additional query parameters options

showAppName

Display the application name in the status badge.

Available values: true/false

Default value: false

Example: &showAppName=true

revision

Display revision targeted by the application.

It will also extend the badge width to 192px.

In multiple sources setup, revision of first defined source will be displayed.

Available values: true/false

Default value: false

Example: &revision=true

keepFullRevision

By default, displayed revision is truncated to 7 characters.

This parameter allows to display it fully if it exceeds that length.

It will also extend the badge width to 400px.

Available values: true/false

Default value: false

Example: &keepFullRevision=true

width

Change width of the badge.

Completely replace current calculated width.

Available values: integer

Default value: nil

Example: &width=500