From 4abe69f90a54958e029a305ee718a0a2d362ff00 Mon Sep 17 00:00:00 2001
From: Michael Bridgen <michael@weave.works>
Date: Fri, 11 Dec 2020 12:40:50 +0000
Subject: [PATCH] Give flux bootstrap the extra components flag
This commit adds a flag for supplying extra components to bootstrap
(and its subcommands), to match the one for `flux install`.
Since the bootstrapComponents global is used in a few places, I made
it a func and renamed the variable. For consistency, I also renamed
the var used in install.go.
Lastly, so that the flag sorts next to `--components`, I changed it to
`--components-extra` in both commands.
Signed-off-by: Michael Bridgen <michael@weave.works>
---
cmd/flux/bootstrap.go | 17 ++++++++++++-----
cmd/flux/bootstrap_github.go | 2 +-
cmd/flux/bootstrap_gitlab.go | 2 +-
cmd/flux/install.go | 8 ++++----
docs/cmd/flux_bootstrap.md | 1 +
docs/cmd/flux_bootstrap_github.md | 1 +
docs/cmd/flux_bootstrap_gitlab.md | 1 +
docs/cmd/flux_install.md | 2 +-
8 files changed, 22 insertions(+), 12 deletions(-)
diff --git a/cmd/flux/bootstrap.go b/cmd/flux/bootstrap.go
index c0d8d4de..390a0f99 100644
--- a/cmd/flux/bootstrap.go
+++ b/cmd/flux/bootstrap.go
@@ -47,7 +47,8 @@ var bootstrapCmd = &cobra.Command{
var (
bootstrapVersion string
- bootstrapComponents []string
+ bootstrapDefaultComponents []string
+ bootstrapExtraComponents []string
bootstrapRegistry string
bootstrapImagePullSecret string
bootstrapBranch string
@@ -67,8 +68,10 @@ const (
func init() {
bootstrapCmd.PersistentFlags().StringVarP(&bootstrapVersion, "version", "v", defaults.Version,
"toolkit version")
- bootstrapCmd.PersistentFlags().StringSliceVar(&bootstrapComponents, "components", defaults.Components,
+ bootstrapCmd.PersistentFlags().StringSliceVar(&bootstrapDefaultComponents, "components", defaults.Components,
"list of components, accepts comma-separated values")
+ bootstrapCmd.PersistentFlags().StringSliceVar(&bootstrapExtraComponents, "components-extra", nil,
+ "list of components in addition to those supplied or defaulted, accepts comma-separated values")
bootstrapCmd.PersistentFlags().StringVar(&bootstrapRegistry, "registry", "ghcr.io/fluxcd",
"container registry where the toolkit images are published")
bootstrapCmd.PersistentFlags().StringVar(&bootstrapImagePullSecret, "image-pull-secret", "",
@@ -88,13 +91,17 @@ func init() {
rootCmd.AddCommand(bootstrapCmd)
}
+func bootstrapComponents() []string {
+ return append(bootstrapDefaultComponents, bootstrapExtraComponents...)
+}
+
func bootstrapValidate() error {
+ components := bootstrapComponents()
for _, component := range bootstrapRequiredComponents {
- if !utils.ContainsItemString(bootstrapComponents, component) {
+ if !utils.ContainsItemString(components, component) {
return fmt.Errorf("component %s is required", component)
}
}
-
return nil
}
@@ -103,7 +110,7 @@ func generateInstallManifests(targetPath, namespace, tmpDir string, localManifes
BaseURL: localManifests,
Version: bootstrapVersion,
Namespace: namespace,
- Components: bootstrapComponents,
+ Components: bootstrapComponents(),
Registry: bootstrapRegistry,
ImagePullSecret: bootstrapImagePullSecret,
Arch: bootstrapArch.String(),
diff --git a/cmd/flux/bootstrap_github.go b/cmd/flux/bootstrap_github.go
index a17837d4..e8c21606 100644
--- a/cmd/flux/bootstrap_github.go
+++ b/cmd/flux/bootstrap_github.go
@@ -206,7 +206,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
if isInstall {
// apply install manifests
logger.Actionf("installing components in %s namespace", namespace)
- if err := applyInstallManifests(ctx, manifest, bootstrapComponents); err != nil {
+ if err := applyInstallManifests(ctx, manifest, bootstrapComponents()); err != nil {
return err
}
logger.Successf("install completed")
diff --git a/cmd/flux/bootstrap_gitlab.go b/cmd/flux/bootstrap_gitlab.go
index 546d93fb..1d8c6884 100644
--- a/cmd/flux/bootstrap_gitlab.go
+++ b/cmd/flux/bootstrap_gitlab.go
@@ -172,7 +172,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
if isInstall {
// apply install manifests
logger.Actionf("installing components in %s namespace", namespace)
- if err := applyInstallManifests(ctx, manifest, bootstrapComponents); err != nil {
+ if err := applyInstallManifests(ctx, manifest, bootstrapComponents()); err != nil {
return err
}
logger.Successf("install completed")
diff --git a/cmd/flux/install.go b/cmd/flux/install.go
index 3bcd6911..7496722f 100644
--- a/cmd/flux/install.go
+++ b/cmd/flux/install.go
@@ -56,7 +56,7 @@ var (
installDryRun bool
installManifestsPath string
installVersion string
- installComponents []string
+ installDefaultComponents []string
installExtraComponents []string
installRegistry string
installImagePullSecret string
@@ -73,9 +73,9 @@ func init() {
"only print the object that would be applied")
installCmd.Flags().StringVarP(&installVersion, "version", "v", defaults.Version,
"toolkit version")
- installCmd.Flags().StringSliceVar(&installComponents, "components", defaults.Components,
+ installCmd.Flags().StringSliceVar(&installDefaultComponents, "components", defaults.Components,
"list of components, accepts comma-separated values")
- installCmd.Flags().StringSliceVar(&installExtraComponents, "extra-components", nil,
+ installCmd.Flags().StringSliceVar(&installExtraComponents, "components-extra", nil,
"list of components in addition to those supplied or defaulted, accepts comma-separated values")
installCmd.Flags().StringVar(&installManifestsPath, "manifests", "", "path to the manifest directory")
installCmd.Flags().MarkHidden("manifests")
@@ -106,7 +106,7 @@ func installCmdRun(cmd *cobra.Command, args []string) error {
logger.Generatef("generating manifests")
}
- components := append(installComponents, installExtraComponents...)
+ components := append(installDefaultComponents, installExtraComponents...)
opts := install.Options{
BaseURL: installManifestsPath,
diff --git a/docs/cmd/flux_bootstrap.md b/docs/cmd/flux_bootstrap.md
index 4d1f20b0..19a2abdf 100644
--- a/docs/cmd/flux_bootstrap.md
+++ b/docs/cmd/flux_bootstrap.md
@@ -12,6 +12,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
--arch arch cluster architecture, available options are: (amd64, arm, arm64) (default amd64)
--branch string default branch (for GitHub this must match the default branch setting for the organization) (default "main")
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
+ --components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
-h, --help help for bootstrap
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--log-level logLevel log level, available options are: (debug, info, error) (default info)
diff --git a/docs/cmd/flux_bootstrap_github.md b/docs/cmd/flux_bootstrap_github.md
index 4186515a..c34e2342 100644
--- a/docs/cmd/flux_bootstrap_github.md
+++ b/docs/cmd/flux_bootstrap_github.md
@@ -64,6 +64,7 @@ flux bootstrap github [flags]
--arch arch cluster architecture, available options are: (amd64, arm, arm64) (default amd64)
--branch string default branch (for GitHub this must match the default branch setting for the organization) (default "main")
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
+ --components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--context string kubernetes context to use
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
diff --git a/docs/cmd/flux_bootstrap_gitlab.md b/docs/cmd/flux_bootstrap_gitlab.md
index a4682511..86b391f7 100644
--- a/docs/cmd/flux_bootstrap_gitlab.md
+++ b/docs/cmd/flux_bootstrap_gitlab.md
@@ -60,6 +60,7 @@ flux bootstrap gitlab [flags]
--arch arch cluster architecture, available options are: (amd64, arm, arm64) (default amd64)
--branch string default branch (for GitHub this must match the default branch setting for the organization) (default "main")
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
+ --components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--context string kubernetes context to use
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
diff --git a/docs/cmd/flux_install.md b/docs/cmd/flux_install.md
index 61bfb00f..f1e80868 100644
--- a/docs/cmd/flux_install.md
+++ b/docs/cmd/flux_install.md
@@ -33,9 +33,9 @@ flux install [flags]
```
--arch arch cluster architecture, available options are: (amd64, arm, arm64) (default amd64)
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
+ --components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--dry-run only print the object that would be applied
--export write the install manifests to stdout and exit
- --extra-components strings list of components in addition to those supplied or defaulted, accepts comma-separated values
-h, --help help for install
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--log-level logLevel log level, available options are: (debug, info, error) (default info)
--
GitLab