diff --git a/docs/cmd/tk.md b/docs/cmd/tk.md index a45028bf6c9f61ab00d33e217de30e1ac5a3a0ca..a957dea02f4c8d36ff28e2c3d6904af7a5f1aa0f 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 0000000000000000000000000000000000000000..7d0990d786ccb2672b29c529f58f1bf24f16f6f8 --- /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 0000000000000000000000000000000000000000..2210f60ca59e285063095afe95cb5c5288e24ee6 --- /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=<my-token> + + # Run bootstrap for a private repo owned by a GitHub organization + bootstrap github --owner=<organization> --repository=<repo name> + + # Run bootstrap for a public repository on a personal account + bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true + + # Run bootstrap for a private repo hosted on GitHub Enterprise + bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> + +``` + +### 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 778fe8e295abe7ce0fa9b188b7c7111727750f18..3f06559264524f518a0f36652c94a2c1eac6c950 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 5b75d31a5d6fb3df0694e92a4fe62909003bc311..14f7c14638b033def7b3564ea2fcc686b74cd06a 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 1c1a88b39f2904cc5a0b20a3c94aca23f5cba153..286a204cc970232e32c5ea394bcd7f8a025185d6 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 d174648a433d12739891f4f186e553144d1520c7..6cfb8f8437719c61688becbf50a656b128b5c2b8 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 4b235005dc576b7bfb2707d07f0e2993419aae8a..4d2559a6cc4d9140b97b347ada01043c86dffcd5 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 2239fe80368d37505604ba658582f0e2ff519966..b6d2687ba0d2a0e56f753df9e842af705b093fdb 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 15d4f0fc29c325e31511adf136d933915976aa87..09d149fcc53642793c424806c718f6384ddd87c0 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 fae3cb97e9f455db9d77583b15566d940deadbb5..be27ba4a605a7a078b3febc6730f01911ef05715 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 3f48d58645a67f984ef9dfd9b68ab7f0ecd8ba54..0aaac494e6fd66cc887dd9a495755940e9037bb3 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 07e00df0393d5df4ec5a7ddeb8ce182e339437a6..45b5c40e511cbdd63bfa41ec3370cc9a09d64d66 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 3cb7d970c9486c7ad7f632a4c3e31fa86739840b..b96750624133ec3f9a3a827d02cb2209170d3fab 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 f04f4bdbafa44b8b921e3ab385b9718b03eef279..b13835782ae289fefb7354d6112cd27ee900bcb5 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 126a546cc7a38328701e82e11d43821aa0ad090f..c9fed0ab4a5ac1aedeffbaa8822d389deded4cb6 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 c38d86e63bd8e717dd25cc80abc252c3c723376a..222aca9e8cc1a0ba9420f004169f76f74b32ff1d 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 5209fa6419ebcfb9204bf18ff6e2909b94b62263..4ed527cffdb6725be4e5337c8725fb03a71adf93 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 8394c27cf465409635d94d37d14597d6ba772dac..e41c66e565816d88e2265055a7a6a7344f909af1 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 c29b0930a782f72c0df13d4ec9283653cc124bc4..c5a31c8cf935fddb592380cadffe92291bd94f5a 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 be514577fd8b3b44a1183e3b0384338a0cfafb69..630ab8c62c14dd3ccc957851512cf14e38aaa7b9 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 76318c761d843c7975c3ed81cc139af7ba8221fe..0da217201c12a92e2ffa138979fedade4c91b99f 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 5662caa220129852b30cb38a6776508d166bf153..5127bb758b622a854e2f4c092949a47702b0f7e4 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 c081538fb12c62c3df9ec01897ef3959806568fc..a0de59bac22fcf24c4423d00162af42f783e819d 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 5079105abe9ac0ed9d1f5391d3e1c8a23dbe011a..b15f0e892215927e66206bdee0361faec51e957f 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 72d905cb93194837967a9e7fffb42e158e8abdd2..50844a5ffe0134ce0cd64cd2e96b44718f9abafc 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 724e631e951c05ec066839f4eb0caac44c1240b4..25351c408632d008ab3f897b8881c18340e2b102 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 a3ac33c49a00e026ea70ff743affcc0cee1d4f66..24b06fc88e2381f12740b29a5820abd1d39cc2d9 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 0b5112152e4c554ad262e915ba71836a8a8a3ab3..35ba621f23fc975565371bc043e2d292b41320a1 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 8a4952b0759d493bfccd5d223e50e01bcc9ca731..a08420c8dabb73234cceb14e9e13b593df13ea03 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 aace41c29efb43c041d37a2e0e1907c1815994fb..467ddeb321f77d70d2dd4e60d03121c1b7ed5dc1 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