Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-09 03:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #84 from fluxcd/default-components

Browse Source 
Refactor install defaults
This commit is contained in:
Stefan Prodan
2020-07-14 11:19:31 +03:00
committed by GitHub
parent 43cfc55368 e180611024
commit bf67577073
38 changed files with 184 additions and 200 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cmd/tk/bootstrap.go
View File

@@ -45,7 +45,8 @@ var bootstrapCmd = &cobra.Command{
} }
var ( var (
bootstrapVersion string bootstrapVersion string
bootstrapComponents []string
) )
const ( const (
@@ -56,7 +57,10 @@ const (
) )
func init() { func init() {
bootstrapCmd.PersistentFlags().StringVar(&bootstrapVersion, "version", "master", "toolkit tag or branch") bootstrapCmd.PersistentFlags().StringVarP(&bootstrapVersion, "version", "v", defaultVersion,
"toolkit tag or branch")
bootstrapCmd.PersistentFlags().StringSliceVar(&bootstrapComponents, "components", defaultComponents,
"list of components, accepts comma-separated values")
rootCmd.AddCommand(bootstrapCmd) rootCmd.AddCommand(bootstrapCmd)
} }
@@ -69,7 +73,7 @@ func generateInstallManifests(targetPath, namespace, tmpDir string) (string, err
return "", fmt.Errorf("generating manifests failed: %w", err) return "", fmt.Errorf("generating manifests failed: %w", err)
} }
if err := genInstallManifests(bootstrapVersion, namespace, components, tkDir); err != nil { if err := genInstallManifests(bootstrapVersion, namespace, bootstrapComponents, tkDir); err != nil {
return "", fmt.Errorf("generating manifests failed: %w", err) return "", fmt.Errorf("generating manifests failed: %w", err)
} }

2
cmd/tk/bootstrap_github.go
View File

