diff --git a/docs/cmd/gotk_export_alert-provider.md b/docs/cmd/gotk_export_alert-provider.md index 2f7418d2..368c8975 100644 --- a/docs/cmd/gotk_export_alert-provider.md +++ b/docs/cmd/gotk_export_alert-provider.md @@ -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 diff --git a/docs/cmd/gotk_export_alert.md b/docs/cmd/gotk_export_alert.md index 9e59d423..86222f76 100644 --- a/docs/cmd/gotk_export_alert.md +++ b/docs/cmd/gotk_export_alert.md @@ -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 diff --git a/docs/cmd/gotk_export_receiver.md b/docs/cmd/gotk_export_receiver.md index dd2aa53e..a9b0df63 100644 --- a/docs/cmd/gotk_export_receiver.md +++ b/docs/cmd/gotk_export_receiver.md @@ -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 diff --git a/docs/cmd/gotk_get.md b/docs/cmd/gotk_get.md index aeb9304a..47f1ba03 100644 --- a/docs/cmd/gotk_get.md +++ b/docs/cmd/gotk_get.md @@ -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 diff --git a/docs/cmd/gotk_get_alert-providers.md b/docs/cmd/gotk_get_alert-providers.md new file mode 100644 index 00000000..e4827a67 --- /dev/null +++ b/docs/cmd/gotk_get_alert-providers.md @@ -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 + diff --git a/docs/cmd/gotk_get_alerts.md b/docs/cmd/gotk_get_alerts.md new file mode 100644 index 00000000..4a403d00 --- /dev/null +++ b/docs/cmd/gotk_get_alerts.md @@ -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 + diff --git a/docs/cmd/gotk_get_receivers.md b/docs/cmd/gotk_get_receivers.md new file mode 100644 index 00000000..211370c7 --- /dev/null +++ b/docs/cmd/gotk_get_receivers.md @@ -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 +