Force instantiating component

This PR will force the configuration of this component as an instance.
It also changes the naming of the namespace it depoyes to.

Author: Debakel Orakel

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)

class/defaults.yml

@@ -4,9 +4,8 @@ parameters:
       multi_instance: true
       multi_tenant: true
 
-    name: ${_instance}
     namespace:
-      name: syn-loki
+      name: ${_instance}
       create: true
       metadata: {}
 

component/main.jsonnet

@@ -47,6 +47,8 @@ local prom =
 // The hiera parameters for the component
 local params = inv.parameters.loki;
 
+// Prevent using non-instantiated configuration of this component
+assert inv.parameters._instance != 'loki' : "configuring non-instantiated component isn't allowed";
 
 local secrets = com.generateResources(
   {

docs/modules/ROOT/pages/how-tos/upgrade-loki-v0-v1.adoc

@@ -41,6 +41,39 @@ helm_values:
 
 Remove the parameters from "Step 1" and deploy again.
 
+=== New Namespace Naming
+
+[IMPORTANT]
+====
+This component will change the default name of the namespace to the instance name.
+It is also no longer allowed to configure an non-instantiated version.
+====
+
+If you have configured a namespace name that is different than the instance name, then change the namespace name here:
+
+[source,yaml]
+----
+namespace:
+  name: ${_instance} <1>
+----
+<1> Overwrite the default namespace name.
+
+If you have configured the component in a non-instantiated version, then change the following:
+
+[source,yaml]
+----
+applications:
+  - loki as your-new-instance-name <1>
+
+parameters:
+  your_new_instance_name: <2>
+    namespace:
+      name: ${_instance} <3>
+----
+<1> Redefine the component include in `applications`.
+<2> Rename the component configuration as your new instance name.
+<3> Overwrite the default namespace name.
+
 === (Optional) Consider disabling Zone Aware Replication
 
 [IMPORTANT]

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

@@ -2,14 +2,6 @@
 
 The parent key for all of the following parameters is `loki`.
 
-== `name`
-
-[horizontal]
-type:: string
-default:: `${_instance}`
-
-The name of the instance.
-
 
 == `namespace`
 
@@ -20,7 +12,7 @@ default::
 [source,yaml]
 ----
 namespace:
-  name: syn-loki <1>
+  name: ${_instance} <1>
   create: true <2>
   metadata: {} <3>
 ----

tests/golden/defaults/loki/apps/loki.yaml …den/defaults/defaults/apps/defaults.yamltests/golden/defaults/loki/apps/loki.yaml renamed to tests/golden/defaults/defaults/apps/defaults.yaml tests/golden/defaults/loki/apps/loki.yaml renamed to tests/golden/defaults/defaults/apps/defaults.yaml

@@ -3,5 +3,5 @@ kind: Namespace
 metadata:
   annotations: {}
   labels:
-    name: syn-loki
-  name: syn-loki
+    name: defaults
+  name: defaults

…den/defaults/loki/loki/00_namespace.yaml …ults/defaults/defaults/00_namespace.yamltests/golden/defaults/loki/loki/00_namespace.yaml renamed to tests/golden/defaults/defaults/defaults/00_namespace.yaml tests/golden/defaults/loki/loki/00_namespace.yaml renamed to tests/golden/defaults/defaults/defaults/00_namespace.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+data: {}
+kind: Secret
+metadata:
+  annotations: {}
+  labels:
+    app.kubernetes.io/managed-by: commodore
+    app.kubernetes.io/name: defaults-bucket-secret
+    name: defaults-bucket-secret
+  name: defaults-bucket-secret
+  namespace: defaults
+stringData:
+  S3_ACCESS_KEY_ID: t-silent-test-1234/c-green-test-1234/defaults/s3_access_key
+  S3_SECRET_ACCESS_KEY: t-silent-test-1234/c-green-test-1234/defaults/s3_secret_key
+type: Opaque

tests/golden/defaults/defaults/defaults/01_secrets.yaml

@@ -2,11 +2,11 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    app.kubernetes.io/instance: loki
+    app.kubernetes.io/instance: defaults
     app.kubernetes.io/name: loki
     app.kubernetes.io/version: 3.7.2
     helm.sh/chart: loki-17.4.11
-  name: loki-clusterrole
+  name: defaults-loki-clusterrole
 rules:
   - apiGroups:
       - ''