Skip to content

Commit 224a222

Browse files
egorpavlikhinclaude
andcommitted
docs: add kubernetes live-status examples and code structure entry
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0fe7c83 commit 224a222

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ pkg/
260260
cmd/ # contains sub-packages for each cobra command
261261
account/ # contains commands related to accounts
262262
environment/ # contains commands related to environments
263+
kubernetes/ # contains commands related to Kubernetes observability (live status)
263264
... # more commands
264265
constants/ # constant values to avoid duplicated strings, ints, etc
265266
errors/ # internal error objects

examples.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,32 @@ octopus deployment-target ssh create \
122122

123123
Note: The `--role` flag continues to work for backwards compatibility but will be deprecated in favor of `--tag` once target tag sets are widely adopted.
124124

125+
# View Kubernetes live object status
126+
127+
Check the live status of Kubernetes resources deployed to an environment:
128+
129+
```
130+
octopus kubernetes live-status --project "K8s Smoke Test Demo" --environment Development --no-prompt
131+
```
132+
133+
Get a summary of the overall health status:
134+
135+
```
136+
octopus kubernetes live-status --project "K8s Smoke Test Demo" --environment Development --summary-only --no-prompt
137+
```
138+
139+
For tenanted deployments:
140+
141+
```
142+
octopus kubernetes live-status --project "K8s Smoke Test Demo" --environment Production --tenant "My Tenant" --no-prompt
143+
```
144+
145+
The `k8s` alias can be used as a shorthand:
146+
147+
```
148+
octopus k8s live-status --project "K8s Smoke Test Demo" --environment Development -f json --no-prompt
149+
```
150+
125151
# Bulk deleting releases by created date
126152

127153
This example will delete all releases created before 2AM 6 Dec 2022 UTC

0 commit comments

Comments
 (0)