Update docs

pull/302/head
Philip Laine 5 years ago
parent 65b8942416
commit 55cee488bc

@ -14,7 +14,7 @@ gotk export alert-provider [name] [flags]
```
# Export all Provider resources
gotk export ap --all > kustomizations.yaml
gotk export ap --all > alert-providers.yaml
# Export a Provider
gotk export ap slack > slack.yaml

@ -14,7 +14,7 @@ gotk export alert [name] [flags]
```
# Export all Alert resources
gotk export alert --all > kustomizations.yaml
gotk export alert --all > alerts.yaml
# Export a Alert
gotk export alert main > main.yaml

@ -14,7 +14,7 @@ gotk export receiver [name] [flags]
```
# Export all Receiver resources
gotk export rcv --all > kustomizations.yaml
gotk export rcv --all > receivers.yaml
# Export a Receiver
gotk export rcv main > main.yaml

@ -25,10 +25,10 @@ The get sub-commands print the statuses of sources and resources.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk get alert](gotk_get_alert.md) - Get Alert statuses
* [gotk get alert-provider](gotk_get_alert-provider.md) - Get Provider statuses
* [gotk get alert-providers](gotk_get_alert-providers.md) - Get Provider statuses
* [gotk get alerts](gotk_get_alerts.md) - Get Alert statuses
* [gotk get helmreleases](gotk_get_helmreleases.md) - Get HelmRelease statuses
* [gotk get kustomizations](gotk_get_kustomizations.md) - Get Kustomization statuses
* [gotk get receiver](gotk_get_receiver.md) - Get Receiver statuses
* [gotk get receivers](gotk_get_receivers.md) - Get Receiver statuses
* [gotk get sources](gotk_get_sources.md) - Get source statuses

@ -0,0 +1,40 @@
## gotk get alert-providers
Get Provider statuses
### Synopsis
The get alert-provider command prints the statuses of the resources.
```
gotk get alert-providers [flags]
```
### Examples
```
# List all Providers and their status
gotk get alert-providers
```
### Options
```
-h, --help help for alert-providers
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-n, --namespace string the namespace scope for this operation (default "gotk-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources

@ -0,0 +1,40 @@
## gotk get alerts
Get Alert statuses
### Synopsis
The get alert command prints the statuses of the resources.
```
gotk get alerts [flags]
```
### Examples
```
# List all Alerts and their status
gotk get alerts
```
### Options
```
-h, --help help for alerts
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-n, --namespace string the namespace scope for this operation (default "gotk-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources

@ -0,0 +1,40 @@
## gotk get receivers
Get Receiver statuses
### Synopsis
The get receiver command prints the statuses of the resources.
```
gotk get receivers [flags]
```
### Examples
```
# List all Receiver and their status
gotk get receivers
```
### Options
```
-h, --help help for receivers
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-n, --namespace string the namespace scope for this operation (default "gotk-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
Loading…
Cancel
Save