mirror of
				https://github.com/fluxcd/flux2.git
				synced 2025-11-04 11:56:11 +08:00 
			
		
		
		
	Regen docs for the v0.0.1-alpha.7 API
This commit is contained in:
		@ -34,8 +34,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
 | 
				
			|||||||
  tk create kustomization webapp-dev \
 | 
					  tk create kustomization webapp-dev \
 | 
				
			||||||
    --source=webapp-latest \
 | 
					    --source=webapp-latest \
 | 
				
			||||||
    --path="./deploy/webapp/" \
 | 
					    --path="./deploy/webapp/" \
 | 
				
			||||||
    --prune="instance=webapp" \
 | 
					    --prune=true \
 | 
				
			||||||
    --generate=true \
 | 
					 | 
				
			||||||
    --interval=5m \
 | 
					    --interval=5m \
 | 
				
			||||||
    --validate=client \
 | 
					    --validate=client \
 | 
				
			||||||
    --health-check="Deployment/backend.webapp" \
 | 
					    --health-check="Deployment/backend.webapp" \
 | 
				
			||||||
@ -90,4 +89,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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-2020
 | 
				
			||||||
 | 
				
			|||||||
@ -29,4 +29,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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-2020
 | 
				
			||||||
 | 
				
			|||||||
@ -19,8 +19,7 @@ tk create kustomization [name] [flags]
 | 
				
			|||||||
  create kustomization contour \
 | 
					  create kustomization contour \
 | 
				
			||||||
    --source=contour \
 | 
					    --source=contour \
 | 
				
			||||||
    --path="./examples/contour/" \
 | 
					    --path="./examples/contour/" \
 | 
				
			||||||
    --prune="instance=contour" \
 | 
					    --prune=true \
 | 
				
			||||||
    --generate=true \
 | 
					 | 
				
			||||||
    --interval=10m \
 | 
					    --interval=10m \
 | 
				
			||||||
    --validate=client \
 | 
					    --validate=client \
 | 
				
			||||||
    --health-check="Deployment/contour.projectcontour" \
 | 
					    --health-check="Deployment/contour.projectcontour" \
 | 
				
			||||||
@ -32,22 +31,33 @@ tk create kustomization [name] [flags]
 | 
				
			|||||||
    --depends-on=contour \
 | 
					    --depends-on=contour \
 | 
				
			||||||
    --source=webapp \
 | 
					    --source=webapp \
 | 
				
			||||||
    --path="./deploy/overlays/dev" \
 | 
					    --path="./deploy/overlays/dev" \
 | 
				
			||||||
    --prune="env=dev,instance=webapp" \
 | 
					    --prune=true \
 | 
				
			||||||
    --interval=5m \
 | 
					    --interval=5m \
 | 
				
			||||||
    --validate=client
 | 
					    --validate=client
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  # Create a kustomization that runs under a service account
 | 
				
			||||||
 | 
					  create kustomization webapp \
 | 
				
			||||||
 | 
					    --source=webapp \
 | 
				
			||||||
 | 
					    --path="./deploy/overlays/staging" \
 | 
				
			||||||
 | 
					    --prune=true \
 | 
				
			||||||
 | 
					    --interval=5m \
 | 
				
			||||||
 | 
					    --validate=client \
 | 
				
			||||||
 | 
					    --sa-name=reconclier \
 | 
				
			||||||
 | 
					    --sa-namespace=staging
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Options
 | 
					### 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
 | 
				
			||||||
      --generate                        generate the kustomization.yaml for all the Kubernetes manifests in the specified path and sub-directories
 | 
					 | 
				
			||||||
      --health-check stringArray        workload to be included in the health assessment, in the format '<kind>/<name>.<namespace>'
 | 
					      --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)
 | 
					      --health-check-timeout duration   timeout of health checking operations (default 2m0s)
 | 
				
			||||||
  -h, --help                            help for kustomization
 | 
					  -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 string                    label selector used for garbage collection
 | 
					      --prune                           enable garbage collection
 | 
				
			||||||
 | 
					      --sa-name string                  service account name
 | 
				
			||||||
 | 
					      --sa-namespace string             service account namespace
 | 
				
			||||||
      --source string                   GitRepository name
 | 
					      --source string                   GitRepository name
 | 
				
			||||||
      --validate string                 validate the manifests before applying them on the cluster, can be 'client' or 'server'
 | 
					      --validate string                 validate the manifests before applying them on the cluster, can be 'client' or 'server'
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
@ -67,4 +77,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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-2020
 | 
				
			||||||
 | 
				
			|||||||
@ -28,4 +28,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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-2020
 | 
				
			||||||
 | 
				
			|||||||
@ -71,4 +71,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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-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 1-May-2020
 | 
					###### Auto generated by spf13/cobra on 5-May-2020
 | 
				
			||||||
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user