Skip to content
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.

Sign up for GitHub

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

docs: add statusbadge.url override information #21529

Merged
merged 1 commit into from
Jan 20, 2025
Merged

docs: add statusbadge.url override information #21529

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/user-guide/status-badge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ The feature can be enabled using `statusbadge.enabled` key of `argocd-cm` Config
![healthy and synced](../assets/status-badge-healthy-synced.png)

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 `argocd-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 .
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.

Display the application name in the status badge.

Available values: `true/false`

Expand All @@ -25,6 +30,7 @@ Default value: `false`
Example: `&showAppName=true`

### revision

Display revision targeted by the application.

It will also extend the badge width to 192px.
Expand All @@ -34,8 +40,10 @@ Available values: `true/false`
Default value: `false`

Example: `&revision=true`

### keepFullRevision
By default, displayed revision is truncated to 7 characters.

By default, displayed revision is truncated to 7 characters.

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

Expand All @@ -46,7 +54,9 @@ Available values: `true/false`
Default value: `false`

Example: `&keepFullRevision=true`

### width

Change width of the badge.

Completely replace current calculated width.
Expand All @@ -55,4 +65,4 @@ Available values: `integer`

Default value: `nil`

Example: `&width=500`
Example: `&width=500`
Loading