Create Namespace with --create-namespace Flag (#1531)

Signed-off-by: Ken Sipe <kensipe@gmail.com>
kudobuilder · May 18, 2020 · ec540a1 · ec540a1
1 parent 474c4e3
commit ec540a1
Show file tree

Hide file tree

Showing 14 changed files with 50 additions and 4 deletions.
diff --git a/config/crds/kudo.dev_operators.yaml b/config/crds/kudo.dev_operators.yaml
@@ -53,6 +53,8 @@ spec:
                     type: string
                 type: object
               type: array
+            namespaceManifest:
+              type: string
             url:
               type: string
           type: object

diff --git a/pkg/apis/kudo/v1beta1/operator_types.go b/pkg/apis/kudo/v1beta1/operator_types.go
@@ -26,6 +26,7 @@ type OperatorSpec struct {
 	KubernetesVersion string        `json:"kubernetesVersion,omitempty"`
 	Maintainers       []*Maintainer `json:"maintainers,omitempty"`
 	URL               string        `json:"url,omitempty"`
+	NamespaceManifest string        `json:"namespaceManifest,omitempty"`
 }
 
 // Maintainer describes an Operator maintainer.

diff --git a/pkg/kudoctl/cmd/install.go b/pkg/kudoctl/cmd/install.go
@@ -62,6 +62,7 @@ func newInstallCmd(fs afero.Fs) *cobra.Command {
 	installCmd.Flags().BoolVar(&options.SkipInstance, "skip-instance", false, "If set, install will install the Operator and OperatorVersion, but not an Instance. (default \"false\")")
 	installCmd.Flags().BoolVar(&options.Wait, "wait", false, "Specify if the CLI should wait for the install to complete before returning (default \"false\")")
 	installCmd.Flags().Int64Var(&options.WaitTime, "wait-time", 300, "Specify the max wait time in seconds for CLI for the install to complete before returning (default \"300\")")
+	installCmd.Flags().BoolVar(&options.CreateNameSpace, "create-namespace", false, "If set, install will create the specified namespace and will fail if it exists. (default \"false\")")
 
 	return installCmd
 }
diff --git a/pkg/kudoctl/cmd/install/install.go b/pkg/kudoctl/cmd/install/install.go
@@ -29,6 +29,7 @@ type Options struct {
 	RequestTimeout  int64
 	Wait            bool
 	WaitTime        int64
+	CreateNameSpace bool
 }
 
 // DefaultOptions initializes the install command options to its defaults
@@ -78,5 +79,5 @@ func installOperator(operatorArgument string, options *Options, fs afero.Fs, set
 		return fmt.Errorf("failed to resolve operator package for: %s %w", operatorArgument, err)
 	}
 
-	return kudo.InstallPackage(kc, pkg.Resources, options.SkipInstance, options.InstanceName, settings.Namespace, options.Parameters, options.Wait, time.Duration(options.WaitTime)*time.Second)
+	return kudo.InstallPackage(kc, pkg.Resources, options.SkipInstance, options.InstanceName, settings.Namespace, options.Parameters, options.Wait, options.CreateNameSpace, time.Duration(options.WaitTime)*time.Second)
 }
diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-ns.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-ns.yaml.golden
@@ -52,6 +52,8 @@ spec:
                     type: string
                 type: object
               type: array
+            namespaceManifest:
+              type: string
             url:
               type: string
           type: object

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-sa.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-sa.yaml.golden
@@ -52,6 +52,8 @@ spec:
                     type: string
                 type: object
               type: array
+            namespaceManifest:
+              type: string
             url:
               type: string
           type: object

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo-webhook.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo-webhook.yaml.golden
@@ -52,6 +52,8 @@ spec:
                     type: string
                 type: object
               type: array
+            namespaceManifest:
+              type: string
             url:
               type: string
           type: object

diff --git a/pkg/kudoctl/cmd/testdata/deploy-kudo.yaml.golden b/pkg/kudoctl/cmd/testdata/deploy-kudo.yaml.golden
@@ -52,6 +52,8 @@ spec:
                     type: string
                 type: object
               type: array
+            namespaceManifest:
+              type: string
             url:
               type: string
           type: object

diff --git a/pkg/kudoctl/kudoinit/crd/bindata.go b/pkg/kudoctl/kudoinit/crd/bindata.go
diff --git a/pkg/kudoctl/packages/convert/resources.go b/pkg/kudoctl/packages/convert/resources.go
@@ -45,6 +45,7 @@ func FilesToResources(files *packages.Files) (*packages.Resources, error) {
 			KubernetesVersion: files.Operator.KubernetesVersion,
 			Maintainers:       files.Operator.Maintainers,
 			URL:               files.Operator.URL,
+			NamespaceManifest: files.Operator.NamespaceManifest,
 		},
 		Status: v1beta1.OperatorStatus{},
 	}

