From 95ef3c17829cc5c8be99d5b458000fdbb0ba17d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CAnton?= Date: Mon, 19 Oct 2020 13:09:53 +0300 Subject: [PATCH] Update docs --- docs/cmd/gotk_bootstrap.md | 2 +- docs/cmd/gotk_bootstrap_github.md | 2 +- docs/cmd/gotk_bootstrap_gitlab.md | 2 +- docs/cmd/gotk_create_helmrelease.md | 2 +- docs/cmd/gotk_create_kustomization.md | 24 ++++++++++++------------ docs/cmd/gotk_create_source_bucket.md | 16 ++++++++-------- docs/cmd/gotk_install.md | 2 +- go.sum | 1 - 8 files changed, 25 insertions(+), 26 deletions(-) diff --git a/docs/cmd/gotk_bootstrap.md b/docs/cmd/gotk_bootstrap.md index 6e2332b4..c171595e 100644 --- a/docs/cmd/gotk_bootstrap.md +++ b/docs/cmd/gotk_bootstrap.md @@ -14,7 +14,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) -h, --help help for bootstrap --image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry - --log-level logLevel log level, available options are: (amd64, arm, arm64) (default info) + --log-level logLevel log level, available options are: (debug, info, error) (default info) --network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true) --registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd") -v, --version string toolkit version (default "latest") diff --git a/docs/cmd/gotk_bootstrap_github.md b/docs/cmd/gotk_bootstrap_github.md index fd0eb727..f2675cfc 100644 --- a/docs/cmd/gotk_bootstrap_github.md +++ b/docs/cmd/gotk_bootstrap_github.md @@ -62,7 +62,7 @@ gotk bootstrap github [flags] --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry --kubeconfig string path to the kubeconfig file (default "~/.kube/config") - --log-level logLevel log level, available options are: (amd64, arm, arm64) (default info) + --log-level logLevel log level, available options are: (debug, info, error) (default info) -n, --namespace string the namespace scope for this operation (default "gotk-system") --network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true) --registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd") diff --git a/docs/cmd/gotk_bootstrap_gitlab.md b/docs/cmd/gotk_bootstrap_gitlab.md index 08205954..e9a1108c 100644 --- a/docs/cmd/gotk_bootstrap_gitlab.md +++ b/docs/cmd/gotk_bootstrap_gitlab.md @@ -62,7 +62,7 @@ gotk bootstrap gitlab [flags] --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry --kubeconfig string path to the kubeconfig file (default "~/.kube/config") - --log-level logLevel log level, available options are: (amd64, arm, arm64) (default info) + --log-level logLevel log level, available options are: (debug, info, error) (default info) -n, --namespace string the namespace scope for this operation (default "gotk-system") --network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true) --registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd") diff --git a/docs/cmd/gotk_create_helmrelease.md b/docs/cmd/gotk_create_helmrelease.md index 9a831bec..cbd86586 100644 --- a/docs/cmd/gotk_create_helmrelease.md +++ b/docs/cmd/gotk_create_helmrelease.md @@ -67,7 +67,7 @@ gotk create helmrelease [name] [flags] --depends-on stringArray HelmReleases that must be ready before this release can be installed, supported formats '' and '/' -h, --help help for helmrelease --release-name string name used for the Helm release, defaults to a composition of '[-]' - --source string source that contains the chart (/) + --source helmChartSource source that contains the chart in the format '/',where kind can be one of: (HelmRepository, GitRepository, Bucket) --target-namespace string namespace to install this release, defaults to the HelmRelease namespace --values string local path to the values.yaml file ``` diff --git a/docs/cmd/gotk_create_kustomization.md b/docs/cmd/gotk_create_kustomization.md index d9fc2cd0..8df99f40 100644 --- a/docs/cmd/gotk_create_kustomization.md +++ b/docs/cmd/gotk_create_kustomization.md @@ -44,18 +44,18 @@ gotk create kustomization [name] [flags] ### Options ``` - --decryption-provider string enables secrets decryption, provider can be 'sops' - --decryption-secret string set the Kubernetes secret name that contains the OpenPGP private keys used for sops decryption - --depends-on stringArray Kustomization that must be ready before this Kustomization can be applied, supported formats '' and '/' - --health-check stringArray workload to be included in the health assessment, in the format '/.' - --health-check-timeout duration timeout of health checking operations (default 2m0s) - -h, --help help for kustomization - --path string path to the directory containing the Kustomization file (default "./") - --prune enable garbage collection - --sa-name string service account name - --sa-namespace string service account namespace - --source string source that contains the Kubernetes manifests in the format '[/]', where kind can be GitRepository or Bucket, if kind is not specified it defaults to GitRepository - --validation string validate the manifests before applying them on the cluster, can be 'client' or 'server' + --decryption-provider decryptionProvider decryption provider, available options are: (sops) + --decryption-secret string set the Kubernetes secret name that contains the OpenPGP private keys used for sops decryption + --depends-on stringArray Kustomization that must be ready before this Kustomization can be applied, supported formats '' and '/' + --health-check stringArray workload to be included in the health assessment, in the format '/.' + --health-check-timeout duration timeout of health checking operations (default 2m0s) + -h, --help help for kustomization + --path string path to the directory containing the Kustomization file (default "./") + --prune enable garbage collection + --sa-name string service account name + --sa-namespace string service account namespace + --source kustomizationSource source that contains the Kubernetes manifests in the format '[/]',where kind can be one of: (GitRepository, Bucket), if kind is not specified it defaults to GitRepository + --validation string validate the manifests before applying them on the cluster, can be 'client' or 'server' ``` ### Options inherited from parent commands diff --git a/docs/cmd/gotk_create_source_bucket.md b/docs/cmd/gotk_create_source_bucket.md index 6eb56c78..ded84619 100644 --- a/docs/cmd/gotk_create_source_bucket.md +++ b/docs/cmd/gotk_create_source_bucket.md @@ -37,14 +37,14 @@ gotk create source bucket [name] [flags] ### Options ``` - --access-key string the bucket access key - --bucket-name string the bucket name - --endpoint string the bucket endpoint address - -h, --help help for bucket - --insecure for when connecting to a non-TLS S3 HTTP endpoint - --provider string the S3 compatible storage provider name, can be 'generic' or 'aws' (default "generic") - --region string the bucket region - --secret-key string the bucket secret key + --access-key string the bucket access key + --bucket-name string the bucket name + --endpoint string the bucket endpoint address + -h, --help help for bucket + --insecure for when connecting to a non-TLS S3 HTTP endpoint + --provider sourceBucketProvider the S3 compatible storage provider name, available options are: (generic, aws) (default generic) + --region string the bucket region + --secret-key string the bucket secret key ``` ### Options inherited from parent commands diff --git a/docs/cmd/gotk_install.md b/docs/cmd/gotk_install.md index 68b32198..36dbd014 100644 --- a/docs/cmd/gotk_install.md +++ b/docs/cmd/gotk_install.md @@ -37,7 +37,7 @@ gotk install [flags] --export write the install manifests to stdout and exit -h, --help help for install --image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry - --log-level logLevel log level, available options are: (amd64, arm, arm64) (default info) + --log-level logLevel log level, available options are: (debug, info, error) (default info) --network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true) --registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd") -v, --version string toolkit version (default "latest") diff --git a/go.sum b/go.sum index 93aa134f..4cfbab64 100644 --- a/go.sum +++ b/go.sum @@ -127,7 +127,6 @@ github.com/fluxcd/pkg/ssh v0.0.5 h1:rnbFZ7voy2JBlUfMbfyqArX2FYaLNpDhccGFC3qW83A= github.com/fluxcd/pkg/ssh v0.0.5/go.mod h1:7jXPdXZpc0ttMNz2kD9QuMi3RNn/e0DOFbj0Tij/+Hs= github.com/fluxcd/pkg/untar v0.0.5 h1:UGI3Ch1UIEIaqQvMicmImL1s9npQa64DJ/ozqHKB7gk= github.com/fluxcd/pkg/untar v0.0.5/go.mod h1:O6V9+rtl8c1mHBafgqFlJN6zkF1HS5SSYn7RpQJ/nfw= -github.com/fluxcd/source-controller v0.1.1 h1:KsVvqvV5wFILleUmWlLADfNVjCdhBQfiPw+HdMTvPRM= github.com/fluxcd/source-controller/api v0.1.1 h1:BYxl9qc8pCx3/Bn1885TlkJPwvXqz+rAL9mzpnCrj9A= github.com/fluxcd/source-controller/api v0.1.1/go.mod h1:1ac/vj49YVPKF+xBHTo/9pfFj64TcLc1RLaxi4MwVEM= github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 h1:BHsljHzVlRcyQhjrss6TZTdY2VfCqZPbv5k3iBFa2ZQ=