mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-30 09:51:23 +00:00
Better documentation for the resource and status commands.
This commit is contained in:
22
cmd/resource/status/docs/commands/events.md
Normal file
22
cmd/resource/status/docs/commands/events.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## events
|
||||
|
||||
[Alpha] Poll the cluster until all provided resources have become Current and list the status change events.
|
||||
|
||||
### Synopsis
|
||||
|
||||
[Alpha] Poll the cluster for the state of all the provided resources until either they have all become
|
||||
Current or the timeout is reached. The output will be status change events.
|
||||
|
||||
The list of resources which should be polled are provided as manifests either on the filesystem or
|
||||
on StdIn.
|
||||
|
||||
DIR:
|
||||
Path to local directory. If not provided, input is expected on StdIn.
|
||||
|
||||
### Examples
|
||||
|
||||
# Read resources from the filesystem and wait up to 1 minute for all of them to become Current
|
||||
resource status events my-dir/
|
||||
|
||||
# Fetch all resources in the cluster and wait up to 5 minutes for all of them to become Current
|
||||
kubectl get all --all-namespaces -oyaml | resource status events --timeout=5m
|
||||
21
cmd/resource/status/docs/commands/fetch.md
Normal file
21
cmd/resource/status/docs/commands/fetch.md
Normal file
@@ -0,0 +1,21 @@
|
||||
## fetch
|
||||
|
||||
[Alpha] Fetch the state of the provided resources from the cluster and display status in a table.
|
||||
|
||||
### Synopsis
|
||||
|
||||
[Alpha] Fetches the state of all provided resources from the cluster and displays the status in
|
||||
a table.
|
||||
|
||||
The list of resources are provided as manifests either on the filesystem or on StdIn.
|
||||
|
||||
DIR:
|
||||
Path to local directory.
|
||||
|
||||
### Examples
|
||||
|
||||
# Read resources from the filesystem and wait up to 1 minute for all of them to become Current
|
||||
resource status fetch my-dir/
|
||||
|
||||
# Fetch all resources in the cluster and wait up to 5 minutes for all of them to become Current
|
||||
kubectl get all --all-namespaces -oyaml | resource status fetch
|
||||
22
cmd/resource/status/docs/commands/wait.md
Normal file
22
cmd/resource/status/docs/commands/wait.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## wait
|
||||
|
||||
[Alpha] Poll the cluster until all provided resources have become Current and display progress in a table.
|
||||
|
||||
### Synopsis
|
||||
|
||||
[Alpha] Poll the cluster for the state of all the provided resources until either they have all become
|
||||
Current or the timeout is reached. The output will be presented as a table.
|
||||
|
||||
The list of resources which should be polled are provided as manifests either on the filesystem or
|
||||
on StdIn.
|
||||
|
||||
DIR:
|
||||
Path to local directory. If not provided, input is expected on StdIn.
|
||||
|
||||
### Examples
|
||||
|
||||
# Read resources from the filesystem and wait up to 1 minute for all of them to become Current
|
||||
resource status wait my-dir/
|
||||
|
||||
# Fetch all resources in the cluster and wait up to 5 minutes for all of them to become Current
|
||||
kubectl get all --all-namespaces -oyaml | resource status wait --timeout=5m
|
||||
Reference in New Issue
Block a user