diff --git a/pkg/kudoctl/packages/types.go b/pkg/kudoctl/packages/types.go
@@ -83,4 +83,5 @@ type OperatorFile struct {
 	URL               string                  `json:"url,omitempty"`
 	Tasks             []v1beta1.Task          `json:"tasks"`
 	Plans             map[string]v1beta1.Plan `json:"plans"`
+	NamespaceManifest string                  `json:"namespaceManifest,omitempty"`
 }
diff --git a/pkg/kudoctl/util/kudo/install.go b/pkg/kudoctl/util/kudo/install.go
@@ -15,13 +15,27 @@ import (
 
 // InstallPackage installs package resources.
 // If skipInstance is set to true, only a package's Operator and OperatorVersion is installed.
-func InstallPackage(kc *Client, resources *packages.Resources, skipInstance bool, instanceName, namespace string, parameters map[string]string, w bool, waitTime time.Duration) error {
+func InstallPackage(kc *Client, resources *packages.Resources, skipInstance bool, instanceName, namespace string, parameters map[string]string, w bool, createNS bool, waitTime time.Duration) error {
 	// PRE-INSTALLATION SETUP
 	operatorName := resources.Operator.ObjectMeta.Name
 	clog.V(3).Printf("operator name: %v", operatorName)
 	operatorVersion := resources.OperatorVersion.Spec.Version
 	clog.V(3).Printf("operator version: %v", operatorVersion)
 
+	if createNS {
+		clog.V(3).Printf("creating namespace: %q", namespace)
+		var manifest string = ""
+		if resources.Operator.Spec.NamespaceManifest != "" {
+			clog.V(3).Printf("creating namespace with manifest named: %q", resources.Operator.Spec.NamespaceManifest)
+			manifest = resources.OperatorVersion.Spec.Templates[resources.Operator.Spec.NamespaceManifest]
+		}
+		err := kc.CreateNamespace(namespace, manifest)
+		if err != nil {
+			// failure to create namespace ends installation process
+			return err
+		}
+	}
+
 	// make sure that our instance object is up to date with overrides from commandline
 	applyInstanceOverrides(resources.Instance, instanceName, parameters)
 	// this validation cannot be done earlier because we need to do it after applying things from commandline

diff --git a/pkg/kudoctl/util/kudo/install_test.go b/pkg/kudoctl/util/kudo/install_test.go
@@ -92,7 +92,7 @@ func Test_InstallPackage(t *testing.T) {
 		testResources.OperatorVersion.Spec.Parameters = tt.parameters
 		namespace := "default" //nolint:goconst
 
-		err := InstallPackage(kc, &testResources, tt.skipInstance, "", namespace, tt.installParameters, false, 0)
+		err := InstallPackage(kc, &testResources, tt.skipInstance, "", namespace, tt.installParameters, false, false, 0)
 		if tt.err != "" {
 			assert.ErrorContains(t, err, tt.err)
 		}

diff --git a/pkg/kudoctl/util/kudo/kudo.go b/pkg/kudoctl/util/kudo/kudo.go
@@ -15,6 +15,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/client-go/discovery"
 	"k8s.io/client-go/kubernetes"
+	"sigs.k8s.io/yaml"
 
 	// Import Kubernetes authentication providers to support GKE, etc.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
@@ -394,6 +395,22 @@ func (c *Client) ValidateServerForOperator(operator *v1beta1.Operator) error {
 	return nil
 }
 
+func (c *Client) CreateNamespace(namespace, manifest string) error {
+
+	ns := &v1core.Namespace{}
+	if manifest != "" {
+		if err := yaml.Unmarshal([]byte(manifest), ns); err != nil {
+			return fmt.Errorf("unmarshalling namespace manifest file: %w", err)
+		}
+	}
+	ns.TypeMeta.Kind = "Namespace"
+	ns.Name = namespace
+	ns.Annotations["created-by"] = "kudo-cli"
+
+	_, err := c.kubeClientset.CoreV1().Namespaces().Create(ns)
+	return err
+}
+
 // getKubeVersion returns stringified version of k8s server
 func getKubeVersion(client discovery.ServerVersionInterface) (string, error) {
 	v, err := client.ServerVersion()