Refactor operator logic

README.md

@@ -62,7 +62,7 @@ Output:
 
 ## License
 
-Copyright 2023 Red Hat Inc..
+Copyright 2023 Red Hat Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

api/v1alpha1/backstage_types.go

@@ -16,21 +16,19 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/pointer"
 )
 
-// Constants for status conditions
-const (
-	// TODO: RuntimeConditionRunning string = "RuntimeRunning"
-	ConditionDeployed string = "Deployed"
-	DeployOK          string = "DeployOK"
-	DeployFailed      string = "DeployFailed"
-	DeployInProgress  string = "DeployInProgress"
-)
+type BackstageConditionReason string
+
+type BackstageConditionType string
 
-// Constants for image placeholders
 const (
-	EnvPostGresImage  string = "RELATED_IMAGE_postgresql"
-	EnvBackstageImage string = "RELATED_IMAGE_backstage"
+	BackstageConditionTypeDeployed BackstageConditionType = "Deployed"
+
+	BackstageConditionReasonDeployed   BackstageConditionReason = "Deployed"
+	BackstageConditionReasonFailed     BackstageConditionReason = "DeployFailed"
+	BackstageConditionReasonInProgress BackstageConditionReason = "DeployInProgress"
 )
 
 // BackstageSpec defines the desired state of Backstage
