Skip to content

Commit

Permalink
docs: Add all-namespace related annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
NoUseFreak committed Mar 16, 2024
1 parent 1f1064d commit 30dc972
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ helm install k8status --namespace mynamespace k8status/k8status

## Annotations

You can add these Kubernetes annotations to specific service objects to customize k8status's behaviour.
You can add these Kubernetes annotations to specific objects to customize k8status's behaviour.

__Service__

`k8status.stenic.io/name`
(string) Overwrite the name shown in the report.
Expand All @@ -29,6 +31,14 @@ You can add these Kubernetes annotations to specific service objects to customiz
`k8status.stenic.io/description`
(string) Add additional description to the service.

__Namespace__ (Only used if `--namespace` is not set)

`k8status.stenic.io/include`
(bool) Include the namespace in the report.

`k8status.stenic.io/name`
(string) Overwrite the name shown in the report.

## UI

`?mode=tv`
Expand All @@ -43,4 +53,4 @@ Refresh the data every second.
```
docker build -t k8status .
docker run -ti -p 8080:8080 -v ~/.kube:/home/nonroot/.kube k8status --namespace default
```
```

0 comments on commit 30dc972

Please sign in to comment.