Merge pull request #66 from appuio/ocp-4.14

Support for OpenShift 4.14

Author: simu

.cruft.json

@@ -1,13 +1,13 @@
 {
   "template": "https://github.com/projectsyn/commodore-component-template.git",
-  "commit": "a4aff6a9d004c1aad085a875c7759c8f8f1e0d3d",
+  "commit": "e0fcaa457a78109244747e0879a87e0adaabbd10",
   "checkout": "main",
   "context": {
     "cookiecutter": {
       "name": "OpenShift4 Console",
       "slug": "openshift4-console",
       "parameter_key": "openshift4_console",
-      "test_cases": "defaults custom-plugins custom-route custom-route-legacy custom-route-managed-tls custom-links custom-logo",
+      "test_cases": "defaults custom-plugins custom-route custom-route-legacy custom-route-managed-tls custom-links custom-logo ocp-4.14",
       "add_lib": "n",
       "add_pp": "n",
       "add_golden": "y",

.github/workflows/test.yaml

@@ -39,6 +39,7 @@ jobs:
           - custom-route-managed-tls
           - custom-links
           - custom-logo
+          - ocp-4.14
     defaults:
       run:
         working-directory: ${{ env.COMPONENT_NAME }}
@@ -60,6 +61,7 @@ jobs:
           - custom-route-managed-tls
           - custom-links
           - custom-logo
+          - ocp-4.14
     defaults:
       run:
         working-directory: ${{ env.COMPONENT_NAME }}

Makefile.vars.mk

@@ -57,4 +57,4 @@ KUBENT_IMAGE    ?= ghcr.io/doitintl/kube-no-trouble:latest
 KUBENT_DOCKER   ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) --entrypoint=/app/kubent $(KUBENT_IMAGE)
 
 instance ?= defaults
-test_instances = tests/defaults.yml test/custom-plugins.yml tests/custom-route.yml tests/custom-route-legacy.yml tests/custom-route-managed-tls.yml tests/custom-links.yml tests/custom-logo.yml
+test_instances = tests/defaults.yml tests/custom-plugins.yml tests/custom-route.yml tests/custom-route-legacy.yml tests/custom-route-managed-tls.yml tests/custom-links.yml tests/custom-logo.yml tests/ocp-4.14.yml

class/defaults.yml

@@ -2,7 +2,10 @@ parameters:
   openshift4_console:
     namespace: openshift-console
     namespace_annotations:
-      openshift.io/node-selector: node-role.kubernetes.io/master=
+      openshift.io/node-selector: ''
+    openshift_version:
+      Major: '4'
+      Minor: '13'
     route:
       console: {}
       downloads: {}

component/main.jsonnet

@@ -44,14 +44,34 @@ local tlsSecret =
   else
     null;
 
+local consolePlugins =
+  // set default plugins dynamically based on OCP minor version and append
+  // user-configured plugins to the default.
+  local defaults =
+    if std.parseInt(params.openshift_version.Minor) > 13 then
+      [ 'monitoring-plugin' ]
+    else
+      [];
+  // render final plugins list by appending any user-provided plugins that
+  // aren't part of the default plugins to the list of plugins. We use
+  // `std.set()` on the user-provided plugins so that users don't have to
+  // worry about including the same plugin multiple times. Note that this may
+  // reorder plugins between the input and the resulting manifest.
+  defaults + [
+    p
+    for p in std.set(std.get(params.config, 'plugins', []))
+    if !std.member(defaults, p)
+  ];
+
 local consoleSpec =
-  // Remove provided route config from console `.spec`
+  // Remove provided route config from console `.spec`, and skip field
+  // `plugins` since we manage it dynamically.
   {
     [k]: params.config[k]
     for k in std.objectFields(params.config)
-    if k != 'route'
+    if !std.member([ 'route', 'plugins' ], k)
   } + {
-    plugins+: [],
+    plugins: consolePlugins,
   } +
   (
     if logoFileName != '' then

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

@@ -21,12 +21,27 @@ default::
 +
 [source,yaml]
 ----
-openshift.io/node-selector: node-role.kubernetes.io/master=
+openshift.io/node-selector: ''
 ----
 
 Annotations to add to the managed namespace.
 Annotations can be removed by setting the value to `null`.
 
+== `openshift_version`
+
+type:: dictionary
+default::
++
+[source,yaml]
+----
+Major: '4'
+Minor: '13'
+----
+
+The OpenShift major and minor version.
+
+TIP: This parameter is intended to be populated from the `openshiftVersion` dynamic fact and replicates the fact's structure.
+
 == `route`
 
 [horizontal]
@@ -60,10 +75,16 @@ Indicates whether and how the operator should manage the console.
 
 [horizontal]
 type:: list
-default:: `[]`
+default:: dynamic, depending on the reported OpenShift version
 
 Add plugins to the console.
 
+The component will inject a dynamic set of plugins into the configuration based on the reported OpenShift version in parameter `openshift_version`.
+For OpenShift 4.14 and newer, the component always adds plugin `monitoring-plugin`.
+Additionally, the component will remove duplicated entries from the list of configured plugins.
+
+NOTE: The order of entries in the field isn't guaranteed to be stable.
+
 === `config.route`
 
 [horizontal]
@@ -77,7 +98,7 @@ If the route is part of the default apps domain, no TLS cert needs to be specifi
 ====
 This configuration parameter is deprecated starting with OpenShift 4.8, see the https://docs.openshift.com/container-platform/4.8/web_console/customizing-the-web-console.html#customizing-the-console-route_customizing-web-console[upstream documentation].
 
-The component provides support to use the new recommended configuration via the `ingress.config.openshift.io/cluster` object, see the documentation for parameters <<_openshift_version,`openshift_version`>> and <<_route,`route`>>.
+The component always configures the console route via the `ingress.config.openshift.io/cluster` object.
 
 If both this parameter and parameter `route` are present, parameter `route` has precedence over this parameter.
 ====

tests/custom-plugins.yml

@@ -2,4 +2,6 @@ parameters:
   openshift4_console:
     config:
       plugins:
+        - foo-bar
+        - example-plugin
         - example-plugin

tests/golden/custom-links/openshift4-console/openshift4-console/00_namespace.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 kind: Namespace
 metadata:
   annotations:
-    openshift.io/node-selector: node-role.kubernetes.io/master=
+    openshift.io/node-selector: ''
   labels:
     name: openshift-console
   name: openshift-console

tests/golden/custom-logo/openshift4-console/openshift4-console/00_namespace.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 kind: Namespace
 metadata:
   annotations:
-    openshift.io/node-selector: node-role.kubernetes.io/master=
+    openshift.io/node-selector: ''
   labels:
     name: openshift-console
   name: openshift-console

tests/golden/custom-plugins/openshift4-console/openshift4-console/00_namespace.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 kind: Namespace
 metadata:
   annotations:
-    openshift.io/node-selector: node-role.kubernetes.io/master=
+    openshift.io/node-selector: ''
   labels:
     name: openshift-console
   name: openshift-console