Mirrors
/
flux2
mirror of https://github.com/fluxcd/flux2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Generate bootstrap docs

Browse Source
pull/42/head
stefanprodan 5 years ago
parent d0a79c2b4c
commit badd2a102f
33 changed files with 113 additions and 42 deletions
Show Stats Download Patch File Download Diff File

2
docs/cmd/tk.md
Unescape Escape 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 uninstall](tk_uninstall.md) - Uninstall the toolkit components
###### Auto generated by spf13/cobra on 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

3
docs/cmd/tk_bootstrap.md
Unescape Escape View File

@ -27,5 +27,6 @@ Bootstrap commands
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap GitHub repository
* [tk bootstrap gitlab](tk_bootstrap_gitlab.md) - Bootstrap GitLab repository
###### Auto generated by spf13/cobra on 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

10
docs/cmd/tk_bootstrap_github.md
Unescape Escape View File

@ -24,6 +24,12 @@ tk bootstrap github [flags]
# Run bootstrap for a private repo owned by a GitHub organization
bootstrap github --owner=<organization> --repository=<repo name>
# Run bootstrap for a private repo and assign organization teams to it
bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug>
# Run bootstrap for a repository path
bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true
@ -39,9 +45,11 @@ tk bootstrap github [flags]
--hostname string GitHub hostname (default "github.com")
--interval duration sync interval (default 1m0s)
--owner string GitHub user or organization name
--path string repository path, when specified the cluster sync will be scoped to this path
--personal is personal repository
--private is private repository (default true)
--repository string GitHub repository name
--team stringArray GitHub team to be given maintainer access
```
### Options inherited from parent commands
@ -59,4 +67,4 @@ tk bootstrap github [flags]
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
###### Auto generated by spf13/cobra on 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

66
docs/cmd/tk_bootstrap_gitlab.md
Unescape Escape View File

@ -0,0 +1,66 @@
## tk bootstrap gitlab
Bootstrap GitLab 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 gitlab [flags]
```
### Examples
```
# Create a GitLab API token and export it as an env var
export GITLAB_TOKEN=<my-token>
# Run bootstrap for a private repo owned by a GitLab group
bootstrap gitlab --owner=<group> --repository=<repo name>
# Run bootstrap for a repository path
bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true
# Run bootstrap for a private repo hosted on GitLab server
bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
```
### Options
```
-h, --help help for gitlab
--hostname string GitLab hostname (default "gitlab.com")
--interval duration sync interval (default 1m0s)
--owner string GitLab user or organization name
--path string repository path, when specified the cluster sync will be scoped to this path
--personal is personal repository
--private is private repository (default true)
--repository string GitLab 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 18-Jun-2020

2
docs/cmd/tk_check.md
Unescape Escape View File

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

2
docs/cmd/tk_completion.md
Unescape Escape 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
###### Auto generated by spf13/cobra on 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

2
docs/cmd/tk_create.md
Unescape Escape View File

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

2
docs/cmd/tk_create_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_create_source.md
Unescape Escape View File

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

4
docs/cmd/tk_create_source_git.md
Unescape Escape View File

@ -58,7 +58,7 @@ tk create source git [name] [flags]
--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-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (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
@ -83,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 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

2
docs/cmd/tk_delete.md
Unescape Escape View File

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

2
docs/cmd/tk_delete_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_delete_source.md
Unescape Escape View File

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

2
docs/cmd/tk_delete_source_git.md
Unescape Escape View File

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

2
docs/cmd/tk_export.md
Unescape Escape View File

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

2
docs/cmd/tk_export_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_export_source.md
Unescape Escape View File

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

2
docs/cmd/tk_export_source_git.md
Unescape Escape View File

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

2
docs/cmd/tk_get.md
Unescape Escape View File

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

2
docs/cmd/tk_get_kustomizations.md
Unescape Escape View File

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

2
docs/cmd/tk_get_sources.md
Unescape Escape View File

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

2
docs/cmd/tk_get_sources_git.md
Unescape Escape View File

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

2
docs/cmd/tk_install.md
Unescape Escape View File

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

2
docs/cmd/tk_resume.md
Unescape Escape View File

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

2
docs/cmd/tk_resume_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_suspend.md
Unescape Escape View File

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

2
docs/cmd/tk_suspend_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_sync.md
Unescape Escape View File

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

2
docs/cmd/tk_sync_kustomization.md
Unescape Escape View File

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

2
docs/cmd/tk_sync_source.md
Unescape Escape View File

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

2
docs/cmd/tk_sync_source_git.md
Unescape Escape View File

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

11
docs/cmd/tk_uninstall.md
Unescape Escape View File

@ -26,10 +26,11 @@ tk uninstall [flags]
### Options
```
--crds removes all CRDs previously installed
--dry-run only print the object that would be deleted
-h, --help help for uninstall
-s, --silent delete components without asking for confirmation
--crds removes all CRDs previously installed
--dry-run only print the object that would be deleted
-h, --help help for uninstall
--kustomizations removes all kustomizations previously installed
-s, --silent delete components without asking for confirmation
```
### Options inherited from parent commands
@ -46,4 +47,4 @@ tk uninstall [flags]
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
###### Auto generated by spf13/cobra on 9-Jun-2020
###### Auto generated by spf13/cobra on 18-Jun-2020

7
docs/internal/release.md
Unescape Escape View File

@ -2,11 +2,6 @@
To release a new version the following steps should be followed:
1. Create a new branch from `master` i.e. `release-<next semver>`. This
will function as your release preparation branch.
1. Change the `VERSION` value in `cmd/tk/main.go` to that of the
semver release you are going to make. Commit and push your changes.
1. Create a PR for your release branch and get it merged into `master`.
1. Create a `<next semver>` tag for the merge commit in `master` and
1. Create a `<next semver>` tag form `master` and
push it to remote.
1. Confirm CI builds and releases the newly tagged version.

Write Preview
Loading…
Cancel
Save