feat: Added Freezer helm overrides, kustomize and other files

.github/workflows/helm-freezer.yaml

@@ -0,0 +1,51 @@
+---
+name: Helm GitHub Actions for Freezer
+
+on:
+  pull_request:
+    paths:
+      - base-helm-configs/freezer/**
+      - base-kustomize/freezer/**
+      - .github/workflows/helm-freezer.yaml
+jobs:
+  helm:
+    strategy:
+      matrix:
+        overlays:
+          - base
+          - aio
+    name: Helm
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: azure/setup-helm@v3
+        with:
+          version: latest
+          token: "${{ secrets.GITHUB_TOKEN }}"
+        id: helm
+      - name: Kubectl Install
+        working-directory: /usr/local/bin/
+        run: |
+            if [ ! -f /usr/local/bin/kubectl ]; then
+              curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
+              chmod +x ./kubectl
+            fi
+      - name: Pull OSH repositories
+        run: |
+          helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm
+          helm repo update
+      - name: Run Helm Template
+        run: |
+          ${{ steps.helm.outputs.helm-path }} template freezer openstack-helm/freezer \
+            --namespace=openstack \
+            --wait \
+            --timeout 120m \
+            -f ${{ github.workspace }}/base-helm-configs/freezer/freezer-helm-overrides.yaml \
+            --post-renderer ${{ github.workspace }}/base-kustomize/kustomize.sh \
+            --post-renderer-args freezer/${{ matrix.overlays }} > /tmp/rendered.yaml
+      - name: Return helm Build
+        uses: actions/upload-artifact@v4
+        with:
+          name: helm-freezer-artifact-${{ matrix.overlays }}
+          path: /tmp/rendered.yaml

base-helm-configs/freezer/freezer-helm-overrides.yaml

@@ -0,0 +1,64 @@
+---
+endpoints:
+  backup:
+    hosts:
+      public: freezer-api
+  oslo_db:
+    host_fqdn_override:
+      default: mariadb-cluster-primary.openstack.svc.cluster.local
+    hosts:
+      default: mariadb-cluster-primary
+  oslo_messaging:
+    hosts:
+      default: rabbitmq-nodes
+    host_fqdn_override:
+      default: rabbitmq.openstack.svc.cluster.local
+  oslo_cache:
+    hosts:
+      default: memcached
+    host_fqdn_override:
+      default: memcached.openstack.svc.cluster.local
+  fluentd:
+    namespace: fluentbit
+
+dependencies:
+  static:
+    api:
+      jobs:
+        - freezer-db-sync
+        - freezer-ks-user
+        - freezer-ks-endpoints
+    db_sync:
+      jobs: null
+
+conf:
+  freezer:
+    DEFAULT:
+      host_href: "http://freezer-api.openstack.svc.cluster.local:9090"
+    database:
+      connection_debug: 0
+      connection_recycle_time: 600
+      connection_trace: true
+      idle_timeout: 3600
+      mysql_sql_mode: {}
+      use_db_reconnect: true
+      pool_timeout: 60
+      max_retries: -1
+    keystone_authtoken:
+      service_token_roles: service
+      service_token_roles_required: true
+      auth_type: password
+      auth_version: v3
+      memcache_security_strategy: ENCRYPT
+      service_type: backup
+  logging:
+    logger_root:
+      handlers:
+        - stdout
+      level: INFO
+
+manifests:
+  ingress_api: false
+  job_rabbit_init: false
+  service_ingress_api: false
+  job_db_init: false

base-kustomize/freezer/aio/kustomization.yaml

@@ -0,0 +1,5 @@
+---
+sortOptions:
+  order: fifo
+resources:
+  - ../base

base-kustomize/freezer/base/freezer-mariadb-database.yaml

@@ -0,0 +1,62 @@
+---
+apiVersion: k8s.mariadb.com/v1alpha1
+kind: Database
+metadata:
+  name: freezer
+  namespace: openstack
+  labels:
+    app.kubernetes.io/managed-by: "Helm"
+  annotations:
+    helm.sh/resource-policy: keep
+    meta.helm.sh/release-name: "freezer"
+    meta.helm.sh/release-namespace: "openstack"
+spec:
+  mariaDbRef:
+    name: mariadb-cluster
+  characterSet: utf8
+  collate: utf8_general_ci
+  retryInterval: 5s
+---
+apiVersion: k8s.mariadb.com/v1alpha1
+kind: User
+metadata:
+  name: freezer
+  namespace: openstack
+  labels:
+    app.kubernetes.io/managed-by: "Helm"
+  annotations:
+    helm.sh/resource-policy: keep
+    meta.helm.sh/release-name: "freezer"
+    meta.helm.sh/release-namespace: "openstack"
+spec:
+  mariaDbRef:
+    name: mariadb-cluster
+  passwordSecretKeyRef:
+    name: freezer-db-password
+    key: password
+  maxUserConnections: 0
+  host: "%"
+  retryInterval: 5s
+---
+apiVersion: k8s.mariadb.com/v1alpha1
+kind: Grant
+metadata:
+  name: freezer-grant
+  namespace: openstack
+  labels:
+    app.kubernetes.io/managed-by: "Helm"
+  annotations:
+    helm.sh/resource-policy: keep
+    meta.helm.sh/release-name: "freezer"
+    meta.helm.sh/release-namespace: "openstack"
+spec:
+  mariaDbRef:
+    name: mariadb-cluster
+  privileges:
+    - "ALL"
+  database: "freezer"
+  table: "*"
+  username: freezer
+  grantOption: true
+  host: "%"
+  retryInterval: 5s

base-kustomize/freezer/base/hpa-freezer-api.yaml

@@ -0,0 +1,26 @@
+---
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: freezer-api
+  namespace: openstack
+spec:
+  maxReplicas: 9
+  minReplicas: 2
+  metrics:
+    - resource:
+        name: cpu
+        target:
+          averageUtilization: 80
+          type: Utilization
+      type: Resource
+    - resource:
+        name: memory
+        target:
+          averageUtilization: 80
+          type: Utilization
+      type: Resource
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: freezer-api

base-kustomize/freezer/base/kustomization.yaml

@@ -0,0 +1,7 @@
+---
+sortOptions:
+  order: fifo
+resources:
+  - freezer-mariadb-database.yaml
+  - hpa-freezer-api.yaml
+  - all.yaml

bin/create-secrets.sh

@@ -103,6 +103,10 @@ blazar_rabbitmq_password=$(generate_password 64)
 blazar_db_password=$(generate_password 32)
 blazar_admin_password=$(generate_password 32)
 blazar_keystone_test_password=$(generate_password 32)
+freezer_db_password=$(generate_password 32)
+freezer_admin_password=$(generate_password 32)
+freezer_keystone_test_password=$(generate_password 32)
+freezer_keystone_service_password=$(generate_password 32)
 
 OUTPUT_FILE="/etc/genestack/kubesecrets.yaml"
 
@@ -731,6 +735,42 @@ metadata:
 type: Opaque
 data:
   password: $(echo -n $blazar_keystone_test_password | base64 -w0)
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: freezer-db-password
+  namespace: openstack
+type: Opaque
+data:
+  password: $(echo -n $freezer_db_password | base64 -w0)
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: freezer-admin
+  namespace: openstack
+type: Opaque
+data:
+  password: $(echo -n $freezer_admin_password | base64 -w0)
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: freezer-keystone-test-password
+  namespace: openstack
+type: Opaque
+data:
+  password: $(echo -n $freezer_keystone_test_password | base64 -w0)
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: freezer-keystone-service-password
+  namespace: openstack
+type: Opaque
+data:
+  password: $(echo -n $freezer_keystone_service_password=$ | base64 -w0)
 EOF
 
 rm nova_ssh_key nova_ssh_key.pub

bin/install-freezer.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+GLOBAL_OVERRIDES_DIR="/etc/genestack/helm-configs/global_overrides"
+SERVICE_CONFIG_DIR="/etc/genestack/helm-configs/freezer"
+BASE_OVERRIDES="/opt/genestack/base-helm-configs/freezer/freezer-helm-overrides.yaml"
+
+# Read freezer version from helm-chart-versions.yaml
+VERSION_FILE="/etc/genestack/helm-chart-versions.yaml"
+if [ ! -f "$VERSION_FILE" ]; then
+    echo "Error: helm-chart-versions.yaml not found at $VERSION_FILE"
+    exit 1
+fi
+
+# Extract freezer version using grep and sed
+FREEZER_VERSION=$(grep 'freezer:' "$VERSION_FILE" | sed 's/.*freezer: *//')
+
+if [ -z "$FREEZER_VERSION" ]; then
+    echo "Error: Could not extract freezer version from $VERSION_FILE"
+    exit 1
+fi
+
+HELM_CMD="helm upgrade --install freezer openstack-helm/freezer --version ${FREEZER_VERSION} \
+    --namespace=openstack \
+    --timeout 120m"
+
+HELM_CMD+=" -f ${BASE_OVERRIDES}"
+
+# Append YAML files from the directories
+for dir in "$GLOBAL_OVERRIDES_DIR" "$SERVICE_CONFIG_DIR"; do
+    if compgen -G "${dir}/*.yaml" > /dev/null; then
+        for yaml_file in "${dir}"/*.yaml; do
+            HELM_CMD+=" -f ${yaml_file}"
+        done
+    fi
+done
+
+HELM_CMD+=" --set endpoints.identity.auth.admin.password=\"$(kubectl --namespace openstack get secret keystone-admin -o jsonpath='{.data.password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.identity.auth.freezer.password=\"$(kubectl --namespace openstack get secret freezer-admin -o jsonpath='{.data.password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.identity.auth.service.password=\"$(kubectl --namespace openstack get secret freezer-keystone-service-password -o jsonpath='{.data.password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.identity.auth.test.password=\"$(kubectl --namespace openstack get secret freezer-keystone-test-password -o jsonpath='{.data.password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.oslo_db.auth.admin.password=\"$(kubectl --namespace openstack get secret mariadb -o jsonpath='{.data.root-password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.oslo_db.auth.freezer.password=\"$(kubectl --namespace openstack get secret freezer-db-password -o jsonpath='{.data.password}' | base64 -d)\""
+HELM_CMD+=" --set endpoints.oslo_cache.auth.memcache_secret_key=\"$(kubectl --namespace openstack get secret os-memcached -o jsonpath='{.data.memcache_secret_key}' | base64 -d)\""
+HELM_CMD+=" --set conf.freezer.keystone_authtoken.memcache_secret_key=\"$(kubectl --namespace openstack get secret os-memcached -o jsonpath='{.data.memcache_secret_key}' | base64 -d)\""
+
+
+HELM_CMD+=" --post-renderer /etc/genestack/kustomize/kustomize.sh"
+HELM_CMD+=" --post-renderer-args freezer/overlay"
+
+helm repo add openstack-helm https://tarballs.opendev.org/openstack/openstack-helm
+helm repo update
+
+HELM_CMD+=" $@"
+
+echo "Executing Helm command:"
+echo "${HELM_CMD}"
+eval "${HELM_CMD}"

bin/setup-openstack.sh

@@ -61,6 +61,7 @@ EOF
     prompt_component "ceilometer" "Ceilometer (Telemetry)"
     prompt_component "gnocchi" "Gnocchi (Time Series Database)"
     prompt_component "skyline" "Skyline (Dashboard)"
+    prompt_component "freezer" "Freezer (Backup Restore)"
 fi
 
 # Block on Keystone
@@ -80,6 +81,7 @@ is_component_enabled "octavia" && runTrackErator /opt/genestack/bin/install-octa
 is_component_enabled "masakari" && runTrackErator /opt/genestack/bin/install-masakari.sh
 is_component_enabled "ceilometer" && runTrackErator /opt/genestack/bin/install-ceilometer.sh
 is_component_enabled "gnocchi" && runTrackErator /opt/genestack/bin/install-gnocchi.sh
+is_component_enabled "freezer" && runTrackErator /opt/genestack/bin/install-freezer.sh
 
 waitErator
 

docs/genestack-components.md

@@ -41,6 +41,7 @@ and largely deployed with Helm+Kustomize against the K8s API (v1.28 and up).
 | OpenStack  | Magnum (Helm)         | Optional |
 | OpenStack  | Masakari (Helm)       | Optional |
 | OpenStack  | Blazar (Helm)         | Optional |
+| OpenStack  | Freezer (Helm)        | Optional |
 | OpenStack  | metal3.io             | Planned  |
 | OpenStack  | PostgreSQL (Operator) | Included |
 | OpenStack  | Consul                | Planned  |