Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-04-01 14:19:30 +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

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