Merge pull request #537 from sathlan/old_versions

Add OpenStack OLM subscription configurations

Ability to install a specific version of the operator(s) when multiple
versions are available in the OLM catalog.
Added new kustomization files and YAML configurations for OpenStack
operator subscriptions using OLM. This includes catalog sources,
namespaces, and operator groups for openstack-operators, as well as
subscription definitions for the OpenStack components when the version
is below v1.0.7.
Kustomization facilitates version-specific configurations starting
with v1.0.3 and v1.0.6, incorporating modifications like the
elimination of the AnsibleEE operator in subsequent versions. From
version 1.0.7 onwards, only the OpenStack operator is retained.
For each overlay we define the same set of ConfigMap that reach a set
of relevant parameter in the subscriptions and catalog source
definitions.
An unexpected mechanism here is that we override the
common/olm-subscriptions/kustomization.yaml file from ci-framework
for version v1.0.3 and v1.0.6.  This enables the dynamic selection
of the right overlay.  For version v1.0.7 and beyond we used the
default overlay and we don't need to overwrite the kustomization
file.
The problems that we cannot solve with just parameters are:

v1.0.3 and v1.0.6 have a different set of subscriptions to
include
startingCSV parameter is "dynamic" as it's composed of the
spec.name.version, not just version. Thus we cannot encode in a
kustomize parameter without create our own transformer. As
transformwer are not deployed here, it would be too much work to
boostrap it.

All this disapear starting with v1.0.7 where we have only one
subscription to set.
Resolves-Part-Of: OSPRH-15056

Reviewed-by: Andrew Bays <[email protected]>
Reviewed-by: sathlan <[email protected]>
Reviewed-by: John Fulton <[email protected]>

Author: softwarefactory-project-zuul[bot]

examples/common/olm-subscriptions/README.md

@@ -0,0 +1,13 @@
+# OLM subscription that are used for deploying specific versions.
+
+To deploy a specific version rather than the latest from OLM images
+containing multiple version definitions, it is necessary to explicitly
+set the `startingCSV` parameter.
+
+This kustomization setup accomplishes this for:
+- v1.0.3
+- v1.0.6: this version no longer includes the AnsibleEE operator
+- v1.0.7 and later: these versions only include the OpenStack operator
+
+Refer to the `ci_gen_kustomize_values` role README for configuration
+details.

examples/common/olm-subscriptions/kustomization.yaml

@@ -0,0 +1,6 @@
+---
+components:
+  - ../../../lib/olm-deps
+  - ../../../lib/olm-openstack-subscriptions/overlays/default
+resources:
+  - values.yaml

examples/common/olm-subscriptions/values.yaml

@@ -0,0 +1,17 @@
+# local-config: referenced, but not emitted by kustomize
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+    name: olm-values
+    annotations:
+        config.kubernetes.io/local-config: 'true'
+data:
+    openstack-operator-channel: "alpha"
+    openstack-operator-image: "quay.io/openstack-k8s-operators/openstack-operator-index:latest"
+    openstack-operator-display-name: "CI Test"
+    openstack-operator-installplanapproval: "Automatic"
+    openstack-operator-publisher: "Testing Team"
+    openstack-operator-catalog-source: "openstack-operator-index"
+    openstack-operator-subscription-namespace: "openstack-operators"
+    openstack-operator-version: "latest"

lib/olm-openstack-subscriptions/base/catalogsource.yaml

@@ -0,0 +1,13 @@
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: CatalogSource
+metadata:
+  name: openstack-operator-index
+  namespace: openshift-marketplace
+  labels:
+    category: openstack-catalog
+spec:
+  image: quay.io/openstack-k8s-operators/openstack-operator-index:latest
+  sourceType: grpc
+  displayName: CI Test
+  publisher: Test Team

lib/olm-openstack-subscriptions/base/kustomization.yaml

@@ -0,0 +1,7 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - catalogsource.yaml
+  - namespaces.yaml
+  - operatorgroup.yaml

lib/olm-openstack-subscriptions/base/namespaces.yaml

@@ -0,0 +1,16 @@
+---
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: openstack-operators
+  labels:
+    pod-security.kubernetes.io/enforce: privileged
+    security.openshift.io/scc.podSecurityLabelSync: "false"
+---
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: openstack
+  labels:
+    pod-security.kubernetes.io/enforce: privileged
+    security.openshift.io/scc.podSecurityLabelSync: "false"

lib/olm-openstack-subscriptions/base/operatorgroup.yaml

@@ -0,0 +1,6 @@
+---
+apiVersion: operators.coreos.com/v1
+kind: OperatorGroup
+metadata:
+  name: openstack
+  namespace: openstack-operators

lib/olm-openstack-subscriptions/overlays/default/kustomization.yaml

@@ -0,0 +1,101 @@
+---
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
+
+resources:
+  - ../../base
+  - openstack-subscription.yaml
+
+replacements:
+  # CatalogSource
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-image
+    targets:
+      - select:
+          kind: CatalogSource
+          labelSelector: category=openstack-catalog
+        fieldPaths:
+          - spec.image
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-publisher
+    targets:
+      - select:
+          kind: CatalagSource
+          labelSelector: category=openstack-catalog
+        fieldPaths:
+          - spec.publisher
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-display-name
+    targets:
+      - select:
+          kind: CatalogSource
+          labelSelector: category=openstack-catalog
+        fieldPaths:
+          - spec.displayName
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-catalog-source
+    targets:
+      - select:
+          kind: CatalogSource
+          labelSelector: category=openstack-catalog
+        fieldPaths:
+          - metadata.name
+  # Subscriptions
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-channel
+    targets:
+      - select:
+          kind: Subscription
+          labelSelector: category=openstack-subscription
+        fieldPaths:
+          - spec.channel
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-installplanapproval
+    targets:
+      - select:
+          kind: Subscription
+          labelSelector: category=openstack-subscription
+        fieldPaths:
+          - spec.installPlanApproval
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-subscription-namespace
+    targets:
+      - select:
+          kind: Subscription
+          labelSelector: category=openstack-subscription
+        fieldPaths:
+          - metadata.namespace
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-catalog-source
+    targets:
+      - select:
+          kind: Subscription
+          labelSelector: category=openstack-subscription
+        fieldPaths:
+          - spec.source
+  - source:
+      kind: ConfigMap
+      name: olm-values
+      fieldPath: data.openstack-operator-version
+    targets:
+      - select:
+          kind: Subscription
+          labelSelector: category=openstack-subscription
+        fieldPaths:
+          - spec.startingCSV

lib/olm-openstack-subscriptions/overlays/default/openstack-subscription.yaml

@@ -0,0 +1,15 @@
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+  name: openstack
+  namespace: openstack-operators
+  labels:
+    category: openstack-subscription
+spec:
+  channel: alpha
+  installPlanApproval: Automatic
+  name: openstack-operator
+  source: openstack-operator-index
+  sourceNamespace: openshift-marketplace
+  startingCSV: openstack-operator.latest

lib/olm-openstack-subscriptions/overlays/v1.0.3/barbican-subscription.yaml

@@ -0,0 +1,15 @@
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+  name: barbican
+  namespace: openstack-operators
+  labels:
+    category: openstack-subscription
+spec:
+  channel: alpha
+  installPlanApproval: Automatic
+  name: barbican-operator
+  source: openstack-operator-index
+  sourceNamespace: openshift-marketplace
+  startingCSV: barbican-operator.v1.0.3