Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-06 19:05:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add descriptions to all CLI commands

Browse Source
This commit is contained in:
Hidde Beydals
2020-06-25 11:42:43 +02:00
parent ebcbe98684
commit 21fd436621
63 changed files with 212 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/cmd/tk.md
View File

@@ -21,16 +21,16 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
--branch=master \
--interval=3m
# List git sources and their status
# List GitRepository sources and their status
tk get sources git
# Trigger a git sync
# Trigger a GitRepository source sync
tk sync source git webapp-latest
# Export git sources in YAML format
# Export GitRepository sources in YAML format
tk export source git --all > sources.yaml
# Create a kustomization for deploying a series of microservices
# Create a Kustomization for deploying a series of microservices
tk create kustomization webapp-dev \
--source=webapp-latest \
--path="./deploy/webapp/" \
@@ -41,22 +41,22 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
--health-check="Deployment/frontend.webapp" \
--health-check-timeout=2m
# Trigger a git sync and apply changes if any
# Trigger a git sync of the Kustomization's source and apply changes
tk sync kustomization webapp-dev --with-source
# Suspend a kustomization reconciliation
# Suspend a Kustomization reconciliation
tk suspend kustomization webapp-dev
# Export kustomizations in YAML format
# Export Kustomizations in YAML format
tk export kustomization --all > kustomizations.yaml
# Resume a kustomization reconciliation
# Resume a Kustomization reconciliation
tk resume kustomization webapp-dev
# Delete a kustomization
# Delete a Kustomization
tk delete kustomization webapp-dev
# Delete a git source
# Delete a GitRepository source
tk delete source git webapp-latest
# Uninstall the toolkit and delete CRDs
@@ -77,16 +77,16 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### SEE ALSO
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components
* [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
* [tk delete](tk_delete.md) - Delete commands
* [tk export](tk_export.md) - Export commands
* [tk get](tk_get.md) - Get commands
* [tk create](tk_create.md) - Create or update sources and resources
* [tk delete](tk_delete.md) - Delete sources and resources
* [tk export](tk_export.md) - Export resources in YAML format
* [tk get](tk_get.md) - Get sources and resources
* [tk install](tk_install.md) - Install the toolkit components
* [tk resume](tk_resume.md) - Resume commands
* [tk suspend](tk_suspend.md) - Suspend commands
* [tk sync](tk_sync.md) - Synchronize commands
* [tk resume](tk_resume.md) - Resume suspended resources
* [tk suspend](tk_suspend.md) - Suspend resources
* [tk sync](tk_sync.md) - Synchronize sources and resources
* [tk uninstall](tk_uninstall.md) - Uninstall the toolkit components

8
docs/cmd/tk_bootstrap.md
View File

@@ -1,10 +1,10 @@
## tk bootstrap
Bootstrap commands
Bootstrap toolkit components
### Synopsis
Bootstrap commands
The bootstrap sub-commands bootstrap the toolkit components on the targeted Git provider.
### Options
@@ -26,6 +26,6 @@ Bootstrap commands
### SEE ALSO
* [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
* [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap toolkit components in a GitHub repository
* [tk bootstrap gitlab](tk_bootstrap_gitlab.md) - Bootstrap toolkit components in a GitLab repository

9
docs/cmd/tk_bootstrap_github.md
View File

@@ -1,13 +1,12 @@
## tk bootstrap github
Bootstrap GitHub repository
Bootstrap toolkit components in a GitHub repository
### Synopsis
The bootstrap command creates the GitHub repository if it doesn't exists and
The bootstrap github 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.
Then it configures 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.
@@ -65,5 +64,5 @@ tk bootstrap github [flags]
### SEE ALSO
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components

9
docs/cmd/tk_bootstrap_gitlab.md
View File

@@ -1,13 +1,12 @@
## tk bootstrap gitlab
Bootstrap GitLab repository
Bootstrap toolkit components in a GitLab repository
### Synopsis
The bootstrap command creates the GitLab repository if it doesn't exists and
The bootstrap gitlab command creates the GitLab 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.
Then it configures 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.
@@ -61,5 +60,5 @@ tk bootstrap gitlab [flags]
### SEE ALSO
* [tk bootstrap](tk_bootstrap.md) - Bootstrap commands
* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components

1
docs/cmd/tk_check.md
View File

@@ -4,7 +4,6 @@ Check requirements and installation
### Synopsis
The check command will perform a series of checks to validate that
the local environment is configured correctly and if the installed components are healthy.

10
docs/cmd/tk_create.md
View File

@@ -1,15 +1,15 @@
## tk create
Create commands
Create or update sources and resources
### Synopsis
Create commands
The create sub-commands generate sources and resources.
### Options
```
--export export in yaml format to stdout
--export export in YAML format to stdout
-h, --help help for create
--interval duration source sync interval (default 1m0s)
```
@@ -27,6 +27,6 @@ Create commands
### SEE ALSO
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [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 kustomization](tk_create_kustomization.md) - Create or update a Kustomization resource
* [tk create source](tk_create_source.md) - Create or update sources

20
docs/cmd/tk_create_kustomization.md
View File

@@ -1,12 +1,10 @@
## tk create kustomization
Create or update a kustomization resource
Create or update a Kustomization resource
### Synopsis
The kustomization source command generates a kustomization.kustomize.fluxcd.io resource for a given GitRepository source.
API spec: https://github.com/fluxcd/kustomize-controller/tree/master/docs/spec/v1alpha1
The kustomization source create command generates a Kustomize resource for a given GitRepository source.
```
tk create kustomization [name] [flags]
@@ -15,7 +13,7 @@ tk create kustomization [name] [flags]
### Examples
```
# Create a kustomization from a source at a given path
# Create a Kustomization resource from a source at a given path
create kustomization contour \
--source=contour \
--path="./examples/contour/" \
@@ -26,7 +24,7 @@ tk create kustomization [name] [flags]
--health-check="DaemonSet/envoy.projectcontour" \
--health-check-timeout=3m
# Create a kustomization that depends on the previous one
# Create a Kustomization resource that depends on the previous one
create kustomization webapp \
--depends-on=contour \
--source=webapp \
@@ -35,7 +33,7 @@ tk create kustomization [name] [flags]
--interval=5m \
--validate=client
# Create a kustomization that runs under a service account
# Create a Kustomization resource that runs under a service account
create kustomization webapp \
--source=webapp \
--path="./deploy/overlays/staging" \
@@ -50,11 +48,11 @@ tk create kustomization [name] [flags]
### Options
```
--depends-on stringArray kustomization that must be ready before this kustomization can be applied
--depends-on stringArray Kustomization that must be ready before this Kustomization can be applied
--health-check stringArray workload to be included in the health assessment, in the format '<kind>/<name>.<namespace>'
--health-check-timeout duration timeout of health checking operations (default 2m0s)
-h, --help help for kustomization
--path string path to the directory containing the kustomization file (default "./")
--path string path to the directory containing the Kustomization file (default "./")
--prune enable garbage collection
--sa-name string service account name
--sa-namespace string service account namespace
@@ -66,7 +64,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
--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")
@@ -76,5 +74,5 @@ tk create kustomization [name] [flags]
### SEE ALSO
* [tk create](tk_create.md) - Create commands
* [tk create](tk_create.md) - Create or update sources and resources

10
docs/cmd/tk_create_source.md
View File

@@ -1,10 +1,10 @@
## tk create source
Create source commands
Create or update sources
### Synopsis
Create source commands
The create source sub-commands generate sources.
### Options
@@ -16,7 +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
--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")
@@ -26,6 +26,6 @@ Create source commands
### SEE ALSO
* [tk create](tk_create.md) - Create commands
* [tk create source git](tk_create_source_git.md) - Create or update a git source
* [tk create](tk_create.md) - Create or update sources and resources
* [tk create source git](tk_create_source_git.md) - Create or update a GitRepository source

8
docs/cmd/tk_create_source_git.md
View File

@@ -1,11 +1,11 @@
## tk create source git
Create or update a git source
Create or update a GitRepository source
### Synopsis
The create source command generates a GitRepository resource and waits for it to sync.
The create source git command generates a GitRepository resource and waits for it to sync.
For Git over SSH, host and SSH keys are automatically generated and stored in a Kubernetes secret.
For private Git repositories, the basic authentication credentials are stored in a Kubernetes secret.
@@ -71,7 +71,7 @@ tk create source git [name] [flags]
```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
--export export in yaml format to stdout
--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")
@@ -81,5 +81,5 @@ tk create source git [name] [flags]
### SEE ALSO
* [tk create source](tk_create_source.md) - Create source commands
* [tk create source](tk_create_source.md) - Create or update sources

8
docs/cmd/tk_delete.md
View File

@@ -1,10 +1,10 @@
## tk delete
Delete commands
Delete sources and resources
### Synopsis
Delete commands
The delete sub-commands delete sources and resources.
### Options
@@ -26,6 +26,6 @@ Delete commands
### SEE ALSO
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk delete kustomization](tk_delete_kustomization.md) - Delete kustomization
* [tk delete source](tk_delete_source.md) - Delete sources commands
* [tk delete kustomization](tk_delete_kustomization.md) - Delete a Kustomization resource
* [tk delete source](tk_delete_source.md) - Delete sources

6
docs/cmd/tk_delete_kustomization.md
View File

@@ -1,10 +1,10 @@
## tk delete kustomization
Delete kustomization
Delete a Kustomization resource
### Synopsis
Delete kustomization
The delete kustomization command deletes the given Kustomization from the cluster.
```
tk delete kustomization [name] [flags]
@@ -29,5 +29,5 @@ tk delete kustomization [name] [flags]
### SEE ALSO
* [tk delete](tk_delete.md) - Delete commands
* [tk delete](tk_delete.md) - Delete sources and resources

8
docs/cmd/tk_delete_source.md
View File

@@ -1,10 +1,10 @@
## tk delete source
Delete sources commands
Delete sources
### Synopsis
Delete sources commands
The delete source sub-commands delete sources.
### Options
@@ -25,6 +25,6 @@ Delete sources commands
### SEE ALSO
* [tk delete](tk_delete.md) - Delete commands
* [tk delete source git](tk_delete_source_git.md) - Delete git source
* [tk delete](tk_delete.md) - Delete sources and resources
* [tk delete source git](tk_delete_source_git.md) - Delete a GitRepository source

6
docs/cmd/tk_delete_source_git.md
View File

@@ -1,10 +1,10 @@
## tk delete source git
Delete git source
Delete a GitRepository source
### Synopsis
Delete git source
The delete source git command deletes the given GitRepository from the cluster.
```
tk delete source git [name] [flags]
@@ -29,5 +29,5 @@ tk delete source git [name] [flags]
### SEE ALSO
* [tk delete source](tk_delete_source.md) - Delete sources commands
* [tk delete source](tk_delete_source.md) - Delete sources

8
docs/cmd/tk_export.md
View File

@@ -1,10 +1,10 @@
## tk export
Export commands
Export resources in YAML format
### Synopsis
Export commands
The export sub-commands export resources in YAML format.
### Options
@@ -26,6 +26,6 @@ Export commands
### SEE ALSO
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk export kustomization](tk_export_kustomization.md) - Export kustomization in YAML format
* [tk export source](tk_export_source.md) - Export source commands
* [tk export kustomization](tk_export_kustomization.md) - Export Kustomization resources in YAML format
* [tk export source](tk_export_source.md) - Export sources

10
docs/cmd/tk_export_kustomization.md
View File

@@ -1,10 +1,10 @@
## tk export kustomization
Export kustomization in YAML format
Export Kustomization resources in YAML format
### Synopsis
Export kustomization in YAML format
The export kustomization command exports one or all Kustomization resources in YAML format.
```
tk export kustomization [name] [flags]
@@ -13,10 +13,10 @@ tk export kustomization [name] [flags]
### Examples
```
# Export all kustomizations
# Export all Kustomization resources
export kustomization --all > kustomizations.yaml
# Export a kustomization
# Export a Kustomization
export kustomization my-app > kustomization.yaml
```
@@ -40,5 +40,5 @@ tk export kustomization [name] [flags]
### SEE ALSO
* [tk export](tk_export.md) - Export commands
* [tk export](tk_export.md) - Export resources in YAML format

8
docs/cmd/tk_export_source.md
View File

@@ -1,10 +1,10 @@
## tk export source
Export source commands
Export sources
### Synopsis
Export source commands
The export source sub-commands export sources in YAML format.
### Options
@@ -26,6 +26,6 @@ Export source commands
### SEE ALSO
* [tk export](tk_export.md) - Export commands
* [tk export source git](tk_export_source_git.md) - Export git sources in YAML format
* [tk export](tk_export.md) - Export resources in YAML format
* [tk export source git](tk_export_source_git.md) - Export GitRepository sources in YAML format

10
docs/cmd/tk_export_source_git.md
View File

@@ -1,10 +1,10 @@
## tk export source git
Export git sources in YAML format
Export GitRepository sources in YAML format
### Synopsis
Export git sources in YAML format
The export source git command exports on or all GitRepository sources in YAML format.
```
tk export source git [name] [flags]
@@ -13,10 +13,10 @@ tk export source git [name] [flags]
### Examples
```
# Export all git sources
# Export all GitRepository sources
export source git --all > sources.yaml
# Export a git source including the SSH keys or basic auth credentials
# Export a GitRepository source including the SSH key pair or basic auth credentials
export source git my-private-repo --with-credentials > source.yaml
```
@@ -41,5 +41,5 @@ tk export source git [name] [flags]
### SEE ALSO
* [tk export source](tk_export_source.md) - Export source commands
* [tk export source](tk_export_source.md) - Export sources

8
docs/cmd/tk_get.md
View File

@@ -1,10 +1,10 @@
## tk get
Get commands
Get sources and resources
### Synopsis
Get commands
The get sub-commands print the statuses of sources and resources.
### Options
@@ -25,6 +25,6 @@ Get commands
### SEE ALSO
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk get kustomizations](tk_get_kustomizations.md) - Get kustomizations status
* [tk get sources](tk_get_sources.md) - Get sources commands
* [tk get kustomizations](tk_get_kustomizations.md) - Get Kustomization source statuses
* [tk get sources](tk_get_sources.md) - Get source statuses

