From 94cf7c329ca98dbc37f8f8383fcec39677a20269 Mon Sep 17 00:00:00 2001 From: Philip Laine Date: Tue, 13 Oct 2020 10:46:44 +0200 Subject: [PATCH] Update docs --- docs/cmd/gotk_create.md | 3 ++ docs/cmd/gotk_create_alert-provider.md | 57 +++++++++++++++++++++++ docs/cmd/gotk_create_alert.md | 49 +++++++++++++++++++ docs/cmd/gotk_create_receiver.md | 52 +++++++++++++++++++++ docs/cmd/gotk_delete.md | 3 ++ docs/cmd/gotk_delete_alert-provider.md | 40 ++++++++++++++++ docs/cmd/gotk_delete_alert.md | 40 ++++++++++++++++ docs/cmd/gotk_delete_receiver.md | 40 ++++++++++++++++ docs/cmd/gotk_export.md | 3 ++ docs/cmd/gotk_export_alert-provider.md | 43 +++++++++++++++++ docs/cmd/gotk_export_alert.md | 43 +++++++++++++++++ docs/cmd/gotk_export_receiver.md | 43 +++++++++++++++++ docs/cmd/gotk_get.md | 3 ++ docs/cmd/gotk_get_alert-provider.md | 40 ++++++++++++++++ docs/cmd/gotk_get_alert.md | 40 ++++++++++++++++ docs/cmd/gotk_get_receiver.md | 40 ++++++++++++++++ docs/cmd/gotk_reconcile.md | 3 ++ docs/cmd/gotk_reconcile_alert-provider.md | 39 ++++++++++++++++ docs/cmd/gotk_reconcile_alert.md | 39 ++++++++++++++++ docs/cmd/gotk_reconcile_receiver.md | 39 ++++++++++++++++ docs/cmd/gotk_resume.md | 2 + docs/cmd/gotk_resume_alert.md | 40 ++++++++++++++++ docs/cmd/gotk_resume_receiver.md | 40 ++++++++++++++++ docs/cmd/gotk_suspend.md | 2 + docs/cmd/gotk_suspend_alert.md | 39 ++++++++++++++++ docs/cmd/gotk_suspend_receiver.md | 39 ++++++++++++++++ 26 files changed, 821 insertions(+) create mode 100644 docs/cmd/gotk_create_alert-provider.md create mode 100644 docs/cmd/gotk_create_alert.md create mode 100644 docs/cmd/gotk_create_receiver.md create mode 100644 docs/cmd/gotk_delete_alert-provider.md create mode 100644 docs/cmd/gotk_delete_alert.md create mode 100644 docs/cmd/gotk_delete_receiver.md create mode 100644 docs/cmd/gotk_export_alert-provider.md create mode 100644 docs/cmd/gotk_export_alert.md create mode 100644 docs/cmd/gotk_export_receiver.md create mode 100644 docs/cmd/gotk_get_alert-provider.md create mode 100644 docs/cmd/gotk_get_alert.md create mode 100644 docs/cmd/gotk_get_receiver.md create mode 100644 docs/cmd/gotk_reconcile_alert-provider.md create mode 100644 docs/cmd/gotk_reconcile_alert.md create mode 100644 docs/cmd/gotk_reconcile_receiver.md create mode 100644 docs/cmd/gotk_resume_alert.md create mode 100644 docs/cmd/gotk_resume_receiver.md create mode 100644 docs/cmd/gotk_suspend_alert.md create mode 100644 docs/cmd/gotk_suspend_receiver.md diff --git a/docs/cmd/gotk_create.md b/docs/cmd/gotk_create.md index e433c236..c7dcc42a 100644 --- a/docs/cmd/gotk_create.md +++ b/docs/cmd/gotk_create.md @@ -27,7 +27,10 @@ The create sub-commands generate sources and resources. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk create alert](gotk_create_alert.md) - Create or update a Alert resource +* [gotk create alert-provider](gotk_create_alert-provider.md) - Create or update a Provider resource * [gotk create helmrelease](gotk_create_helmrelease.md) - Create or update a HelmRelease resource * [gotk create kustomization](gotk_create_kustomization.md) - Create or update a Kustomization resource +* [gotk create receiver](gotk_create_receiver.md) - Create or update a Receiver resource * [gotk create source](gotk_create_source.md) - Create or update sources diff --git a/docs/cmd/gotk_create_alert-provider.md b/docs/cmd/gotk_create_alert-provider.md new file mode 100644 index 00000000..a2b0e5c1 --- /dev/null +++ b/docs/cmd/gotk_create_alert-provider.md @@ -0,0 +1,57 @@ +## gotk create alert-provider + +Create or update a Provider resource + +### Synopsis + +The create alert-provider command generates a Provider resource. + +``` +gotk create alert-provider [name] [flags] +``` + +### Examples + +``` + # Create a Provider for a Slack channel + gotk create ap slack \ + --type slack \ + --channel general \ + --address https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK \ + --secret-ref webhook-url + + # Create a Provider for a Github repository + gotk create ap github-podinfo \ + --type github \ + --address https://github.com/stefanprodan/podinfo \ + --secret-ref github-token + +``` + +### Options + +``` + --address string path to either the git repository, chat provider or webhook + --channel string channel to send messages to in the case of a chat provider + -h, --help help for alert-provider + --secret-ref string name of secret containing authentication token + --type string type of provider + --username string bot username used by the provider +``` + +### Options inherited from parent commands + +``` + --export export in YAML format to stdout + --interval duration source sync interval (default 1m0s) + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + --label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2) + -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 create](gotk_create.md) - Create or update sources and resources + diff --git a/docs/cmd/gotk_create_alert.md b/docs/cmd/gotk_create_alert.md new file mode 100644 index 00000000..3b1e2adc --- /dev/null +++ b/docs/cmd/gotk_create_alert.md @@ -0,0 +1,49 @@ +## gotk create alert + +Create or update a Alert resource + +### Synopsis + +The create alert command generates a Alert resource. + +``` +gotk create alert [name] [flags] +``` + +### Examples + +``` + # Create an Alert for kustomization events + gotk create alert \ + --event-severity info \ + --event-source Kustomization/gotk-system \ + --provider-ref slack \ + gotk-system + +``` + +### Options + +``` + --event-severity string severity of events to send alerts for + --event-source stringArray sources that should generate alerts (/) + -h, --help help for alert + --provider-ref string reference to provider +``` + +### Options inherited from parent commands + +``` + --export export in YAML format to stdout + --interval duration source sync interval (default 1m0s) + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + --label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2) + -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 create](gotk_create.md) - Create or update sources and resources + diff --git a/docs/cmd/gotk_create_receiver.md b/docs/cmd/gotk_create_receiver.md new file mode 100644 index 00000000..2138d25f --- /dev/null +++ b/docs/cmd/gotk_create_receiver.md @@ -0,0 +1,52 @@ +## gotk create receiver + +Create or update a Receiver resource + +### Synopsis + +The create receiver command generates a Receiver resource. + +``` +gotk create receiver [name] [flags] +``` + +### Examples + +``` + # Create a Receiver + gotk create rcv github-receiver \ + --type github \ + --event ping \ + --event push \ + --secret-ref webhook-token \ + --resource GitRepository/webapp \ + --resource HelmRepository/webapp + +``` + +### Options + +``` + --event stringArray + -h, --help help for receiver + --resource stringArray + --secret-ref string + --type string +``` + +### Options inherited from parent commands + +``` + --export export in YAML format to stdout + --interval duration source sync interval (default 1m0s) + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + --label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2) + -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 create](gotk_create.md) - Create or update sources and resources + diff --git a/docs/cmd/gotk_delete.md b/docs/cmd/gotk_delete.md index 5f92dacc..7f9bc144 100644 --- a/docs/cmd/gotk_delete.md +++ b/docs/cmd/gotk_delete.md @@ -25,7 +25,10 @@ The delete sub-commands delete sources and resources. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk delete alert](gotk_delete_alert.md) - Delete a Alert resource +* [gotk delete alert-provider](gotk_delete_alert-provider.md) - Delete a Provider resource * [gotk delete helmrelease](gotk_delete_helmrelease.md) - Delete a HelmRelease resource * [gotk delete kustomization](gotk_delete_kustomization.md) - Delete a Kustomization resource +* [gotk delete receiver](gotk_delete_receiver.md) - Delete a Receiver resource * [gotk delete source](gotk_delete_source.md) - Delete sources diff --git a/docs/cmd/gotk_delete_alert-provider.md b/docs/cmd/gotk_delete_alert-provider.md new file mode 100644 index 00000000..e7772719 --- /dev/null +++ b/docs/cmd/gotk_delete_alert-provider.md @@ -0,0 +1,40 @@ +## gotk delete alert-provider + +Delete a Provider resource + +### Synopsis + +The delete alert-provider command removes the given Provider from the cluster. + +``` +gotk delete alert-provider [name] [flags] +``` + +### Examples + +``` + # Delete a Provider and the Kubernetes resources created by it + gotk delete ap slack + +``` + +### Options + +``` + -h, --help help for alert-provider +``` + +### Options inherited from parent commands + +``` + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + -n, --namespace string the namespace scope for this operation (default "gotk-system") + -s, --silent delete resource without asking for confirmation + --timeout duration timeout for this operation (default 5m0s) + --verbose print generated objects +``` + +### SEE ALSO + +* [gotk delete](gotk_delete.md) - Delete sources and resources + diff --git a/docs/cmd/gotk_delete_alert.md b/docs/cmd/gotk_delete_alert.md new file mode 100644 index 00000000..8feaa70b --- /dev/null +++ b/docs/cmd/gotk_delete_alert.md @@ -0,0 +1,40 @@ +## gotk delete alert + +Delete a Alert resource + +### Synopsis + +The delete alert command removes the given Alert from the cluster. + +``` +gotk delete alert [name] [flags] +``` + +### Examples + +``` + # Delete an Alert and the Kubernetes resources created by it + gotk delete alert main + +``` + +### Options + +``` + -h, --help help for alert +``` + +### Options inherited from parent commands + +``` + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + -n, --namespace string the namespace scope for this operation (default "gotk-system") + -s, --silent delete resource without asking for confirmation + --timeout duration timeout for this operation (default 5m0s) + --verbose print generated objects +``` + +### SEE ALSO + +* [gotk delete](gotk_delete.md) - Delete sources and resources + diff --git a/docs/cmd/gotk_delete_receiver.md b/docs/cmd/gotk_delete_receiver.md new file mode 100644 index 00000000..063ec5c3 --- /dev/null +++ b/docs/cmd/gotk_delete_receiver.md @@ -0,0 +1,40 @@ +## gotk delete receiver + +Delete a Receiver resource + +### Synopsis + +The delete receiver command removes the given Receiver from the cluster. + +``` +gotk delete receiver [name] [flags] +``` + +### Examples + +``` + # Delete an Receiver and the Kubernetes resources created by it + gotk delete receiver main + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### Options inherited from parent commands + +``` + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + -n, --namespace string the namespace scope for this operation (default "gotk-system") + -s, --silent delete resource without asking for confirmation + --timeout duration timeout for this operation (default 5m0s) + --verbose print generated objects +``` + +### SEE ALSO + +* [gotk delete](gotk_delete.md) - Delete sources and resources + diff --git a/docs/cmd/gotk_export.md b/docs/cmd/gotk_export.md index 6c01e19b..e312609d 100644 --- a/docs/cmd/gotk_export.md +++ b/docs/cmd/gotk_export.md @@ -25,7 +25,10 @@ The export sub-commands export resources in YAML format. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk export alert](gotk_export_alert.md) - Export Alert resources in YAML format +* [gotk export alert-provider](gotk_export_alert-provider.md) - Export Provider resources in YAML format * [gotk export helmrelease](gotk_export_helmrelease.md) - Export HelmRelease resources in YAML format * [gotk export kustomization](gotk_export_kustomization.md) - Export Kustomization resources in YAML format +* [gotk export receiver](gotk_export_receiver.md) - Export Receiver resources in YAML format * [gotk export source](gotk_export_source.md) - Export sources diff --git a/docs/cmd/gotk_export_alert-provider.md b/docs/cmd/gotk_export_alert-provider.md new file mode 100644 index 00000000..2f7418d2 --- /dev/null +++ b/docs/cmd/gotk_export_alert-provider.md @@ -0,0 +1,43 @@ +## gotk export alert-provider + +Export Provider resources in YAML format + +### Synopsis + +The export alert-provider command exports one or all Provider resources in YAML format. + +``` +gotk export alert-provider [name] [flags] +``` + +### Examples + +``` + # Export all Provider resources + gotk export ap --all > kustomizations.yaml + + # Export a Provider + gotk export ap slack > slack.yaml + +``` + +### Options + +``` + -h, --help help for alert-provider +``` + +### Options inherited from parent commands + +``` + --all select all resources + --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 export](gotk_export.md) - Export resources in YAML format + diff --git a/docs/cmd/gotk_export_alert.md b/docs/cmd/gotk_export_alert.md new file mode 100644 index 00000000..9e59d423 --- /dev/null +++ b/docs/cmd/gotk_export_alert.md @@ -0,0 +1,43 @@ +## gotk export alert + +Export Alert resources in YAML format + +### Synopsis + +The export alert command exports one or all Alert resources in YAML format. + +``` +gotk export alert [name] [flags] +``` + +### Examples + +``` + # Export all Alert resources + gotk export alert --all > kustomizations.yaml + + # Export a Alert + gotk export alert main > main.yaml + +``` + +### Options + +``` + -h, --help help for alert +``` + +### Options inherited from parent commands + +``` + --all select all resources + --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 export](gotk_export.md) - Export resources in YAML format + diff --git a/docs/cmd/gotk_export_receiver.md b/docs/cmd/gotk_export_receiver.md new file mode 100644 index 00000000..dd2aa53e --- /dev/null +++ b/docs/cmd/gotk_export_receiver.md @@ -0,0 +1,43 @@ +## gotk export receiver + +Export Receiver resources in YAML format + +### Synopsis + +The export receiver command exports one or all Receiver resources in YAML format. + +``` +gotk export receiver [name] [flags] +``` + +### Examples + +``` + # Export all Receiver resources + gotk export rcv --all > kustomizations.yaml + + # Export a Receiver + gotk export rcv main > main.yaml + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### Options inherited from parent commands + +``` + --all select all resources + --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 export](gotk_export.md) - Export resources in YAML format + diff --git a/docs/cmd/gotk_get.md b/docs/cmd/gotk_get.md index 22163ae1..aeb9304a 100644 --- a/docs/cmd/gotk_get.md +++ b/docs/cmd/gotk_get.md @@ -25,7 +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 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 sources](gotk_get_sources.md) - Get source statuses diff --git a/docs/cmd/gotk_get_alert-provider.md b/docs/cmd/gotk_get_alert-provider.md new file mode 100644 index 00000000..0a4a8896 --- /dev/null +++ b/docs/cmd/gotk_get_alert-provider.md @@ -0,0 +1,40 @@ +## gotk get alert-provider + +Get Provider statuses + +### Synopsis + +The get alert-provider command prints the statuses of the resources. + +``` +gotk get alert-provider [flags] +``` + +### Examples + +``` + # List all Providers and their status + gotk get alert-provider + +``` + +### Options + +``` + -h, --help help for alert-provider +``` + +### 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_alert.md b/docs/cmd/gotk_get_alert.md new file mode 100644 index 00000000..90457d46 --- /dev/null +++ b/docs/cmd/gotk_get_alert.md @@ -0,0 +1,40 @@ +## gotk get alert + +Get Alert statuses + +### Synopsis + +The get alert command prints the statuses of the resources. + +``` +gotk get alert [flags] +``` + +### Examples + +``` + # List all Alerts and their status + gotk get alert + +``` + +### Options + +``` + -h, --help help for alert +``` + +### 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_receiver.md b/docs/cmd/gotk_get_receiver.md new file mode 100644 index 00000000..e5de9e1c --- /dev/null +++ b/docs/cmd/gotk_get_receiver.md @@ -0,0 +1,40 @@ +## gotk get receiver + +Get Receiver statuses + +### Synopsis + +The get receiver command prints the statuses of the resources. + +``` +gotk get receiver [flags] +``` + +### Examples + +``` + # List all Receiver and their status + gotk get receiver + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### 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_reconcile.md b/docs/cmd/gotk_reconcile.md index 52e41d7a..9d4e3293 100644 --- a/docs/cmd/gotk_reconcile.md +++ b/docs/cmd/gotk_reconcile.md @@ -24,7 +24,10 @@ The reconcile sub-commands trigger a reconciliation of sources and resources. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk reconcile alert](gotk_reconcile_alert.md) - Reconcile an Alert +* [gotk reconcile alert-provider](gotk_reconcile_alert-provider.md) - Reconcile a Provider * [gotk reconcile helmrelease](gotk_reconcile_helmrelease.md) - Reconcile a HelmRelease resource * [gotk reconcile kustomization](gotk_reconcile_kustomization.md) - Reconcile a Kustomization resource +* [gotk reconcile receiver](gotk_reconcile_receiver.md) - Reconcile a Receiver * [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources diff --git a/docs/cmd/gotk_reconcile_alert-provider.md b/docs/cmd/gotk_reconcile_alert-provider.md new file mode 100644 index 00000000..a8c3c2aa --- /dev/null +++ b/docs/cmd/gotk_reconcile_alert-provider.md @@ -0,0 +1,39 @@ +## gotk reconcile alert-provider + +Reconcile a Provider + +### Synopsis + +The reconcile alert-provider command triggers a reconciliation of a Provider resource and waits for it to finish. + +``` +gotk reconcile alert-provider [name] [flags] +``` + +### Examples + +``` + # Trigger a reconciliation for an existing provider + gotk reconcile alert-provider slack + +``` + +### Options + +``` + -h, --help help for alert-provider +``` + +### Options inherited from parent commands + +``` + --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 reconcile](gotk_reconcile.md) - Reconcile sources and resources + diff --git a/docs/cmd/gotk_reconcile_alert.md b/docs/cmd/gotk_reconcile_alert.md new file mode 100644 index 00000000..7a9244b9 --- /dev/null +++ b/docs/cmd/gotk_reconcile_alert.md @@ -0,0 +1,39 @@ +## gotk reconcile alert + +Reconcile an Alert + +### Synopsis + +The reconcile alert command triggers a reconciliation of an Alert resource and waits for it to finish. + +``` +gotk reconcile alert [name] [flags] +``` + +### Examples + +``` + # Trigger a reconciliation for an existing alert + gotk reconcile alert main + +``` + +### Options + +``` + -h, --help help for alert +``` + +### Options inherited from parent commands + +``` + --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 reconcile](gotk_reconcile.md) - Reconcile sources and resources + diff --git a/docs/cmd/gotk_reconcile_receiver.md b/docs/cmd/gotk_reconcile_receiver.md new file mode 100644 index 00000000..4072a478 --- /dev/null +++ b/docs/cmd/gotk_reconcile_receiver.md @@ -0,0 +1,39 @@ +## gotk reconcile receiver + +Reconcile a Receiver + +### Synopsis + +The reconcile receiver command triggers a reconciliation of a Receiver resource and waits for it to finish. + +``` +gotk reconcile receiver [name] [flags] +``` + +### Examples + +``` + # Trigger a reconciliation for an existing receiver + gotk reconcile receiver main + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### Options inherited from parent commands + +``` + --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 reconcile](gotk_reconcile.md) - Reconcile sources and resources + diff --git a/docs/cmd/gotk_resume.md b/docs/cmd/gotk_resume.md index 451681e0..ed652fb1 100644 --- a/docs/cmd/gotk_resume.md +++ b/docs/cmd/gotk_resume.md @@ -24,6 +24,8 @@ The resume sub-commands resume a suspended resource. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk resume alert](gotk_resume_alert.md) - Resume a suspended Alert * [gotk resume helmrelease](gotk_resume_helmrelease.md) - Resume a suspended HelmRelease * [gotk resume kustomization](gotk_resume_kustomization.md) - Resume a suspended Kustomization +* [gotk resume receiver](gotk_resume_receiver.md) - Resume a suspended Receiver diff --git a/docs/cmd/gotk_resume_alert.md b/docs/cmd/gotk_resume_alert.md new file mode 100644 index 00000000..81b5f9e9 --- /dev/null +++ b/docs/cmd/gotk_resume_alert.md @@ -0,0 +1,40 @@ +## gotk resume alert + +Resume a suspended Alert + +### Synopsis + +The resume command marks a previously suspended Alert resource for reconciliation and waits for it to +finish the apply. + +``` +gotk resume alert [name] [flags] +``` + +### Examples + +``` + # Resume reconciliation for an existing Alert + gotk resume alert main + +``` + +### Options + +``` + -h, --help help for alert +``` + +### Options inherited from parent commands + +``` + --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 resume](gotk_resume.md) - Resume suspended resources + diff --git a/docs/cmd/gotk_resume_receiver.md b/docs/cmd/gotk_resume_receiver.md new file mode 100644 index 00000000..bd946a53 --- /dev/null +++ b/docs/cmd/gotk_resume_receiver.md @@ -0,0 +1,40 @@ +## gotk resume receiver + +Resume a suspended Receiver + +### Synopsis + +The resume command marks a previously suspended Receiver resource for reconciliation and waits for it to +finish the apply. + +``` +gotk resume receiver [name] [flags] +``` + +### Examples + +``` + # Resume reconciliation for an existing Receiver + gotk resume rcv main + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### Options inherited from parent commands + +``` + --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 resume](gotk_resume.md) - Resume suspended resources + diff --git a/docs/cmd/gotk_suspend.md b/docs/cmd/gotk_suspend.md index 957cf606..157c19af 100644 --- a/docs/cmd/gotk_suspend.md +++ b/docs/cmd/gotk_suspend.md @@ -24,6 +24,8 @@ The suspend sub-commands suspend the reconciliation of a resource. ### SEE ALSO * [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk suspend alert](gotk_suspend_alert.md) - Suspend reconciliation of Alert * [gotk suspend helmrelease](gotk_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease * [gotk suspend kustomization](gotk_suspend_kustomization.md) - Suspend reconciliation of Kustomization +* [gotk suspend receiver](gotk_suspend_receiver.md) - Suspend reconciliation of Receiver diff --git a/docs/cmd/gotk_suspend_alert.md b/docs/cmd/gotk_suspend_alert.md new file mode 100644 index 00000000..13fc6129 --- /dev/null +++ b/docs/cmd/gotk_suspend_alert.md @@ -0,0 +1,39 @@ +## gotk suspend alert + +Suspend reconciliation of Alert + +### Synopsis + +The suspend command disables the reconciliation of a Alert resource. + +``` +gotk suspend alert [name] [flags] +``` + +### Examples + +``` + # Suspend reconciliation for an existing Alert + gotk suspend alert main + +``` + +### Options + +``` + -h, --help help for alert +``` + +### Options inherited from parent commands + +``` + --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 suspend](gotk_suspend.md) - Suspend resources + diff --git a/docs/cmd/gotk_suspend_receiver.md b/docs/cmd/gotk_suspend_receiver.md new file mode 100644 index 00000000..af78dbf0 --- /dev/null +++ b/docs/cmd/gotk_suspend_receiver.md @@ -0,0 +1,39 @@ +## gotk suspend receiver + +Suspend reconciliation of Receiver + +### Synopsis + +The suspend command disables the reconciliation of a Receiver resource. + +``` +gotk suspend receiver [name] [flags] +``` + +### Examples + +``` + # Suspend reconciliation for an existing Receiver + gotk suspend receiver main + +``` + +### Options + +``` + -h, --help help for receiver +``` + +### Options inherited from parent commands + +``` + --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 suspend](gotk_suspend.md) - Suspend resources +