@@ -175,7 +175,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
if isInstall { if isInstall {
// apply install manifests // apply install manifests
logger.Actionf("installing components in %s namespace", namespace) logger.Actionf("installing components in %s namespace", namespace)
if err := applyInstallManifests(ctx, manifest, components); err != nil { if err := applyInstallManifests(ctx, manifest, bootstrapComponents); err != nil {
return err return err
} }
logger.Successf("install completed") logger.Successf("install completed")

2
cmd/tk/bootstrap_gitlab.go
View File

@@ -153,7 +153,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
if isInstall { if isInstall {
// apply install manifests // apply install manifests
logger.Actionf("installing components in %s namespace", namespace) logger.Actionf("installing components in %s namespace", namespace)
if err := applyInstallManifests(ctx, manifest, components); err != nil { if err := applyInstallManifests(ctx, manifest, bootstrapComponents); err != nil {
return err return err
} }
logger.Successf("install completed") logger.Successf("install completed")

12
cmd/tk/check.go
View File

@@ -35,22 +35,24 @@ var checkCmd = &cobra.Command{
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.`, the local environment is configured correctly and if the installed components are healthy.`,
Example: ` # Run pre-installation checks Example: ` # Run pre-installation checks
check --pre tk check --pre
# Run installation checks # Run installation checks
check tk check
`, `,
RunE: runCheckCmd, RunE: runCheckCmd,
} }
var ( var (
checkPre bool checkPre bool
checkComponents []string
) )
func init() { func init() {
checkCmd.Flags().BoolVarP(&checkPre, "pre", "", false, checkCmd.Flags().BoolVarP(&checkPre, "pre", "", false,
"only run pre-installation checks") "only run pre-installation checks")
checkCmd.Flags().StringSliceVar(&checkComponents, "components", defaultComponents,
"list of components, accepts comma-separated values")
rootCmd.AddCommand(checkCmd) rootCmd.AddCommand(checkCmd)
} }
@@ -158,7 +160,7 @@ func componentsCheck() bool {
defer cancel() defer cancel()
ok := true ok := true
for _, deployment := range components { for _, deployment := range checkComponents {
command := fmt.Sprintf("kubectl -n %s rollout status deployment %s --timeout=%s", command := fmt.Sprintf("kubectl -n %s rollout status deployment %s --timeout=%s",
namespace, deployment, timeout.String()) namespace, deployment, timeout.String())
if output, err := utils.execCommand(ctx, ModeCapture, command); err != nil { if output, err := utils.execCommand(ctx, ModeCapture, command); err != nil {

15
cmd/tk/install.go
View File

@@ -36,13 +36,13 @@ var installCmd = &cobra.Command{
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.`, If a previous version is installed, then an in-place upgrade will be performed.`,
Example: ` # Install the latest version in the gitops-systems namespace Example: ` # Install the latest version in the gitops-systems namespace
install --version=master --namespace=gitops-systems tk install --version=master --namespace=gitops-systems
# Dry-run install for a specific version and a series of components # Dry-run install for a specific version and a series of components
install --dry-run --version=0.0.1 --components="source-controller,kustomize-controller" tk install --dry-run --version=0.0.1 --components="source-controller,kustomize-controller"
# Dry-run install with manifests preview # Dry-run install with manifests preview
install --dry-run --verbose tk install --dry-run --verbose
`, `,
RunE: installCmdRun, RunE: installCmdRun,
} }
@@ -51,13 +51,16 @@ var (
installDryRun bool installDryRun bool
installManifestsPath string installManifestsPath string
installVersion string installVersion string
installComponents []string
) )
func init() { func init() {
installCmd.Flags().BoolVarP(&installDryRun, "dry-run", "", false, installCmd.Flags().BoolVarP(&installDryRun, "dry-run", "", false,
"only print the object that would be applied") "only print the object that would be applied")
installCmd.Flags().StringVarP(&installVersion, "version", "v", "master", installCmd.Flags().StringVarP(&installVersion, "version", "v", defaultVersion,
"toolkit tag or branch") "toolkit tag or branch")
installCmd.Flags().StringSliceVar(&installComponents, "components", defaultComponents,
"list of components, accepts comma-separated values")
installCmd.Flags().StringVarP(&installManifestsPath, "manifests", "", "", installCmd.Flags().StringVarP(&installManifestsPath, "manifests", "", "",
"path to the manifest directory, dev only") "path to the manifest directory, dev only")
rootCmd.AddCommand(installCmd) rootCmd.AddCommand(installCmd)
@@ -83,7 +86,7 @@ func installCmdRun(cmd *cobra.Command, args []string) error {
logger.Generatef("generating manifests") logger.Generatef("generating manifests")
if kustomizePath == "" { if kustomizePath == "" {
err = genInstallManifests(installVersion, namespace, components, tmpDir) err = genInstallManifests(installVersion, namespace, installComponents, tmpDir)
if err != nil { if err != nil {
return fmt.Errorf("install failed: %w", err) return fmt.Errorf("install failed: %w", err)
} }
@@ -128,7 +131,7 @@ func installCmdRun(cmd *cobra.Command, args []string) error {
} }
logger.Waitingf("verifying installation") logger.Waitingf("verifying installation")
for _, deployment := range components { for _, deployment := range installComponents {
command = fmt.Sprintf("kubectl -n %s rollout status deployment %s --timeout=%s", command = fmt.Sprintf("kubectl -n %s rollout status deployment %s --timeout=%s",
namespace, deployment, timeout.String()) namespace, deployment, timeout.String())
if _, err := utils.execCommand(ctx, applyOutput, command); err != nil { if _, err := utils.execCommand(ctx, applyOutput, command); err != nil {

12
cmd/tk/main.go
View File

@@ -98,22 +98,24 @@ var (
namespace string namespace string
timeout time.Duration timeout time.Duration
verbose bool verbose bool
components []string
utils Utils utils Utils
pollInterval = 2 * time.Second pollInterval = 2 * time.Second
logger tklog.Logger = printLogger{} logger tklog.Logger = printLogger{}
) )
var (
defaultComponents = []string{"source-controller", "kustomize-controller", "helm-controller", "notification-controller"}
defaultVersion = "master"
defaultNamespace = "gitops-system"
)
func init() { func init() {
rootCmd.PersistentFlags().StringVarP(&namespace, "namespace", "", "gitops-system", rootCmd.PersistentFlags().StringVar(&namespace, "namespace", defaultNamespace,
"the namespace scope for this operation") "the namespace scope for this operation")
rootCmd.PersistentFlags().DurationVarP(&timeout, "timeout", "", 5*time.Minute, rootCmd.PersistentFlags().DurationVarP(&timeout, "timeout", "", 5*time.Minute,
"timeout for this operation") "timeout for this operation")
rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "", false, rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "", false,
"print generated objects") "print generated objects")
rootCmd.PersistentFlags().StringSliceVar(&components, "components",
[]string{"source-controller", "kustomize-controller", "helm-controller", "notification-controller"},
"list of components, accepts comma-separated values")
} }
func main() { func main() {

11
docs/cmd/tk.md
View File

@@ -67,12 +67,11 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### Options ### Options
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) -h, --help help for tk
-h, --help help for tk --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

14
docs/cmd/tk_bootstrap.md
View File

@@ -9,18 +9,18 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
### Options ### Options
``` ```
-h, --help help for bootstrap --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--version string toolkit tag or branch (default "master") -h, --help help for bootstrap
-v, --version string toolkit tag or branch (default "master")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

2
docs/cmd/tk_bootstrap_github.md
View File

@@ -59,7 +59,7 @@ tk bootstrap github [flags]
--namespace string the namespace scope for this operation (default "gitops-system") --namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s) --timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects --verbose print generated objects
--version string toolkit tag or branch (default "master") -v, --version string toolkit tag or branch (default "master")
``` ```
### SEE ALSO ### SEE ALSO

2
docs/cmd/tk_bootstrap_gitlab.md
View File

@@ -55,7 +55,7 @@ tk bootstrap gitlab [flags]
--namespace string the namespace scope for this operation (default "gitops-system") --namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s) --timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects --verbose print generated objects
--version string toolkit tag or branch (default "master") -v, --version string toolkit tag or branch (default "master")
``` ```
### SEE ALSO ### SEE ALSO

18
docs/cmd/tk_check.md
View File

@@ -15,28 +15,28 @@ tk check [flags]
``` ```
# Run pre-installation checks # Run pre-installation checks
check --pre tk check --pre
# Run installation checks # Run installation checks
check tk check
``` ```
### Options ### Options
``` ```
-h, --help help for check --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--pre only run pre-installation checks -h, --help help for check
--pre only run pre-installation checks
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_completion.md
View File

@@ -33,11 +33,10 @@ To configure your bash shell to load completions for each session add to your ba
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_create.md
View File

@@ -17,11 +17,10 @@ The create sub-commands generate sources and resources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

13
docs/cmd/tk_create_kustomization.md
View File

@@ -63,13 +63,12 @@ tk create kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --export export in YAML format to stdout
--export export in YAML format to stdout --interval duration source sync interval (default 1m0s)
--interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

13
docs/cmd/tk_create_source.md
View File

@@ -15,13 +15,12 @@ The create source sub-commands generate sources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --export export in YAML format to stdout
--export export in YAML format to stdout --interval duration source sync interval (default 1m0s)
--interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

13
docs/cmd/tk_create_source_git.md
View File

@@ -70,13 +70,12 @@ tk create source git [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --export export in YAML format to stdout
--export export in YAML format to stdout --interval duration source sync interval (default 1m0s)
--interval duration source sync interval (default 1m0s) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_delete.md
View File

@@ -16,11 +16,10 @@ The delete sub-commands delete sources and resources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

11
docs/cmd/tk_delete_kustomization.md
View File

@@ -19,12 +19,11 @@ tk delete kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") -s, --silent delete resource without asking for confirmation
-s, --silent delete resource without asking for confirmation --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

11
docs/cmd/tk_delete_source.md
View File

@@ -15,12 +15,11 @@ The delete source sub-commands delete sources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") -s, --silent delete resource without asking for confirmation
-s, --silent delete resource without asking for confirmation --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

11
docs/cmd/tk_delete_source_git.md
View File

@@ -19,12 +19,11 @@ tk delete source git [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") -s, --silent delete resource without asking for confirmation
-s, --silent delete resource without asking for confirmation --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_export.md
View File

@@ -16,11 +16,10 @@ The export sub-commands export resources in YAML format.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

11
docs/cmd/tk_export_kustomization.md
View File

@@ -30,12 +30,11 @@ tk export kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--all select all resources --all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

11
docs/cmd/tk_export_source.md
View File

@@ -16,12 +16,11 @@ The export source sub-commands export sources in YAML format.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--all select all resources --all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

13
docs/cmd/tk_export_source_git.md
View File

@@ -30,13 +30,12 @@ tk export source git [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--all select all resources --all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects --with-credentials include credential secrets
--with-credentials include credential secrets
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_get.md
View File

@@ -15,11 +15,10 @@ The get sub-commands print the statuses of sources and resources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_get_kustomizations.md
View File

@@ -19,11 +19,10 @@ tk get kustomizations [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_get_sources.md
View File

@@ -15,11 +15,10 @@ The get source sub-commands print the statuses of the sources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_get_sources_git.md
View File

@@ -19,11 +19,10 @@ tk get sources git [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

24
docs/cmd/tk_install.md
View File

@@ -15,33 +15,33 @@ tk install [flags]
``` ```
# Install the latest version in the gitops-systems namespace # Install the latest version in the gitops-systems namespace
install --version=master --namespace=gitops-systems tk install --version=master --namespace=gitops-systems
# Dry-run install for a specific version and a series of components # Dry-run install for a specific version and a series of components
install --dry-run --version=0.0.1 --components="source-controller,kustomize-controller" tk install --dry-run --version=0.0.1 --components="source-controller,kustomize-controller"
# Dry-run install with manifests preview # Dry-run install with manifests preview
install --dry-run --verbose tk install --dry-run --verbose
``` ```
### Options ### Options
``` ```
--dry-run only print the object that would be applied --components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
-h, --help help for install --dry-run only print the object that would be applied
--manifests string path to the manifest directory, dev only -h, --help help for install
-v, --version string toolkit tag or branch (default "master") --manifests string path to the manifest directory, dev only
-v, --version string toolkit tag or branch (default "master")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_resume.md
View File

@@ -15,11 +15,10 @@ The resume sub-commands resume a suspended resource.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_resume_kustomization.md
View File

@@ -20,11 +20,10 @@ tk resume kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_suspend.md
View File

@@ -15,11 +15,10 @@ The suspend sub-commands suspend the reconciliation of a resource.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_suspend_kustomization.md
View File

@@ -19,11 +19,10 @@ tk suspend kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_sync.md
View File

@@ -15,11 +15,10 @@ The sync sub-commands trigger a reconciliation of sources and resources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_sync_kustomization.md
View File

@@ -32,11 +32,10 @@ tk sync kustomization [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_sync_source.md
View File

@@ -15,11 +15,10 @@ The sync source sub-commands trigger a reconciliation of sources.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_sync_source_git.md
View File

@@ -27,11 +27,10 @@ tk sync source git [name] [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO

9
docs/cmd/tk_uninstall.md
View File

@@ -34,11 +34,10 @@ tk uninstall [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller]) --kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-system")
--namespace string the namespace scope for this operation (default "gitops-system") --timeout duration timeout for this operation (default 5m0s)
--timeout duration timeout for this operation (default 5m0s) --verbose print generated objects
--verbose print generated objects
``` ```
### SEE ALSO ### SEE ALSO