@@ -39,10 +37,10 @@ type BackstageSpec struct {
 	Application *Application `json:"application,omitempty"`
 
 	// Raw Runtime Objects configuration. For Advanced scenarios.
-	RawRuntimeConfig RuntimeConfig `json:"rawRuntimeConfig,omitempty"`
+	RawRuntimeConfig string `json:"rawRuntimeConfig,omitempty"`
 
 	// Configuration for database access. Optional.
-	Database Database `json:"database,omitempty"`
+	Database *Database `json:"database,omitempty"`
 }
 
 type Database struct {
@@ -51,8 +49,8 @@ type Database struct {
 	//+kubebuilder:default=true
 	EnableLocalDb *bool `json:"enableLocalDb,omitempty"`
 
-	// Name of the secret for database authentication. Optional.
-	// For a local database deployment (EnableLocalDb=true), a secret will be auto generated if it does not exist.
+	// Name of the secret for database authentication. Required for external database access.
+	// Optional for a local database (EnableLocalDb=true) and if absent a secret will be auto generated.
 	// The secret shall include information used for the database access.
 	// An example for PostgreSQL DB access:
 	// "POSTGRES_PASSWORD": "rl4s3Fh4ng3M4"
@@ -103,7 +101,7 @@ type Application struct {
 
 	// Image Pull Secrets to use in all containers (including Init Containers)
 	// +optional
-	ImagePullSecrets *[]string `json:"imagePullSecrets,omitempty"`
+	ImagePullSecrets []string `json:"imagePullSecrets,omitempty"`
 
 	// Route configuration. Used for OpenShift only.
 	Route *Route `json:"route,omitempty"`
@@ -183,13 +181,6 @@ type Env struct {
 	Value string `json:"value"`
 }
 
-type RuntimeConfig struct {
-	// Name of ConfigMap containing Backstage runtime objects configuration
-	BackstageConfigName string `json:"backstageConfig,omitempty"`
-	// Name of ConfigMap containing LocalDb (P|ostgreSQL) runtime objects configuration
-	LocalDbConfigName string `json:"localDbConfig,omitempty"`
-}
-
 // BackstageStatus defines the observed state of Backstage
 type BackstageStatus struct {
 	// Conditions is the list of conditions describing the state of the runtime
@@ -274,3 +265,29 @@ type TLS struct {
 func init() {
 	SchemeBuilder.Register(&Backstage{}, &BackstageList{})
 }
+
+func (s BackstageSpec) IsLocalDbEnabled() bool {
+	if s.Database == nil {
+		return true
+	}
+	return pointer.BoolDeref(s.Database.EnableLocalDb, true)
+}
+
+func (s BackstageSpec) IsRouteEnabled() bool {
+	if s.Application == nil || s.Application.Route == nil {
+		return false
+	}
+	return pointer.BoolDeref(s.Application.Route.Enabled, true)
+}
+
+func (s BackstageSpec) IsRouteEmpty() bool {
+	route := s.Application.Route
+	if route.Host != "" && route.Subdomain != "" && route.TLS != nil && *route.TLS != (TLS{}) {
+		return true
+	}
+	return false
+}
+
+func (s BackstageSpec) IsAuthSecretSpecified() bool {
+	return s.Database != nil && s.Database.AuthSecretName != ""
+}

bundle/manifests/backstage-default-config_v1_configmap.yaml

@@ -1,28 +1,34 @@
 apiVersion: v1
 data:
-  backend-auth-configmap.yaml: |
+  app-config.yaml: |-
     apiVersion: v1
     kind: ConfigMap
     metadata:
-      name: # placeholder for '<cr-name>-backend-auth'
+      name: my-backstage-config-cm1 # placeholder for <bs>-default-appconfig
     data:
-      "app-config.backend-auth.default.yaml": |
+      default.app-config.yaml: |
         backend:
+          database:
+            connection:
+              password: ${POSTGRES_PASSWORD}
+              user: ${POSTGRES_USER}
           auth:
             keys:
               # This is a default value, which you should change by providing your own app-config
               - secret: "pl4s3Ch4ng3M3"
-  db-secret.yaml: |
+  db-secret.yaml: |-
     apiVersion: v1
     kind: Secret
     metadata:
-      name: # placeholder for 'backstage-psql-secret-<cr-name>'
+      name: postgres-secrets # will be replaced
+      namespace: backstage
+    type: Opaque
     stringData:
-      "POSTGRES_PASSWORD": "rl4s3Fh4ng3M4" # default value, change to your own value
-      "POSTGRES_PORT": "5432"
-      "POSTGRES_USER": "postgres"
-      "POSTGRESQL_ADMIN_PASSWORD": "rl4s3Fh4ng3M4" # default value, change to your own value
-      "POSTGRES_HOST": "" # set to your Postgres DB host. If the local DB is deployed, set to 'backstage-psql-<cr-name>'
+      POSTGRES_PASSWORD: #wrgd5688 #admin123 # leave it empty to make it autogenerated
+      POSTGRES_PORT: "5432"
+      POSTGRES_USER: postgres
+      POSTGRESQL_ADMIN_PASSWORD: admin123
+      POSTGRES_HOST: bs1-db-service    #placeholder <crname>-db-service
   db-service-hl.yaml: |
     apiVersion: v1
     kind: Service
@@ -44,7 +50,7 @@ data:
         janus-idp.io/app:  backstage-psql-cr1 # placeholder for 'backstage-psql-<cr-name>'
       ports:
         - port: 5432
-  db-statefulset.yaml: |
+  db-statefulset.yaml: |-
     apiVersion: apps/v1
     kind: StatefulSet
     metadata:
@@ -74,8 +80,9 @@ data:
                 - name: PGDATA
                   value: /var/lib/pgsql/data/userdata
               envFrom:
-                - secretRef:
-                    name: <POSTGRESQL_SECRET>  # will be replaced with 'backstage-psql-secrets-<cr-name>'
+    #            - secretRef:
+    #                name: <POSTGRESQL_SECRET>  # will be replaced with 'backstage-psql-secrets-<cr-name>'
+    #          image: quay.io/fedora/postgresql-15:latest
               image: <RELATED_IMAGE_postgresql> # will be replaced with the actual image
               imagePullPolicy: IfNotPresent
               securityContext:
@@ -180,6 +187,13 @@ data:
                 defaultMode: 420
                 optional: true
                 secretName: dynamic-plugins-npmrc
+            - name: dynamic-plugins-conf
+              configMap:
+                name: default-dynamic-plugins
+                optional: true
+                items:
+                  - key: dynamic-plugins.yaml
+                    path: dynamic-plugins.yaml
 
           initContainers:
             - command:
@@ -198,6 +212,10 @@ data:
                   name: dynamic-plugins-npmrc
                   readOnly: true
                   subPath: .npmrc
+                - mountPath: /opt/app-root/src/dynamic-plugins.yaml
+                  subPath: dynamic-plugins.yaml
+                  name: dynamic-plugins-conf
+                  readOnly: true
               workingDir: /opt/app-root/src
 
           containers:
@@ -233,19 +251,14 @@ data:
               env:
                 - name: APP_CONFIG_backend_listen_port
                   value: "7007"
-              envFrom:
-                - secretRef:
-                    name: <POSTGRESQL_SECRET>  # will be replaced with 'backstage-psql-secrets-<cr-name>'
-              #            - secretRef:
-              #                name: backstage-secrets
               volumeMounts:
                 - mountPath: /opt/app-root/src/dynamic-plugins-root
                   name: dynamic-plugins-root
-  dynamic-plugins-configmap.yaml: |-
+  dynamic-plugins.yaml: |-
     apiVersion: v1
     kind: ConfigMap
     metadata:
-      name: # placeholder for '<cr-name>-dynamic-plugins'
+      name: default-dynamic-plugins #  must be the same as (deployment.yaml).spec.template.spec.volumes.name.dynamic-plugins-conf.configMap.name
     data:
       "dynamic-plugins.yaml": |
         includes:
@@ -266,6 +279,15 @@ data:
       to:
         kind: Service
         name:  # placeholder for 'backstage-<cr-name>'
+  secret-envs.yaml: |
+    apiVersion: v1
+    kind: Secret
+    metadata:
+      name: backend-auth-secret
+    stringData:
+      # generated with the command below (from https://janus-idp.io/docs/auth/service-to-service-auth/#setup):
+      # node -p 'require("crypto").randomBytes(24).toString("base64")'
+      BACKEND_SECRET: "R2FxRVNrcmwzYzhhN3l0V1VRcnQ3L1pLT09WaVhDNUEK" # notsecret
   service.yaml: |-
     apiVersion: v1
     kind: Service

bundle/manifests/janus-idp.io_backstages.yaml

@@ -283,16 +283,7 @@ spec:
                 type: object
               rawRuntimeConfig:
                 description: Raw Runtime Objects configuration. For Advanced scenarios.
-                properties:
-                  backstageConfig:
-                    description: Name of ConfigMap containing Backstage runtime objects
-                      configuration
-                    type: string
-                  localDbConfig:
-                    description: Name of ConfigMap containing LocalDb (P|ostgreSQL)
-                      runtime objects configuration
-                    type: string
-                type: object
+                type: string
             type: object
           status:
             description: BackstageStatus defines the observed state of Backstage

config/crd/bases/janus-idp.io_backstages.yaml

@@ -268,13 +268,14 @@ spec:
                 properties:
                   authSecretName:
                     description: 'Name of the secret for database authentication.
-                      Optional. For a local database deployment (EnableLocalDb=true),
-                      a secret will be auto generated if it does not exist. The secret
-                      shall include information used for the database access. An example
-                      for PostgreSQL DB access: "POSTGRES_PASSWORD": "rl4s3Fh4ng3M4"
-                      "POSTGRES_PORT": "5432" "POSTGRES_USER": "postgres" "POSTGRESQL_ADMIN_PASSWORD":
-                      "rl4s3Fh4ng3M4" "POSTGRES_HOST": "backstage-psql-bs1"  # For
-                      local database, set to "backstage-psql-<CR name>".'
+                      Required for external database access. Optional for a local
+                      database (EnableLocalDb=true) and if absent a secret will be
+                      auto generated. The secret shall include information used for
+                      the database access. An example for PostgreSQL DB access: "POSTGRES_PASSWORD":
+                      "rl4s3Fh4ng3M4" "POSTGRES_PORT": "5432" "POSTGRES_USER": "postgres"
+                      "POSTGRESQL_ADMIN_PASSWORD": "rl4s3Fh4ng3M4" "POSTGRES_HOST":
+                      "backstage-psql-bs1"  # For local database, set to "backstage-psql-<CR
+                      name>".'
                     type: string
                   enableLocalDb:
                     default: true
@@ -284,16 +285,7 @@ spec:
                 type: object
               rawRuntimeConfig:
                 description: Raw Runtime Objects configuration. For Advanced scenarios.
-                properties:
-                  backstageConfig:
-                    description: Name of ConfigMap containing Backstage runtime objects
-                      configuration
-                    type: string
-                  localDbConfig:
-                    description: Name of ConfigMap containing LocalDb (P|ostgreSQL)
-                      runtime objects configuration
-                    type: string
-                type: object
+                type: string
             type: object
           status:
             description: BackstageStatus defines the observed state of Backstage

config/manager/default-config/app-config.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: my-backstage-config-cm1 # placeholder for <bs>-default-appconfig
+data:
+  default.app-config.yaml: |
+    backend:
+      database:
+        connection:
+          password: ${POSTGRES_PASSWORD}
+          user: ${POSTGRES_USER}
+      auth:
+        keys:
+          # This is a default value, which you should change by providing your own app-config
+          - secret: "pl4s3Ch4ng3M3"

config/manager/default-config/configmap-envs.yaml.sample

@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: my-env-cm-1
+data:
+  CM_ENV1: "cm env 1"
+  CM_ENV2: "cm env 2"