From c047a4476e5eba86ed872b92939aa03662a3241d Mon Sep 17 00:00:00 2001 From: stefanprodan Date: Tue, 9 Jun 2020 16:14:04 +0300 Subject: [PATCH] Add bootstrap docs --- docs/cmd/tk.md | 3 +- docs/cmd/tk_bootstrap.md | 31 ++++++++++++++ docs/cmd/tk_bootstrap_github.md | 62 ++++++++++++++++++++++++++++ docs/cmd/tk_check.md | 2 +- docs/cmd/tk_completion.md | 2 +- docs/cmd/tk_create.md | 3 +- docs/cmd/tk_create_kustomization.md | 3 +- docs/cmd/tk_create_source.md | 3 +- docs/cmd/tk_create_source_git.md | 30 ++++++++++---- docs/cmd/tk_delete.md | 2 +- docs/cmd/tk_delete_kustomization.md | 2 +- docs/cmd/tk_delete_source.md | 2 +- docs/cmd/tk_delete_source_git.md | 2 +- docs/cmd/tk_export.md | 2 +- docs/cmd/tk_export_kustomization.md | 2 +- docs/cmd/tk_export_source.md | 2 +- docs/cmd/tk_export_source_git.md | 2 +- docs/cmd/tk_get.md | 2 +- docs/cmd/tk_get_kustomizations.md | 2 +- docs/cmd/tk_get_sources.md | 2 +- docs/cmd/tk_get_sources_git.md | 2 +- docs/cmd/tk_install.md | 2 +- docs/cmd/tk_resume.md | 2 +- docs/cmd/tk_resume_kustomization.md | 2 +- docs/cmd/tk_suspend.md | 2 +- docs/cmd/tk_suspend_kustomization.md | 2 +- docs/cmd/tk_sync.md | 2 +- docs/cmd/tk_sync_kustomization.md | 2 +- docs/cmd/tk_sync_source.md | 2 +- docs/cmd/tk_sync_source_git.md | 2 +- docs/cmd/tk_uninstall.md | 2 +- 31 files changed, 146 insertions(+), 37 deletions(-) create mode 100644 docs/cmd/tk_bootstrap.md create mode 100644 docs/cmd/tk_bootstrap_github.md diff --git a/docs/cmd/tk.md b/docs/cmd/tk.md index a45028bf..a957dea0 100644 --- a/docs/cmd/tk.md +++ b/docs/cmd/tk.md @@ -77,6 +77,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way. ### SEE ALSO +* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands * [tk check](tk_check.md) - Check requirements and installation * [tk completion](tk_completion.md) - Generates bash completion scripts * [tk create](tk_create.md) - Create commands @@ -89,4 +90,4 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way. * [tk sync](tk_sync.md) - Synchronize commands * [tk uninstall](tk_uninstall.md) - Uninstall the toolkit components -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_bootstrap.md b/docs/cmd/tk_bootstrap.md new file mode 100644 index 00000000..7d0990d7 --- /dev/null +++ b/docs/cmd/tk_bootstrap.md @@ -0,0 +1,31 @@ +## tk bootstrap + +Bootstrap commands + +### Synopsis + +Bootstrap commands + +### Options + +``` + -h, --help help for bootstrap + --version string toolkit tag or branch (default "master") +``` + +### Options inherited from parent commands + +``` + --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + --namespace string the namespace scope for this operation (default "gitops-system") + --timeout duration timeout for this operation (default 5m0s) + --verbose print generated objects +``` + +### SEE ALSO + +* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines +* [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap GitHub repository + +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_bootstrap_github.md b/docs/cmd/tk_bootstrap_github.md new file mode 100644 index 00000000..2210f60c --- /dev/null +++ b/docs/cmd/tk_bootstrap_github.md @@ -0,0 +1,62 @@ +## tk bootstrap github + +Bootstrap GitHub repository + +### Synopsis + + +The bootstrap command creates the GitHub repository if it doesn't exists and +commits the toolkit components manifests to the master branch. +Then it configure the target cluster to synchronize with the repository. +If the toolkit components are present on the cluster, +the bootstrap command will perform an upgrade if needed. + +``` +tk bootstrap github [flags] +``` + +### Examples + +``` + # Create a GitHub personal access token and export it as an env var + export GITHUB_TOKEN= + + # Run bootstrap for a private repo owned by a GitHub organization + bootstrap github --owner= --repository= + + # Run bootstrap for a public repository on a personal account + bootstrap github --owner= --repository= --private=false --personal=true + + # Run bootstrap for a private repo hosted on GitHub Enterprise + bootstrap github --owner= --repository= --hostname= + +``` + +### Options + +``` + -h, --help help for github + --hostname string GitHub hostname (default "github.com") + --interval duration sync interval (default 1m0s) + --owner string GitHub user or organization name + --personal is personal repository + --private is private repository (default true) + --repository string GitHub repository name +``` + +### Options inherited from parent commands + +``` + --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) + --kubeconfig string path to the kubeconfig file (default "~/.kube/config") + --namespace string the namespace scope for this operation (default "gitops-system") + --timeout duration timeout for this operation (default 5m0s) + --verbose print generated objects + --version string toolkit tag or branch (default "master") +``` + +### SEE ALSO + +* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands + +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_check.md b/docs/cmd/tk_check.md index 778fe8e2..3f065592 100644 --- a/docs/cmd/tk_check.md +++ b/docs/cmd/tk_check.md @@ -44,4 +44,4 @@ tk check [flags] * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_completion.md b/docs/cmd/tk_completion.md index 5b75d31a..14f7c146 100644 --- a/docs/cmd/tk_completion.md +++ b/docs/cmd/tk_completion.md @@ -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 -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_create.md b/docs/cmd/tk_create.md index 1c1a88b3..286a204c 100644 --- a/docs/cmd/tk_create.md +++ b/docs/cmd/tk_create.md @@ -9,6 +9,7 @@ Create commands ### Options ``` + --export export in yaml format to stdout -h, --help help for create --interval duration source sync interval (default 1m0s) ``` @@ -29,4 +30,4 @@ Create commands * [tk create kustomization](tk_create_kustomization.md) - Create or update a kustomization resource * [tk create source](tk_create_source.md) - Create source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_create_kustomization.md b/docs/cmd/tk_create_kustomization.md index d174648a..6cfb8f84 100644 --- a/docs/cmd/tk_create_kustomization.md +++ b/docs/cmd/tk_create_kustomization.md @@ -66,6 +66,7 @@ tk create kustomization [name] [flags] ``` --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) + --export export in yaml format to stdout --interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system") @@ -77,4 +78,4 @@ tk create kustomization [name] [flags] * [tk create](tk_create.md) - Create commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_create_source.md b/docs/cmd/tk_create_source.md index 4b235005..4d2559a6 100644 --- a/docs/cmd/tk_create_source.md +++ b/docs/cmd/tk_create_source.md @@ -16,6 +16,7 @@ Create source commands ``` --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) + --export export in yaml format to stdout --interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system") @@ -28,4 +29,4 @@ Create source commands * [tk create](tk_create.md) - Create commands * [tk create source git](tk_create_source_git.md) - Create or update a git source -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_create_source_git.md b/docs/cmd/tk_create_source_git.md index 2239fe80..b6d2687b 100644 --- a/docs/cmd/tk_create_source_git.md +++ b/docs/cmd/tk_create_source_git.md @@ -31,11 +31,19 @@ tk create source git [name] [flags] --url=https://github.com/stefanprodan/podinfo \ --tag-semver=">=3.2.0 <3.3.0" - # Create a source from a Git repository using SSH authentication + # Create a source from a Git repository using SSH authentication create source git podinfo \ --url=ssh://git@github.com/stefanprodan/podinfo \ --branch=master + # Create a source from a Git repository using SSH authentication and an + # ECDSA P-521 curve public key + create source git podinfo \ + --url=ssh://git@github.com/stefanprodan/podinfo \ + --branch=master \ + --ssh-key-algorithm=ecdsa \ + --ssh-ecdsa-curve=p521 + # Create a source from a Git repository using basic authentication create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ @@ -47,19 +55,23 @@ tk create source git [name] [flags] ### Options ``` - --branch string git branch (default "master") - -h, --help help for git - -p, --password string basic authentication password - --tag string git tag - --tag-semver string git tag semver range - --url string git address, e.g. ssh://git@host/org/repository - -u, --username string basic authentication username + --branch string git branch (default "master") + -h, --help help for git + -p, --password string basic authentication password + --ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p521, p256, p384) (default p384) + --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) + --tag string git tag + --tag-semver string git tag semver range + --url string git address, e.g. ssh://git@host/org/repository + -u, --username string basic authentication username ``` ### Options inherited from parent commands ``` --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) + --export export in yaml format to stdout --interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system") @@ -71,4 +83,4 @@ tk create source git [name] [flags] * [tk create source](tk_create_source.md) - Create source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_delete.md b/docs/cmd/tk_delete.md index 15d4f0fc..09d149fc 100644 --- a/docs/cmd/tk_delete.md +++ b/docs/cmd/tk_delete.md @@ -29,4 +29,4 @@ Delete commands * [tk delete kustomization](tk_delete_kustomization.md) - Delete kustomization * [tk delete source](tk_delete_source.md) - Delete sources commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_delete_kustomization.md b/docs/cmd/tk_delete_kustomization.md index fae3cb97..be27ba4a 100644 --- a/docs/cmd/tk_delete_kustomization.md +++ b/docs/cmd/tk_delete_kustomization.md @@ -31,4 +31,4 @@ tk delete kustomization [name] [flags] * [tk delete](tk_delete.md) - Delete commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_delete_source.md b/docs/cmd/tk_delete_source.md index 3f48d586..0aaac494 100644 --- a/docs/cmd/tk_delete_source.md +++ b/docs/cmd/tk_delete_source.md @@ -28,4 +28,4 @@ Delete sources commands * [tk delete](tk_delete.md) - Delete commands * [tk delete source git](tk_delete_source_git.md) - Delete git source -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_delete_source_git.md b/docs/cmd/tk_delete_source_git.md index 07e00df0..45b5c40e 100644 --- a/docs/cmd/tk_delete_source_git.md +++ b/docs/cmd/tk_delete_source_git.md @@ -31,4 +31,4 @@ tk delete source git [name] [flags] * [tk delete source](tk_delete_source.md) - Delete sources commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_export.md b/docs/cmd/tk_export.md index 3cb7d970..b9675062 100644 --- a/docs/cmd/tk_export.md +++ b/docs/cmd/tk_export.md @@ -29,4 +29,4 @@ Export commands * [tk export kustomization](tk_export_kustomization.md) - Export kustomization in YAML format * [tk export source](tk_export_source.md) - Export source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_export_kustomization.md b/docs/cmd/tk_export_kustomization.md index f04f4bdb..b1383578 100644 --- a/docs/cmd/tk_export_kustomization.md +++ b/docs/cmd/tk_export_kustomization.md @@ -42,4 +42,4 @@ tk export kustomization [name] [flags] * [tk export](tk_export.md) - Export commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_export_source.md b/docs/cmd/tk_export_source.md index 126a546c..c9fed0ab 100644 --- a/docs/cmd/tk_export_source.md +++ b/docs/cmd/tk_export_source.md @@ -29,4 +29,4 @@ Export source commands * [tk export](tk_export.md) - Export commands * [tk export source git](tk_export_source_git.md) - Export git sources in YAML format -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_export_source_git.md b/docs/cmd/tk_export_source_git.md index c38d86e6..222aca9e 100644 --- a/docs/cmd/tk_export_source_git.md +++ b/docs/cmd/tk_export_source_git.md @@ -43,4 +43,4 @@ tk export source git [name] [flags] * [tk export source](tk_export_source.md) - Export source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_get.md b/docs/cmd/tk_get.md index 5209fa64..4ed527cf 100644 --- a/docs/cmd/tk_get.md +++ b/docs/cmd/tk_get.md @@ -28,4 +28,4 @@ Get commands * [tk get kustomizations](tk_get_kustomizations.md) - Get kustomizations status * [tk get sources](tk_get_sources.md) - Get sources commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_get_kustomizations.md b/docs/cmd/tk_get_kustomizations.md index 8394c27c..e41c66e5 100644 --- a/docs/cmd/tk_get_kustomizations.md +++ b/docs/cmd/tk_get_kustomizations.md @@ -31,4 +31,4 @@ tk get kustomizations [flags] * [tk get](tk_get.md) - Get commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_get_sources.md b/docs/cmd/tk_get_sources.md index c29b0930..c5a31c8c 100644 --- a/docs/cmd/tk_get_sources.md +++ b/docs/cmd/tk_get_sources.md @@ -27,4 +27,4 @@ Get sources commands * [tk get](tk_get.md) - Get commands * [tk get sources git](tk_get_sources_git.md) - Get git sources status -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_get_sources_git.md b/docs/cmd/tk_get_sources_git.md index be514577..630ab8c6 100644 --- a/docs/cmd/tk_get_sources_git.md +++ b/docs/cmd/tk_get_sources_git.md @@ -31,4 +31,4 @@ tk get sources git [flags] * [tk get sources](tk_get_sources.md) - Get sources commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_install.md b/docs/cmd/tk_install.md index 76318c76..0da21720 100644 --- a/docs/cmd/tk_install.md +++ b/docs/cmd/tk_install.md @@ -49,4 +49,4 @@ tk install [flags] * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_resume.md b/docs/cmd/tk_resume.md index 5662caa2..5127bb75 100644 --- a/docs/cmd/tk_resume.md +++ b/docs/cmd/tk_resume.md @@ -27,4 +27,4 @@ Resume commands * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk resume kustomization](tk_resume_kustomization.md) - Resume kustomization -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_resume_kustomization.md b/docs/cmd/tk_resume_kustomization.md index c081538f..a0de59ba 100644 --- a/docs/cmd/tk_resume_kustomization.md +++ b/docs/cmd/tk_resume_kustomization.md @@ -30,4 +30,4 @@ tk resume kustomization [name] [flags] * [tk resume](tk_resume.md) - Resume commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_suspend.md b/docs/cmd/tk_suspend.md index 5079105a..b15f0e89 100644 --- a/docs/cmd/tk_suspend.md +++ b/docs/cmd/tk_suspend.md @@ -27,4 +27,4 @@ Suspend commands * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines * [tk suspend kustomization](tk_suspend_kustomization.md) - Suspend kustomization -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_suspend_kustomization.md b/docs/cmd/tk_suspend_kustomization.md index 72d905cb..50844a5f 100644 --- a/docs/cmd/tk_suspend_kustomization.md +++ b/docs/cmd/tk_suspend_kustomization.md @@ -30,4 +30,4 @@ tk suspend kustomization [name] [flags] * [tk suspend](tk_suspend.md) - Suspend commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_sync.md b/docs/cmd/tk_sync.md index 724e631e..25351c40 100644 --- a/docs/cmd/tk_sync.md +++ b/docs/cmd/tk_sync.md @@ -28,4 +28,4 @@ Synchronize commands * [tk sync kustomization](tk_sync_kustomization.md) - Synchronize kustomization * [tk sync source](tk_sync_source.md) - Synchronize source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_sync_kustomization.md b/docs/cmd/tk_sync_kustomization.md index a3ac33c4..24b06fc8 100644 --- a/docs/cmd/tk_sync_kustomization.md +++ b/docs/cmd/tk_sync_kustomization.md @@ -43,4 +43,4 @@ tk sync kustomization [name] [flags] * [tk sync](tk_sync.md) - Synchronize commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_sync_source.md b/docs/cmd/tk_sync_source.md index 0b511215..35ba621f 100644 --- a/docs/cmd/tk_sync_source.md +++ b/docs/cmd/tk_sync_source.md @@ -27,4 +27,4 @@ Synchronize source commands * [tk sync](tk_sync.md) - Synchronize commands * [tk sync source git](tk_sync_source_git.md) - Synchronize git source -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_sync_source_git.md b/docs/cmd/tk_sync_source_git.md index 8a4952b0..a08420c8 100644 --- a/docs/cmd/tk_sync_source_git.md +++ b/docs/cmd/tk_sync_source_git.md @@ -39,4 +39,4 @@ tk sync source git [name] [flags] * [tk sync source](tk_sync_source.md) - Synchronize source commands -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020 diff --git a/docs/cmd/tk_uninstall.md b/docs/cmd/tk_uninstall.md index aace41c2..467ddeb3 100644 --- a/docs/cmd/tk_uninstall.md +++ b/docs/cmd/tk_uninstall.md @@ -46,4 +46,4 @@ tk uninstall [flags] * [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -###### Auto generated by spf13/cobra on 5-May-2020 +###### Auto generated by spf13/cobra on 9-Jun-2020