7
docs/cmd/tk_get_kustomizations.md
View File

@@ -1,11 +1,10 @@
## tk get kustomizations
Get kustomizations status
Get Kustomization source statuses
### Synopsis
The get kustomizations command prints the status of the resources.
The get kustomizations command prints the statuses of the resources.
```
tk get kustomizations [flags]
@@ -29,5 +28,5 @@ tk get kustomizations [flags]
### SEE ALSO
* [tk get](tk_get.md) - Get commands
* [tk get](tk_get.md) - Get sources and resources

8
docs/cmd/tk_get_sources.md
View File

@@ -1,10 +1,10 @@
## tk get sources
Get sources commands
Get source statuses
### Synopsis
Get sources commands
The get source sub-commands print the statuses of the sources.
### Options
@@ -24,6 +24,6 @@ Get sources commands
### SEE ALSO
* [tk get](tk_get.md) - Get commands
* [tk get sources git](tk_get_sources_git.md) - Get git sources status
* [tk get](tk_get.md) - Get sources and resources
* [tk get sources git](tk_get_sources_git.md) - Get GitRepository source statuses

7
docs/cmd/tk_get_sources_git.md
View File

@@ -1,11 +1,10 @@
## tk get sources git
Get git sources status
Get GitRepository source statuses
### Synopsis
The get sources command prints the status of the git resources.
The get sources git command prints the status of the GitRepository sources.
```
tk get sources git [flags]
@@ -29,5 +28,5 @@ tk get sources git [flags]
### SEE ALSO
* [tk get sources](tk_get_sources.md) - Get sources commands
* [tk get sources](tk_get_sources.md) - Get source statuses

