Merge pull request #817 from Roming22/tssc/config-settings

feat: add a 'settings' section to 'config.yaml'

Author: openshift-merge-bot[bot]

README.md

@@ -61,16 +61,29 @@ The [`config.yaml`](installer/config.yaml) file is structured to outline key com
 ---
 tssc:
   namespace: tssc
+  settings: {}
   products: {}
   dependencies: {}
 ```
 
 The attributes of the `tssc` object are as follows:
 
 - `.namespace`: Specifies the default namespace used by the installer, set to `tssc`. This namespace acts as the primary operational area for the installation process.
+- `.settings`: Defines the settings of the deployment. This can control a wide set of properties.
 - `.products`: Defines the features to be deployed by the installer. Each feature is identified by a unique name and a set of properties.
 - `.dependencies`: Specifies the dependencies rolled out by the installer in the specific order defined in the configuration file.
 
+## `tssc.settings`
+
+Defines the settings of the deployment. This can control a wide set of properties. For example the following snippet flags the deployment as a CRC deployment, so that the configuration can be tuned to that particular usecase.
+
+```yaml
+---
+tssc:
+  settings:
+    crc: true
+```
+
 ## `tssc.products`
 
 Defines the products the installer will deploy. Each product is defined by a unique name and a set of properties. For instance, the following snippet defines a `productName` block:
@@ -118,6 +131,12 @@ Windows users must be aware that the hook scripts are written in Bash and may no
 
 The following functions are available for use in the [`values.yaml.tpl`](./installer/charts/values.yaml.tpl) file:
 
+### `{{ .Installer.Settings.* }}`
+
+A dictionary of key-value pairs for the installer's settings.
+
+This is currently mainly a placeholder for future configuration settings that would impact more than a single product.
+
 ### `{{ .Installer.Products.* }}`
 
 - `{{ .Installer.Products.*.Enabled }}`: Returns the boolean value of the product's `enabled` field.

installer/charts/values.yaml.tpl

@@ -1,4 +1,4 @@
-{{- $crc := required "CRC settings" .Installer.Products.crc -}}
+{{- $crc := required "CRC settings" .Installer.Settings.crc -}}
 {{- $tas := required "TAS settings" .Installer.Products.trustedArtifactSigner -}}
 {{- $tpa := required "TPA settings" .Installer.Products.trustedProfileAnalyzer -}}
 {{- $keycloak := required "Keycloak settings" .Installer.Products.keycloak -}}
@@ -14,7 +14,7 @@
 {{- $odfNamespace := "openshift-storage" -}}
 ---
 debug:
-  ci: false
+  ci: {{ dig "ci" "debug" false .Installer.Settings -}}
 
 #
 # tssc-openshift
@@ -141,10 +141,10 @@ backingServices:
     route:
       host: {{ $keycloakRouteHost }}
       tls:
-        enabled: {{ not $crc.Enabled }}
+        enabled: {{ not $crc }}
         secretName: {{ $keycloakRouteTLSSecretName }}
         termination: reencrypt
-{{- if $crc.Enabled }}
+{{- if $crc }}
       annotations:
         route.openshift.io/termination: reencrypt
 {{- end }}
@@ -280,7 +280,7 @@ developerHub:
 {{- $tpaOIDCClientsSecretName := "tpa-realm-chicken-clients" }}
 {{- $tpaTestingUsersEnabled := false }}
 {{- $protocol := "https" -}}
-{{- if $crc.Enabled }}
+{{- if $crc }}
   {{- $protocol = "http" }}
 {{- end }}
 {{- $tpaRealmPath := "realms/chicken" }}
@@ -334,7 +334,7 @@ redhat-trusted-profile-analyzer:
   openshift: &tpaOpenShift
     # In practice it toggles "https" vs. "http" for TPA components, for CRC it's
     # easier to focus on "http" communication only.
-    useServiceCa: {{ not $crc.Enabled }}
+    useServiceCa: {{ not $crc }}
   database: &tpaDatabase
     name:
       valueFrom:
@@ -397,7 +397,7 @@ trustification:
   oidc: *tpaOIDC
   ingress: *tpaIngress
   tls:
-    serviceEnabled: "{{ not $crc.Enabled }}"
+    serviceEnabled: "{{ not $crc }}"
 
 #
 # tssc-tas
@@ -419,7 +419,7 @@ trustedArtifactSigner:
     fulcio:
       oidc:
         clientID: trusted-artifact-signer
-{{- if $crc.Enabled }}
+{{- if $crc }}
         issuerURL: {{ printf "http://%s/%s" $keycloakRouteHost $tasRealmPath }}
 {{- else }}
         issuerURL: {{ printf "https://%s/%s" $keycloakRouteHost $tasRealmPath }}

installer/config.yaml

@@ -1,9 +1,9 @@
 ---
 tssc:
   namespace: &installerNamespace tssc
+  settings:
+    crc: false
   products:
-    crc:
-      enabled: false
     trustedProfileAnalyzer:
       enabled: &tpaEnabled true
       namespace: &trustedProfileAnalyzerNamespace tssc-tpa

pkg/config/config.go

@@ -16,6 +16,8 @@ type Spec struct {
 	// deployed. Note, Helm charts deployed by the installer are likely to use a
 	// different namespace.
 	Namespace string `yaml:"namespace"`
+	// Settings contains the configuration for the installer settings.
+	Settings map[string]interface{} `yaml:"settings"`
 	// Products contains the configuration for the installer products.
 	Products map[string]ProductSpec `yaml:"products"`
 	// Dependencies contains the installer Helm chart dependencies.

pkg/engine/engine_test.go

@@ -16,6 +16,8 @@ const testYamlTmpl = `
 ---
 root:
   namespace: {{ .Installer.Namespace }} 
+  settings:
+    key: value
   products:
 {{- range $k, $v := .Installer.Products }}
   {{- $k | nindent 4 }}:
@@ -62,6 +64,9 @@ func TestEngine_Render(t *testing.T) {
 	g.Expect(root).To(o.HaveKey("namespace"))
 	g.Expect(root["namespace"]).To(o.Equal(cfg.Installer.Namespace))
 
+	g.Expect(root).To(o.HaveKey("settings"))
+	g.Expect(root["settings"]).NotTo(o.BeNil())
+
 	g.Expect(root).To(o.HaveKey("products"))
 	g.Expect(root["products"]).NotTo(o.BeNil())