Add bootstrap docs

pull/31/head
stefanprodan 5 years ago
parent 51ca2ee9d8
commit c047a4476e

@ -77,6 +77,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### SEE ALSO ### SEE ALSO
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
* [tk check](tk_check.md) - Check requirements and installation * [tk check](tk_check.md) - Check requirements and installation
* [tk completion](tk_completion.md) - Generates bash completion scripts * [tk completion](tk_completion.md) - Generates bash completion scripts
* [tk create](tk_create.md) - Create commands * [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 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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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

@ -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

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -9,6 +9,7 @@ Create commands
### Options ### Options
``` ```
--export export in yaml format to stdout
-h, --help help for create -h, --help help for create
--interval duration source sync interval (default 1m0s) --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 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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -66,6 +66,7 @@ tk create kustomization [name] [flags]
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) --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) --interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system") --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 * [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

@ -16,6 +16,7 @@ Create source commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) --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) --interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system") --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](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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -36,6 +36,14 @@ tk create source git [name] [flags]
--url=ssh://git@github.com/stefanprodan/podinfo \ --url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master --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 a source from a Git repository using basic authentication
create source git podinfo \ create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \ --url=https://github.com/stefanprodan/podinfo \
@ -50,6 +58,9 @@ 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 (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 string git tag
--tag-semver string git tag semver range --tag-semver string git tag semver range
--url string git address, e.g. ssh://git@host/org/repository --url string git address, e.g. ssh://git@host/org/repository
@ -60,6 +71,7 @@ tk create source git [name] [flags]
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller]) --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) --interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system") --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 * [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

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

@ -46,4 +46,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 5-May-2020 ###### Auto generated by spf13/cobra on 9-Jun-2020

Loading…
Cancel
Save