Initial implementation

Author: DebakelOrakel

.github/workflows/test.yaml

@@ -32,7 +32,6 @@ jobs:
     strategy:
       matrix:
         instance:
-          - defaults
           - team1
           - team2
     defaults:
@@ -49,7 +48,6 @@ jobs:
     strategy:
       matrix:
         instance:
-          - defaults
           - team1
           - team2
     defaults:

Makefile

@@ -6,6 +6,7 @@ SHELL := bash
 .SUFFIXES:
 
 include Makefile.vars.mk
+include Makefile.custom.mk
 
 .PHONY: help
 help: ## Show this help

Makefile.custom.mk

@@ -0,0 +1,2 @@
+# Configure instance alias for commodore component compile
+commodore_args += --alias $(instance)

Makefile.vars.mk

@@ -49,5 +49,5 @@ KUBENT_ARGS     ?= -c=false --helm3=false -e
 KUBENT_IMAGE    ?= ghcr.io/doitintl/kube-no-trouble:latest
 KUBENT_DOCKER   ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) --entrypoint=/app/kubent $(KUBENT_IMAGE)
 
-instance ?= defaults
-test_instances = tests/defaults.yml tests/team1.yml tests/team2.yml
+instance ?= team1
+test_instances = tests/team1.yml tests/team2.yml

class/defaults.yml

@@ -1,5 +1,7 @@
 parameters:
   namespaces:
     =_metadata:
+      multi_instance: true
       multi_tenant: true
-    namespace: syn-namespaces
+
+    namespaces: {}

class/namespaces.yml

@@ -8,4 +8,4 @@ parameters:
       - input_paths:
           - ${_base_directory}/component/main.jsonnet
         input_type: jsonnet
-        output_path: namespaces/
+        output_path: ${_instance}/

component/app.jsonnet

@@ -3,7 +3,15 @@ local inv = kap.inventory();
 local params = inv.parameters.namespaces;
 local argocd = import 'lib/argocd.libjsonnet';
 
-local app = argocd.App('namespaces', params.namespace);
+local app = argocd.App('namespaces', params.namespace) {
+  spec+: {
+    syncPolicy+: {
+      syncOptions+: [
+        'ServerSideApply=true',
+      ],
+    },
+  },
+};
 
 local appPath =
   local project = std.get(std.get(app, 'spec', {}), 'project', 'syn');

component/main.jsonnet

@@ -1,10 +1,38 @@
 // main template for namespaces
+local com = import 'lib/commodore.libjsonnet';
 local kap = import 'lib/kapitan.libjsonnet';
 local kube = import 'lib/kube.libjsonnet';
 local inv = kap.inventory();
+
 // The hiera parameters for the component
 local params = inv.parameters.namespaces;
+local instanceName = inv.parameters._instance;
+
+// Prevent creating a namespace that is not instantiated
+assert instanceName != 'namespace' : 'component must be instantiated with a name';
+
+local namespace(name) = {
+  // Prevent creating a namespace that is a reserved Kubernetes namespace
+  assert !std.startsWith(name, 'kube') : 'namespace name must not start with "kube"',
+  assert !std.startsWith(name, 'openshift') : 'namespace name must not start with "openshift"',
+  // Prevent creating a namespace that is a reserved Syn namespace
+  assert !std.startsWith(name, 'syn') : 'namespace name must not start with "syn"',
+
+  apiVersion: 'v1',
+  kind: 'Namespace',
+  metadata: {
+    annotations: {
+      'argocd.argoproj.io/sync-options': 'Delete=false',
+    } + com.makeMergeable(std.get(params.namespaces[name], 'annotations', {})),
+    labels: {
+      name: name,
+    } + com.makeMergeable(std.get(params.namespaces[name], 'labels', {})),
+    name: name,
+  },
+};
 
 // Define outputs below
 {
+  [name]: namespace(name)
+  for name in std.objectFields(params.namespaces)
 }

docs/modules/ROOT/pages/index.adoc

@@ -2,4 +2,9 @@
 
 namespaces is a Commodore component to manage Managed Namespaces.
 
+[TIP]
+====
+Please ensure that you instantiate the component with a name and that you configure ownership of the instance if you are not the cluster owner.
+====
+
 See the xref:references/parameters.adoc[parameters] reference for further details.

docs/modules/ROOT/pages/references/parameters.adoc

@@ -2,18 +2,38 @@
 
 The parent key for all of the following parameters is `namespaces`.
 
-== `namespace`
+== `namespaces`
 
 [horizontal]
-type:: string
-default:: `syn-namespaces`
+type:: object
+default:: {}
 
-The namespace in which to deploy this component.
+Contains a list of namespaces to create.
 
 
 == Example
 
 [source,yaml]
 ----
-namespace: example-namespace
+applications:
+  - namespaces as namespaces-team1 <1>
+
+parameters:
+  syn:
+    teams:
+      team1:
+        instances:
+          - namespaces-team1 <2>
+
+  namespaces_team1:
+    namespaces:
+      plain-namespace: {}
+      with-annotations:
+        annotations:
+          team: team1
+      with-labels:
+        labels:
+          team: team1
 ----
+<1> Make sure you include the component as an instance.
+<2> Make sure you configure ownership of the instance if you are not the cluster owner.