1
docs/cmd/tk_install.md
View File

@@ -4,7 +4,6 @@ Install the toolkit components
### Synopsis
The install command deploys the toolkit components in the specified namespace.
If a previous version is installed, then an in-place upgrade will be performed.

6
docs/cmd/tk_resume.md
View File

@@ -1,10 +1,10 @@
## tk resume
Resume commands
Resume suspended resources
### Synopsis
Resume commands
The resume sub-commands resume a suspended resource.
### Options
@@ -25,5 +25,5 @@ Resume commands
### SEE ALSO
* [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 a suspended Kustomization

7
docs/cmd/tk_resume_kustomization.md
View File

@@ -1,10 +1,11 @@
## tk resume kustomization
Resume kustomization
Resume a suspended Kustomization
### Synopsis
The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to finish the apply.
The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to
finish the apply.
```
tk resume kustomization [name] [flags]
@@ -28,5 +29,5 @@ tk resume kustomization [name] [flags]
### SEE ALSO
* [tk resume](tk_resume.md) - Resume commands
* [tk resume](tk_resume.md) - Resume suspended resources

6
docs/cmd/tk_suspend.md
View File

@@ -1,10 +1,10 @@
## tk suspend
Suspend commands
Suspend resources
### Synopsis
Suspend commands
The suspend sub-commands suspend the reconciliation of a resource.
### Options
@@ -25,5 +25,5 @@ Suspend commands
### SEE ALSO
* [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 reconciliation of Kustomization

4
docs/cmd/tk_suspend_kustomization.md
View File

@@ -1,6 +1,6 @@
## tk suspend kustomization
Suspend kustomization
Suspend reconciliation of Kustomization
### Synopsis
@@ -28,5 +28,5 @@ tk suspend kustomization [name] [flags]
### SEE ALSO
* [tk suspend](tk_suspend.md) - Suspend commands
* [tk suspend](tk_suspend.md) - Suspend resources

8
docs/cmd/tk_sync.md
View File

@@ -1,10 +1,10 @@
## tk sync
Synchronize commands
Synchronize sources and resources
### Synopsis
Synchronize commands
The sync sub-commands trigger a reconciliation of sources and resources.
### Options
@@ -25,6 +25,6 @@ Synchronize commands
### SEE ALSO
* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines
* [tk sync kustomization](tk_sync_kustomization.md) - Synchronize kustomization
* [tk sync source](tk_sync_source.md) - Synchronize source commands
* [tk sync kustomization](tk_sync_kustomization.md) - Synchronize a Kustomization resource
* [tk sync source](tk_sync_source.md) - Synchronize sources

8
docs/cmd/tk_sync_kustomization.md
View File

@@ -1,6 +1,6 @@
## tk sync kustomization
Synchronize kustomization
Synchronize a Kustomization resource
### Synopsis
@@ -14,10 +14,10 @@ tk sync kustomization [name] [flags]
### Examples
```
# Trigger a kustomization apply outside of the reconciliation interval
# Trigger a Kustomization apply outside of the reconciliation interval
sync kustomization podinfo
# Trigger a git sync of the kustomization source and apply changes
# Trigger a sync of the Kustomization's source and apply changes
sync kustomization podinfo --with-source
```
@@ -41,5 +41,5 @@ tk sync kustomization [name] [flags]
### SEE ALSO
* [tk sync](tk_sync.md) - Synchronize commands
* [tk sync](tk_sync.md) - Synchronize sources and resources

8
docs/cmd/tk_sync_source.md
View File

@@ -1,10 +1,10 @@
## tk sync source
Synchronize source commands
Synchronize sources
### Synopsis
Synchronize source commands
The sync source sub-commands trigger a reconciliation of sources.
### Options
@@ -24,6 +24,6 @@ Synchronize source commands
### SEE ALSO
* [tk sync](tk_sync.md) - Synchronize commands
* [tk sync source git](tk_sync_source_git.md) - Synchronize git source
* [tk sync](tk_sync.md) - Synchronize sources and resources
* [tk sync source git](tk_sync_source_git.md) - Synchronize a GitRepository source

5
docs/cmd/tk_sync_source_git.md
View File

@@ -1,10 +1,9 @@
## tk sync source git
Synchronize git source
Synchronize a GitRepository source
### Synopsis
The sync source command triggers a reconciliation of a GitRepository resource and waits for it to finish.
```
@@ -37,5 +36,5 @@ tk sync source git [name] [flags]
### SEE ALSO
* [tk sync source](tk_sync_source.md) - Synchronize source commands
* [tk sync source](tk_sync_source.md) - Synchronize sources

6
docs/cmd/tk_uninstall.md
View File

@@ -4,9 +4,7 @@ Uninstall the toolkit components
### Synopsis
The uninstall command removes the namespace, cluster roles,
cluster role bindings and CRDs.
The uninstall command removes the namespace, cluster roles, cluster role bindings and CRDs from the cluster.
```
tk uninstall [flags]
@@ -29,7 +27,7 @@ tk uninstall [flags]
--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
--kustomizations removes all Kustomizations previously installed
-s, --silent delete components without asking for confirmation
```