Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-14 13:36:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate cmd docs

Browse Source
This commit is contained in:
stefanprodan
2020-06-19 17:44:08 +03:00
parent 0935a637f9
commit 3d7349ee53
33 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
cmd/tk/bootstrap_gitlab.go
View File

@@ -35,7 +35,7 @@ the bootstrap command will perform an upgrade if needed.`,
# Run bootstrap for a public repository on a personal account # Run bootstrap for a public repository on a personal account
bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true
# Run bootstrap for a private repo hosted on GitLab server # Run bootstrap for a private repo hosted on a GitLab server
bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
`, `,
RunE: bootstrapGitLabCmdRun, RunE: bootstrapGitLabCmdRun,
@@ -52,7 +52,7 @@ var (
) )
func init() { func init() {
bootstrapGitLabCmd.Flags().StringVar(&glOwner, "owner", "", "GitLab user or organization name") bootstrapGitLabCmd.Flags().StringVar(&glOwner, "owner", "", "GitLab user or group name")
bootstrapGitLabCmd.Flags().StringVar(&glRepository, "repository", "", "GitLab repository name") bootstrapGitLabCmd.Flags().StringVar(&glRepository, "repository", "", "GitLab repository name")
bootstrapGitLabCmd.Flags().BoolVar(&glPersonal, "personal", false, "is personal repository") bootstrapGitLabCmd.Flags().BoolVar(&glPersonal, "personal", false, "is personal repository")
bootstrapGitLabCmd.Flags().BoolVar(&glPrivate, "private", true, "is private repository") bootstrapGitLabCmd.Flags().BoolVar(&glPrivate, "private", true, "is private repository")

2
docs/cmd/tk.md
View File

@@ -90,4 +90,4 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
* [tk sync](tk_sync.md) - Synchronize commands * [tk sync](tk_sync.md) - Synchronize commands
* [tk uninstall](tk_uninstall.md) - Uninstall the toolkit components * [tk uninstall](tk_uninstall.md) - Uninstall the toolkit components
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_bootstrap.md
View File

@@ -29,4 +29,4 @@ Bootstrap commands
* [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap GitHub repository * [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap GitHub repository
* [tk bootstrap gitlab](tk_bootstrap_gitlab.md) - Bootstrap GitLab repository * [tk bootstrap gitlab](tk_bootstrap_gitlab.md) - Bootstrap GitLab repository
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_bootstrap_github.md
View File

@@ -67,4 +67,4 @@ tk bootstrap github [flags]
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands * [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

8
docs/cmd/tk_bootstrap_gitlab.md
View File

@@ -5,7 +5,7 @@ Bootstrap GitLab repository
### Synopsis ### Synopsis
The bootstrap command creates the GitHub repository if it doesn't exists and The bootstrap command creates the GitLab repository if it doesn't exists and
commits the toolkit components manifests to the master branch. commits the toolkit components manifests to the master branch.
Then it configure the target cluster to synchronize with the repository. Then it configure the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster, If the toolkit components are present on the cluster,
@@ -30,7 +30,7 @@ tk bootstrap gitlab [flags]
# Run bootstrap for a public repository on a personal account # Run bootstrap for a public repository on a personal account
bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true
# Run bootstrap for a private repo hosted on GitLab server # Run bootstrap for a private repo hosted on a GitLab server
bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
``` ```
@@ -41,7 +41,7 @@ tk bootstrap gitlab [flags]
-h, --help help for gitlab -h, --help help for gitlab
--hostname string GitLab hostname (default "gitlab.com") --hostname string GitLab hostname (default "gitlab.com")
--interval duration sync interval (default 1m0s) --interval duration sync interval (default 1m0s)
--owner string GitLab user or organization name --owner string GitLab user or group name
--path string repository path, when specified the cluster sync will be scoped to this path --path string repository path, when specified the cluster sync will be scoped to this path
--personal is personal repository --personal is personal repository
--private is private repository (default true) --private is private repository (default true)
@@ -63,4 +63,4 @@ tk bootstrap gitlab [flags]
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands * [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_check.md
View File

@@ -44,4 +44,4 @@ tk check [flags]
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_completion.md
View File

@@ -44,4 +44,4 @@ To configure your bash shell to load completions for each session add to your ba
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_create.md
View File

@@ -30,4 +30,4 @@ Create commands
* [tk create kustomization](tk_create_kustomization.md) - Create or update a kustomization resource * [tk create kustomization](tk_create_kustomization.md) - Create or update a kustomization resource
* [tk create source](tk_create_source.md) - Create source commands * [tk create source](tk_create_source.md) - Create source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_create_kustomization.md
View File

@@ -78,4 +78,4 @@ tk create kustomization [name] [flags]
* [tk create](tk_create.md) - Create commands * [tk create](tk_create.md) - Create commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_create_source.md
View File

@@ -29,4 +29,4 @@ Create source commands
* [tk create](tk_create.md) - Create commands * [tk create](tk_create.md) - Create commands
* [tk create source git](tk_create_source_git.md) - Create or update a git source * [tk create source git](tk_create_source_git.md) - Create or update a git source
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

4
docs/cmd/tk_create_source_git.md
View File

@@ -58,7 +58,7 @@ tk create source git [name] [flags]
--branch string git branch (default "master") --branch string git branch (default "master")
-h, --help help for git -h, --help help for git
-p, --password string basic authentication password -p, --password string basic authentication password
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384) --ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p384, p521, p256) (default p384)
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa) --ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048) --ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--tag string git tag --tag string git tag
@@ -83,4 +83,4 @@ tk create source git [name] [flags]
* [tk create source](tk_create_source.md) - Create source commands * [tk create source](tk_create_source.md) - Create source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_delete.md
View File

@@ -29,4 +29,4 @@ Delete commands
* [tk delete kustomization](tk_delete_kustomization.md) - Delete kustomization * [tk delete kustomization](tk_delete_kustomization.md) - Delete kustomization
* [tk delete source](tk_delete_source.md) - Delete sources commands * [tk delete source](tk_delete_source.md) - Delete sources commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_delete_kustomization.md
View File

@@ -31,4 +31,4 @@ tk delete kustomization [name] [flags]
* [tk delete](tk_delete.md) - Delete commands * [tk delete](tk_delete.md) - Delete commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_delete_source.md
View File

@@ -28,4 +28,4 @@ Delete sources commands
* [tk delete](tk_delete.md) - Delete commands * [tk delete](tk_delete.md) - Delete commands
* [tk delete source git](tk_delete_source_git.md) - Delete git source * [tk delete source git](tk_delete_source_git.md) - Delete git source
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_delete_source_git.md
View File

@@ -31,4 +31,4 @@ tk delete source git [name] [flags]
* [tk delete source](tk_delete_source.md) - Delete sources commands * [tk delete source](tk_delete_source.md) - Delete sources commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_export.md
View File

@@ -29,4 +29,4 @@ Export commands
* [tk export kustomization](tk_export_kustomization.md) - Export kustomization in YAML format * [tk export kustomization](tk_export_kustomization.md) - Export kustomization in YAML format
* [tk export source](tk_export_source.md) - Export source commands * [tk export source](tk_export_source.md) - Export source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_export_kustomization.md
View File

@@ -42,4 +42,4 @@ tk export kustomization [name] [flags]
* [tk export](tk_export.md) - Export commands * [tk export](tk_export.md) - Export commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_export_source.md
View File

@@ -29,4 +29,4 @@ Export source commands
* [tk export](tk_export.md) - Export commands * [tk export](tk_export.md) - Export commands
* [tk export source git](tk_export_source_git.md) - Export git sources in YAML format * [tk export source git](tk_export_source_git.md) - Export git sources in YAML format
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_export_source_git.md
View File

@@ -43,4 +43,4 @@ tk export source git [name] [flags]
* [tk export source](tk_export_source.md) - Export source commands * [tk export source](tk_export_source.md) - Export source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_get.md
View File

@@ -28,4 +28,4 @@ Get commands
* [tk get kustomizations](tk_get_kustomizations.md) - Get kustomizations status * [tk get kustomizations](tk_get_kustomizations.md) - Get kustomizations status
* [tk get sources](tk_get_sources.md) - Get sources commands * [tk get sources](tk_get_sources.md) - Get sources commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_get_kustomizations.md
View File

@@ -31,4 +31,4 @@ tk get kustomizations [flags]
* [tk get](tk_get.md) - Get commands * [tk get](tk_get.md) - Get commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_get_sources.md
View File

@@ -27,4 +27,4 @@ Get sources commands
* [tk get](tk_get.md) - Get commands * [tk get](tk_get.md) - Get commands
* [tk get sources git](tk_get_sources_git.md) - Get git sources status * [tk get sources git](tk_get_sources_git.md) - Get git sources status
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_get_sources_git.md
View File

@@ -31,4 +31,4 @@ tk get sources git [flags]
* [tk get sources](tk_get_sources.md) - Get sources commands * [tk get sources](tk_get_sources.md) - Get sources commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_install.md
View File

@@ -49,4 +49,4 @@ tk install [flags]
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_resume.md
View File

@@ -27,4 +27,4 @@ Resume commands
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk resume kustomization](tk_resume_kustomization.md) - Resume kustomization * [tk resume kustomization](tk_resume_kustomization.md) - Resume kustomization
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_resume_kustomization.md
View File

@@ -30,4 +30,4 @@ tk resume kustomization [name] [flags]
* [tk resume](tk_resume.md) - Resume commands * [tk resume](tk_resume.md) - Resume commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_suspend.md
View File

@@ -27,4 +27,4 @@ Suspend commands
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk suspend kustomization](tk_suspend_kustomization.md) - Suspend kustomization * [tk suspend kustomization](tk_suspend_kustomization.md) - Suspend kustomization
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_suspend_kustomization.md
View File

@@ -30,4 +30,4 @@ tk suspend kustomization [name] [flags]
* [tk suspend](tk_suspend.md) - Suspend commands * [tk suspend](tk_suspend.md) - Suspend commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_sync.md
View File

@@ -28,4 +28,4 @@ Synchronize commands
* [tk sync kustomization](tk_sync_kustomization.md) - Synchronize kustomization * [tk sync kustomization](tk_sync_kustomization.md) - Synchronize kustomization
* [tk sync source](tk_sync_source.md) - Synchronize source commands * [tk sync source](tk_sync_source.md) - Synchronize source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_sync_kustomization.md
View File

@@ -43,4 +43,4 @@ tk sync kustomization [name] [flags]
* [tk sync](tk_sync.md) - Synchronize commands * [tk sync](tk_sync.md) - Synchronize commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_sync_source.md
View File

@@ -27,4 +27,4 @@ Synchronize source commands
* [tk sync](tk_sync.md) - Synchronize commands * [tk sync](tk_sync.md) - Synchronize commands
* [tk sync source git](tk_sync_source_git.md) - Synchronize git source * [tk sync source git](tk_sync_source_git.md) - Synchronize git source
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_sync_source_git.md
View File

@@ -39,4 +39,4 @@ tk sync source git [name] [flags]
* [tk sync source](tk_sync_source.md) - Synchronize source commands * [tk sync source](tk_sync_source.md) - Synchronize source commands
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020

2
docs/cmd/tk_uninstall.md
View File

@@ -47,4 +47,4 @@ tk uninstall [flags]
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
###### Auto generated by spf13/cobra on 18-Jun-2020 ###### Auto generated by spf13/cobra on 19-Jun-2020