diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml index 2b0ffc0e..55d1e926 100644 --- a/.github/workflows/e2e.yaml +++ b/.github/workflows/e2e.yaml @@ -30,7 +30,7 @@ jobs: - name: Check if working tree is dirty run: | if [[ $(git diff --stat) != '' ]]; then - git diff --stat + git diff echo 'run make test and commit changes' exit 1 fi diff --git a/cmd/tk/bootstrap.go b/cmd/tk/bootstrap.go index 4802339b..b1376372 100644 --- a/cmd/tk/bootstrap.go +++ b/cmd/tk/bootstrap.go @@ -40,7 +40,8 @@ import ( var bootstrapCmd = &cobra.Command{ Use: "bootstrap", - Short: "Bootstrap commands", + Short: "Bootstrap toolkit components", + Long: "The bootstrap sub-commands bootstrap the toolkit components on the targeted Git provider.", } var ( diff --git a/cmd/tk/bootstrap_github.go b/cmd/tk/bootstrap_github.go index 78a6eaa9..872c915e 100644 --- a/cmd/tk/bootstrap_github.go +++ b/cmd/tk/bootstrap_github.go @@ -32,11 +32,10 @@ import ( var bootstrapGitHubCmd = &cobra.Command{ Use: "github", - Short: "Bootstrap GitHub repository", - Long: ` -The bootstrap command creates the GitHub repository if it doesn't exists and + Short: "Bootstrap toolkit components in a GitHub repository", + Long: `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.`, Example: ` # Create a GitHub personal access token and export it as an env var diff --git a/cmd/tk/bootstrap_gitlab.go b/cmd/tk/bootstrap_gitlab.go index 4c523dea..10d4343e 100644 --- a/cmd/tk/bootstrap_gitlab.go +++ b/cmd/tk/bootstrap_gitlab.go @@ -32,11 +32,10 @@ import ( var bootstrapGitLabCmd = &cobra.Command{ Use: "gitlab", - Short: "Bootstrap GitLab repository", - Long: ` -The bootstrap command creates the GitLab repository if it doesn't exists and + Short: "Bootstrap toolkit components in a GitLab repository", + Long: `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.`, Example: ` # Create a GitLab API token and export it as an env var diff --git a/cmd/tk/check.go b/cmd/tk/check.go index 735656e8..18492137 100644 --- a/cmd/tk/check.go +++ b/cmd/tk/check.go @@ -32,8 +32,7 @@ import ( var checkCmd = &cobra.Command{ Use: "check", Short: "Check requirements and installation", - Long: ` -The check command will perform a series of checks to validate that + Long: `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.`, Example: ` # Run pre-installation checks check --pre diff --git a/cmd/tk/create.go b/cmd/tk/create.go index 98560b17..e36b51db 100644 --- a/cmd/tk/create.go +++ b/cmd/tk/create.go @@ -24,7 +24,8 @@ import ( var createCmd = &cobra.Command{ Use: "create", - Short: "Create commands", + Short: "Create or update sources and resources", + Long: "The create sub-commands generate sources and resources.", } var ( @@ -34,6 +35,6 @@ var ( func init() { createCmd.PersistentFlags().DurationVarP(&interval, "interval", "", time.Minute, "source sync interval") - createCmd.PersistentFlags().BoolVar(&export, "export", false, "export in yaml format to stdout") + createCmd.PersistentFlags().BoolVar(&export, "export", false, "export in YAML format to stdout") rootCmd.AddCommand(createCmd) } diff --git a/cmd/tk/create_kustomization.go b/cmd/tk/create_kustomization.go index 982ec737..6bb9da7a 100644 --- a/cmd/tk/create_kustomization.go +++ b/cmd/tk/create_kustomization.go @@ -37,11 +37,9 @@ import ( var createKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Create or update a kustomization resource", - Long: ` -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`, - Example: ` # Create a kustomization from a source at a given path + Short: "Create or update a Kustomization resource", + Long: "The kustomization source create command generates a Kustomize resource for a given GitRepository source.", + Example: ` # Create a Kustomization resource from a source at a given path create kustomization contour \ --source=contour \ --path="./examples/contour/" \ @@ -52,7 +50,7 @@ API spec: https://github.com/fluxcd/kustomize-controller/tree/master/docs/spec/v --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 \ @@ -61,7 +59,7 @@ API spec: https://github.com/fluxcd/kustomize-controller/tree/master/docs/spec/v --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" \ @@ -88,12 +86,12 @@ var ( func init() { createKsCmd.Flags().StringVar(&ksSource, "source", "", "GitRepository name") - createKsCmd.Flags().StringVar(&ksPath, "path", "./", "path to the directory containing the kustomization file") + createKsCmd.Flags().StringVar(&ksPath, "path", "./", "path to the directory containing the Kustomization file") createKsCmd.Flags().BoolVar(&ksPrune, "prune", false, "enable garbage collection") createKsCmd.Flags().StringArrayVar(&ksHealthCheck, "health-check", nil, "workload to be included in the health assessment, in the format '/.'") createKsCmd.Flags().DurationVar(&ksHealthTimeout, "health-check-timeout", 2*time.Minute, "timeout of health checking operations") createKsCmd.Flags().StringVar(&ksValidate, "validate", "", "validate the manifests before applying them on the cluster, can be 'client' or 'server'") - createKsCmd.Flags().StringArrayVar(&ksDependsOn, "depends-on", nil, "kustomization that must be ready before this kustomization can be applied") + createKsCmd.Flags().StringArrayVar(&ksDependsOn, "depends-on", nil, "Kustomization that must be ready before this Kustomization can be applied") createKsCmd.Flags().StringVar(&ksSAName, "sa-name", "", "service account name") createKsCmd.Flags().StringVar(&ksSANamespace, "sa-namespace", "", "service account namespace") createCmd.AddCommand(createKsCmd) diff --git a/cmd/tk/create_source.go b/cmd/tk/create_source.go index 9be79310..a7c863d7 100644 --- a/cmd/tk/create_source.go +++ b/cmd/tk/create_source.go @@ -22,7 +22,8 @@ import ( var createSourceCmd = &cobra.Command{ Use: "source", - Short: "Create source commands", + Short: "Create or update sources", + Long: "The create source sub-commands generate sources.", } func init() { diff --git a/cmd/tk/create_source_git.go b/cmd/tk/create_source_git.go index 501cbf70..3276ce64 100644 --- a/cmd/tk/create_source_git.go +++ b/cmd/tk/create_source_git.go @@ -40,9 +40,9 @@ import ( var createSourceGitCmd = &cobra.Command{ Use: "git [name]", - Short: "Create or update a git source", + Short: "Create or update a GitRepository source", Long: ` -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.`, Example: ` # Create a source from a public Git repository master branch diff --git a/cmd/tk/delete.go b/cmd/tk/delete.go index 19dc2522..41013b8e 100644 --- a/cmd/tk/delete.go +++ b/cmd/tk/delete.go @@ -22,7 +22,8 @@ import ( var deleteCmd = &cobra.Command{ Use: "delete", - Short: "Delete commands", + Short: "Delete sources and resources", + Long: "The delete sub-commands delete sources and resources.", } var ( diff --git a/cmd/tk/delete_kustomization.go b/cmd/tk/delete_kustomization.go index 9a8d9e60..28d326b6 100644 --- a/cmd/tk/delete_kustomization.go +++ b/cmd/tk/delete_kustomization.go @@ -29,7 +29,8 @@ import ( var deleteKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Delete kustomization", + Short: "Delete a Kustomization resource", + Long: "The delete kustomization command deletes the given Kustomization from the cluster.", RunE: deleteKsCmdRun, } diff --git a/cmd/tk/delete_source.go b/cmd/tk/delete_source.go index f423e666..ee45c9eb 100644 --- a/cmd/tk/delete_source.go +++ b/cmd/tk/delete_source.go @@ -22,7 +22,8 @@ import ( var deleteSourceCmd = &cobra.Command{ Use: "source", - Short: "Delete sources commands", + Short: "Delete sources", + Long: "The delete source sub-commands delete sources.", } func init() { diff --git a/cmd/tk/delete_source_git.go b/cmd/tk/delete_source_git.go index a4bf8aa6..f88ab69c 100644 --- a/cmd/tk/delete_source_git.go +++ b/cmd/tk/delete_source_git.go @@ -28,7 +28,8 @@ import ( var deleteSourceGitCmd = &cobra.Command{ Use: "git [name]", - Short: "Delete git source", + Short: "Delete a GitRepository source", + Long: "The delete source git command deletes the given GitRepository from the cluster.", RunE: deleteSourceGitCmdRun, } diff --git a/cmd/tk/export.go b/cmd/tk/export.go index 5c45ebe5..8a6d9f16 100644 --- a/cmd/tk/export.go +++ b/cmd/tk/export.go @@ -22,7 +22,8 @@ import ( var exportCmd = &cobra.Command{ Use: "export", - Short: "Export commands", + Short: "Export resources in YAML format", + Long: "The export sub-commands export resources in YAML format.", } var ( diff --git a/cmd/tk/export_kustomization.go b/cmd/tk/export_kustomization.go index 07f71a00..83c2a633 100644 --- a/cmd/tk/export_kustomization.go +++ b/cmd/tk/export_kustomization.go @@ -31,11 +31,12 @@ import ( var exportKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Export kustomization in YAML format", - Example: ` # Export all kustomizations + Short: "Export Kustomization resources in YAML format", + Long: "The export kustomization command exports one or all Kustomization resources in YAML format.", + Example: ` # Export all Kustomization resources export kustomization --all > kustomizations.yaml - # Export a kustomization + # Export a Kustomization export kustomization my-app > kustomization.yaml `, RunE: exportKsCmdRun, diff --git a/cmd/tk/export_source.go b/cmd/tk/export_source.go index 8b6dbd5b..408622c4 100644 --- a/cmd/tk/export_source.go +++ b/cmd/tk/export_source.go @@ -22,7 +22,8 @@ import ( var exportSourceCmd = &cobra.Command{ Use: "source", - Short: "Export source commands", + Short: "Export sources", + Long: "The export source sub-commands export sources in YAML format.", } var ( diff --git a/cmd/tk/export_source_git.go b/cmd/tk/export_source_git.go index b8d38e99..714a8a1a 100644 --- a/cmd/tk/export_source_git.go +++ b/cmd/tk/export_source_git.go @@ -31,11 +31,12 @@ import ( var exportSourceGitCmd = &cobra.Command{ Use: "git [name]", - Short: "Export git sources in YAML format", - Example: ` # Export all git sources + Short: "Export GitRepository sources in YAML format", + Long: "The export source git command exports on or all GitRepository sources in YAML format.", + Example: ` # 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 `, RunE: exportSourceGitCmdRun, diff --git a/cmd/tk/get.go b/cmd/tk/get.go index 8f640e2d..1e722dad 100644 --- a/cmd/tk/get.go +++ b/cmd/tk/get.go @@ -22,7 +22,8 @@ import ( var getCmd = &cobra.Command{ Use: "get", - Short: "Get commands", + Short: "Get sources and resources", + Long: "The get sub-commands print the statuses of sources and resources.", } func init() { diff --git a/cmd/tk/get_kustomization.go b/cmd/tk/get_kustomization.go index 4dbc3795..5e09a8cb 100644 --- a/cmd/tk/get_kustomization.go +++ b/cmd/tk/get_kustomization.go @@ -28,10 +28,9 @@ import ( var getKsCmd = &cobra.Command{ Use: "kustomizations", Aliases: []string{"ks"}, - Short: "Get kustomizations status", - Long: ` -The get kustomizations command prints the status of the resources.`, - RunE: getKsCmdRun, + Short: "Get Kustomization source statuses", + Long: "The get kustomizations command prints the statuses of the resources.", + RunE: getKsCmdRun, } func init() { diff --git a/cmd/tk/get_source.go b/cmd/tk/get_source.go index 78e328a5..20c2cb32 100644 --- a/cmd/tk/get_source.go +++ b/cmd/tk/get_source.go @@ -22,7 +22,8 @@ import ( var getSourceCmd = &cobra.Command{ Use: "sources", - Short: "Get sources commands", + Short: "Get source statuses", + Long: "The get source sub-commands print the statuses of the sources.", } func init() { diff --git a/cmd/tk/get_source_git.go b/cmd/tk/get_source_git.go index b3a04fcc..7fe82ef3 100644 --- a/cmd/tk/get_source_git.go +++ b/cmd/tk/get_source_git.go @@ -27,10 +27,9 @@ import ( var getSourceGitCmd = &cobra.Command{ Use: "git", - Short: "Get git sources status", - Long: ` -The get sources command prints the status of the git resources.`, - RunE: getSourceGitCmdRun, + Short: "Get GitRepository source statuses", + Long: "The get sources git command prints the status of the GitRepository sources.", + RunE: getSourceGitCmdRun, } func init() { diff --git a/cmd/tk/install.go b/cmd/tk/install.go index 625f8207..08c81d7e 100644 --- a/cmd/tk/install.go +++ b/cmd/tk/install.go @@ -33,8 +33,7 @@ import ( var installCmd = &cobra.Command{ Use: "install", Short: "Install the toolkit components", - Long: ` -The install command deploys the toolkit components in the specified namespace. + Long: `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.`, Example: ` # Install the latest version in the gitops-systems namespace install --version=master --namespace=gitops-systems diff --git a/cmd/tk/main.go b/cmd/tk/main.go index c0128a95..f1886122 100644 --- a/cmd/tk/main.go +++ b/cmd/tk/main.go @@ -48,16 +48,16 @@ var rootCmd = &cobra.Command{ --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/" \ @@ -68,22 +68,22 @@ var rootCmd = &cobra.Command{ --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 diff --git a/cmd/tk/resume.go b/cmd/tk/resume.go index 6a8820db..e9a3b5a6 100644 --- a/cmd/tk/resume.go +++ b/cmd/tk/resume.go @@ -22,7 +22,8 @@ import ( var resumeCmd = &cobra.Command{ Use: "resume", - Short: "Resume commands", + Short: "Resume suspended resources", + Long: "The resume sub-commands resume a suspended resource.", } func init() { diff --git a/cmd/tk/resume_kustomization.go b/cmd/tk/resume_kustomization.go index 4ff31f3d..05949531 100644 --- a/cmd/tk/resume_kustomization.go +++ b/cmd/tk/resume_kustomization.go @@ -32,9 +32,10 @@ import ( var resumeKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Resume kustomization", - Long: "The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to finish the apply.", - RunE: resumeKsCmdRun, + Short: "Resume a suspended Kustomization", + Long: `The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to +finish the apply.`, + RunE: resumeKsCmdRun, } func init() { diff --git a/cmd/tk/suspend.go b/cmd/tk/suspend.go index 1a681008..5806915b 100644 --- a/cmd/tk/suspend.go +++ b/cmd/tk/suspend.go @@ -22,7 +22,8 @@ import ( var suspendCmd = &cobra.Command{ Use: "suspend", - Short: "Suspend commands", + Short: "Suspend resources", + Long: "The suspend sub-commands suspend the reconciliation of a resource.", } func init() { diff --git a/cmd/tk/suspend_kustomization.go b/cmd/tk/suspend_kustomization.go index 685c181b..6c8dd41b 100644 --- a/cmd/tk/suspend_kustomization.go +++ b/cmd/tk/suspend_kustomization.go @@ -27,7 +27,7 @@ import ( var suspendKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Suspend kustomization", + Short: "Suspend reconciliation of Kustomization", Long: "The suspend command disables the reconciliation of a Kustomization resource.", RunE: suspendKsCmdRun, } diff --git a/cmd/tk/sync.go b/cmd/tk/sync.go index eb37a993..96a5b7b8 100644 --- a/cmd/tk/sync.go +++ b/cmd/tk/sync.go @@ -22,7 +22,8 @@ import ( var syncCmd = &cobra.Command{ Use: "sync", - Short: "Synchronize commands", + Short: "Synchronize sources and resources", + Long: "The sync sub-commands trigger a reconciliation of sources and resources.", } func init() { diff --git a/cmd/tk/sync_kustomization.go b/cmd/tk/sync_kustomization.go index 4ea69822..492c88f0 100644 --- a/cmd/tk/sync_kustomization.go +++ b/cmd/tk/sync_kustomization.go @@ -30,13 +30,13 @@ import ( var syncKsCmd = &cobra.Command{ Use: "kustomization [name]", Aliases: []string{"ks"}, - Short: "Synchronize kustomization", + Short: "Synchronize a Kustomization resource", Long: ` The sync kustomization command triggers a reconciliation of a Kustomization resource and waits for it to finish.`, - Example: ` # Trigger a kustomization apply outside of the reconciliation interval + Example: ` # 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 `, RunE: syncKsCmdRun, diff --git a/cmd/tk/sync_source.go b/cmd/tk/sync_source.go index 2f2bff48..f18564b5 100644 --- a/cmd/tk/sync_source.go +++ b/cmd/tk/sync_source.go @@ -22,7 +22,8 @@ import ( var syncSourceCmd = &cobra.Command{ Use: "source", - Short: "Synchronize source commands", + Short: "Synchronize sources", + Long: "The sync source sub-commands trigger a reconciliation of sources.", } func init() { diff --git a/cmd/tk/sync_source_git.go b/cmd/tk/sync_source_git.go index efa0678a..610bcf7b 100644 --- a/cmd/tk/sync_source_git.go +++ b/cmd/tk/sync_source_git.go @@ -28,9 +28,8 @@ import ( var syncSourceGitCmd = &cobra.Command{ Use: "git [name]", - Short: "Synchronize git source", - Long: ` -The sync source command triggers a reconciliation of a GitRepository resource and waits for it to finish.`, + Short: "Synchronize a GitRepository source", + Long: `The sync source command triggers a reconciliation of a GitRepository resource and waits for it to finish.`, Example: ` # Trigger a git pull for an existing source sync source git podinfo `, diff --git a/cmd/tk/uninstall.go b/cmd/tk/uninstall.go index 4bda3b4d..26f8e145 100644 --- a/cmd/tk/uninstall.go +++ b/cmd/tk/uninstall.go @@ -28,9 +28,7 @@ import ( var uninstallCmd = &cobra.Command{ Use: "uninstall", Short: "Uninstall the toolkit components", - Long: ` -The uninstall command removes the namespace, cluster roles, -cluster role bindings and CRDs.`, + Long: "The uninstall command removes the namespace, cluster roles, cluster role bindings and CRDs from the cluster.", Example: ` # Dry-run uninstall of all components uninstall --dry-run --namespace=gitops-system @@ -49,7 +47,7 @@ var ( func init() { uninstallCmd.Flags().BoolVarP(&uninstallKustomizations, "kustomizations", "", false, - "removes all kustomizations previously installed") + "removes all Kustomizations previously installed") uninstallCmd.Flags().BoolVarP(&uninstallCRDs, "crds", "", false, "removes all CRDs previously installed") uninstallCmd.Flags().BoolVarP(&uninstallDryRun, "dry-run", "", false, diff --git a/docs/cmd/tk.md b/docs/cmd/tk.md index 0f7ec9d4..914459ae 100644 --- a/docs/cmd/tk.md +++ b/docs/cmd/tk.md @@ -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 diff --git a/docs/cmd/tk_bootstrap.md b/docs/cmd/tk_bootstrap.md index 8df7d97b..2c9f428c 100644 --- a/docs/cmd/tk_bootstrap.md +++ b/docs/cmd/tk_bootstrap.md @@ -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 diff --git a/docs/cmd/tk_bootstrap_github.md b/docs/cmd/tk_bootstrap_github.md index 90b02d40..c4764b74 100644 --- a/docs/cmd/tk_bootstrap_github.md +++ b/docs/cmd/tk_bootstrap_github.md @@ -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 diff --git a/docs/cmd/tk_bootstrap_gitlab.md b/docs/cmd/tk_bootstrap_gitlab.md index 11bbebe0..70ee015e 100644 --- a/docs/cmd/tk_bootstrap_gitlab.md +++ b/docs/cmd/tk_bootstrap_gitlab.md @@ -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 diff --git a/docs/cmd/tk_check.md b/docs/cmd/tk_check.md index 4c91bcd2..50405160 100644 --- a/docs/cmd/tk_check.md +++ b/docs/cmd/tk_check.md @@ -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. diff --git a/docs/cmd/tk_create.md b/docs/cmd/tk_create.md index ace30676..eba8678c 100644 --- a/docs/cmd/tk_create.md +++ b/docs/cmd/tk_create.md @@ -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 diff --git a/docs/cmd/tk_create_kustomization.md b/docs/cmd/tk_create_kustomization.md index 3717a61e..1cfc020f 100644 --- a/docs/cmd/tk_create_kustomization.md +++ b/docs/cmd/tk_create_kustomization.md @@ -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 '/.' --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 diff --git a/docs/cmd/tk_create_source.md b/docs/cmd/tk_create_source.md index 1fa8a932..b3ff45c5 100644 --- a/docs/cmd/tk_create_source.md +++ b/docs/cmd/tk_create_source.md @@ -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 diff --git a/docs/cmd/tk_create_source_git.md b/docs/cmd/tk_create_source_git.md index 84d94b9c..276115fa 100644 --- a/docs/cmd/tk_create_source_git.md +++ b/docs/cmd/tk_create_source_git.md @@ -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 diff --git a/docs/cmd/tk_delete.md b/docs/cmd/tk_delete.md index 03d6d812..e961029f 100644 --- a/docs/cmd/tk_delete.md +++ b/docs/cmd/tk_delete.md @@ -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 diff --git a/docs/cmd/tk_delete_kustomization.md b/docs/cmd/tk_delete_kustomization.md index e41d25f8..99f2e6c7 100644 --- a/docs/cmd/tk_delete_kustomization.md +++ b/docs/cmd/tk_delete_kustomization.md @@ -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 diff --git a/docs/cmd/tk_delete_source.md b/docs/cmd/tk_delete_source.md index 8afd186e..14747756 100644 --- a/docs/cmd/tk_delete_source.md +++ b/docs/cmd/tk_delete_source.md @@ -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 diff --git a/docs/cmd/tk_delete_source_git.md b/docs/cmd/tk_delete_source_git.md index 1d201b24..50ce4508 100644 --- a/docs/cmd/tk_delete_source_git.md +++ b/docs/cmd/tk_delete_source_git.md @@ -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 diff --git a/docs/cmd/tk_export.md b/docs/cmd/tk_export.md index 4ae12698..74871891 100644 --- a/docs/cmd/tk_export.md +++ b/docs/cmd/tk_export.md @@ -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 diff --git a/docs/cmd/tk_export_kustomization.md b/docs/cmd/tk_export_kustomization.md index ca7aa08a..986d6a4a 100644 --- a/docs/cmd/tk_export_kustomization.md +++ b/docs/cmd/tk_export_kustomization.md @@ -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 diff --git a/docs/cmd/tk_export_source.md b/docs/cmd/tk_export_source.md index 01525f11..36d40b75 100644 --- a/docs/cmd/tk_export_source.md +++ b/docs/cmd/tk_export_source.md @@ -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 diff --git a/docs/cmd/tk_export_source_git.md b/docs/cmd/tk_export_source_git.md index a1d21b27..613fcd6e 100644 --- a/docs/cmd/tk_export_source_git.md +++ b/docs/cmd/tk_export_source_git.md @@ -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 diff --git a/docs/cmd/tk_get.md b/docs/cmd/tk_get.md index bf967f32..2f6d1620 100644 --- a/docs/cmd/tk_get.md +++ b/docs/cmd/tk_get.md @@ -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 diff --git a/docs/cmd/tk_get_kustomizations.md b/docs/cmd/tk_get_kustomizations.md index 5f0e1dd0..2553ff02 100644 --- a/docs/cmd/tk_get_kustomizations.md +++ b/docs/cmd/tk_get_kustomizations.md @@ -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 diff --git a/docs/cmd/tk_get_sources.md b/docs/cmd/tk_get_sources.md index 4aba8973..31422e5b 100644 --- a/docs/cmd/tk_get_sources.md +++ b/docs/cmd/tk_get_sources.md @@ -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 diff --git a/docs/cmd/tk_get_sources_git.md b/docs/cmd/tk_get_sources_git.md index 9f027e1e..673d7e30 100644 --- a/docs/cmd/tk_get_sources_git.md +++ b/docs/cmd/tk_get_sources_git.md @@ -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 diff --git a/docs/cmd/tk_install.md b/docs/cmd/tk_install.md index 13c786f2..e50bc263 100644 --- a/docs/cmd/tk_install.md +++ b/docs/cmd/tk_install.md @@ -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. diff --git a/docs/cmd/tk_resume.md b/docs/cmd/tk_resume.md index 637e7e55..2c9b8b40 100644 --- a/docs/cmd/tk_resume.md +++ b/docs/cmd/tk_resume.md @@ -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 diff --git a/docs/cmd/tk_resume_kustomization.md b/docs/cmd/tk_resume_kustomization.md index dfc54c6f..8111f985 100644 --- a/docs/cmd/tk_resume_kustomization.md +++ b/docs/cmd/tk_resume_kustomization.md @@ -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 diff --git a/docs/cmd/tk_suspend.md b/docs/cmd/tk_suspend.md index bdf098ea..29c58a5b 100644 --- a/docs/cmd/tk_suspend.md +++ b/docs/cmd/tk_suspend.md @@ -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 diff --git a/docs/cmd/tk_suspend_kustomization.md b/docs/cmd/tk_suspend_kustomization.md index 8cf7c40a..172fa31d 100644 --- a/docs/cmd/tk_suspend_kustomization.md +++ b/docs/cmd/tk_suspend_kustomization.md @@ -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 diff --git a/docs/cmd/tk_sync.md b/docs/cmd/tk_sync.md index 7d1c5529..27b07188 100644 --- a/docs/cmd/tk_sync.md +++ b/docs/cmd/tk_sync.md @@ -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 diff --git a/docs/cmd/tk_sync_kustomization.md b/docs/cmd/tk_sync_kustomization.md index 3876858e..bbeb248f 100644 --- a/docs/cmd/tk_sync_kustomization.md +++ b/docs/cmd/tk_sync_kustomization.md @@ -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 diff --git a/docs/cmd/tk_sync_source.md b/docs/cmd/tk_sync_source.md index 0bb95428..75c5740e 100644 --- a/docs/cmd/tk_sync_source.md +++ b/docs/cmd/tk_sync_source.md @@ -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 diff --git a/docs/cmd/tk_sync_source_git.md b/docs/cmd/tk_sync_source_git.md index bc14e95e..21957240 100644 --- a/docs/cmd/tk_sync_source_git.md +++ b/docs/cmd/tk_sync_source_git.md @@ -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 diff --git a/docs/cmd/tk_uninstall.md b/docs/cmd/tk_uninstall.md index 9b5ea574..5fe04e35 100644 --- a/docs/cmd/tk_uninstall.md +++ b/docs/cmd/tk_uninstall.md @@ -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 ```