Removing references to openshift container platform, bumping CRD (#1415)

# Summary We removed support for deploying via OpenShift operatorhub / marketplace a few months back. The burden of maintaining the certifications/process required was sufficient to pull that feature set out moving forward and migrate it to AIStor as part of a more complete enterprise offering. For now we need to remove references to the operator hub / marketplace. It is possible that the Openshift Kubernetes Engine may work w/ our stock kubernetes installation paths, but we do not have resources to test. So for the immediate term, we're just going to pull whats outdated. Also throwing in a fixup to the CRDs - I ran into a weird issue where I had to `pip3 install asciidoc` before the sync-operator-crd-docs job worked, am looking into that separately. Staged: http://192.241.195.202:9000/staging/openshift-fixup/openshift/index.html
2025-07-31 18:04:52 +03:00 · 2025-02-11 14:00:44 -05:00
parent 22a6a3b562
commit 265af648e2
8 changed files with 139 additions and 343 deletions
--- a/source/includes/k8s/deploy-operator.rst
+++ b/source/includes/k8s/deploy-operator.rst
@ -27,6 +27,14 @@ See the MinIO Operator :minio-git:`CRD Reference <operator/blob/master/docs/tena
 This documentation assumes familiarity with referenced Kubernetes concepts, utilities, and procedures. 
 While this documentation *may* provide guidance for configuring or deploying Kubernetes-related resources on a best-effort basis, it is not a replacement for the official :kube-docs:`Kubernetes Documentation <>`.

+.. cond:: openshift
+
+   .. important::
+
+      Support for deploying the MinIO Operator via the RedHat Marketplace or OperatorHub was removed in 2024. 
+      |subnet| customers can open an issue for further clarification and instructions on migrating to `AIStor <https://min.io/product/aistor-overview?jmp=docs>`__.
+
+      This documentation provides guidance through the general method of operator installation onto Kubernetes infrastructure.

 MinIO Operator Components
 -------------------------
--- a/source/includes/k8s/ext-tenant-crd.md
+++ b/source/includes/k8s/ext-tenant-crd.md
@ -981,6 +981,45 @@ should keep running this Pool without a Security Context</p></td>
 </tbody>
 </table>

+## PoolsMetadata
+
+PoolsMetadata (`poolsMetadata`) defines custom labels and annotations
+for the MinIO pool stateful sets / pods.  
+
+-   [TenantSpec](#tenantspec)
+
+<table>
+<colgroup>
+<col style="width: 25%" />
+<col style="width: 75%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th style="text-align: left;">Field</th>
+<th style="text-align: left;">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td style="text-align: left;"><p><strong><code>labels</code></strong>
+<em>object (keys:string, values:string)</em></p></td>
+<td style="text-align: left;"><p><strong>Optional</strong><br />
+</p>
+<p>If provided, append these labels to the MinIO statefulset /
+pods</p></td>
+</tr>
+<tr class="even">
+<td
+style="text-align: left;"><p><strong><code>annotations</code></strong>
+<em>object (keys:string, values:string)</em></p></td>
+<td style="text-align: left;"><p><strong>Optional</strong><br />
+</p>
+<p>If provided, append these annotations to the MinIO statefulset /
+pods</p></td>
+</tr>
+</tbody>
+</table>
+
 ## ServiceMetadata

 ServiceMetadata (`serviceMetadata`) defines custom labels and
@ -1033,6 +1072,22 @@ style="text-align: left;"><p><strong><code>consoleServiceAnnotations</code></str
 </p>
 <p>If provided, append these annotations to the Console service</p></td>
 </tr>
+<tr class="odd">
+<td
+style="text-align: left;"><p><strong><code>kesServiceLabels</code></strong>
+<em>object (keys:string, values:string)</em></p></td>
+<td style="text-align: left;"><p><strong>Optional</strong><br />
+</p>
+<p>If provided, append these labels to the KES service</p></td>
+</tr>
+<tr class="even">
+<td
+style="text-align: left;"><p><strong><code>kesServiceAnnotations</code></strong>
+<em>object (keys:string, values:string)</em></p></td>
+<td style="text-align: left;"><p><strong>Optional</strong><br />
+</p>
+<p>If provided, append these annotations to the KES service</p></td>
+</tr>
 </tbody>
 </table>

@ -1673,6 +1728,16 @@ href="#servicemetadata">ServiceMetadata</a></em></p></td>
 and/or Console service.</p></td>
 </tr>
 <tr class="even">
+<td
+style="text-align: left;"><p><strong><code>poolsMetadata</code></strong>
+<em><a
+href="#poolsmetadata">PoolsMetadata</a></em></p></td>
+<td style="text-align: left;"><p><strong>Optional</strong><br />
+</p>
+<p>Specify custom labels and annotations to append to all pool
+statefulsets and pods.</p></td>
+</tr>
+<tr class="odd">
 <td style="text-align: left;"><p><strong><code>users</code></strong>
 <em><a
 href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#localobjectreference-v1-core">LocalObjectReference</a>
@ -1704,7 +1769,7 @@ policy by default. You can change the assigned policy after the Tenant
 starts.<br />
 </p></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td style="text-align: left;"><p><strong><code>buckets</code></strong>
 <em><a
 href="#bucket">Bucket</a>
@ -1714,7 +1779,7 @@ array</em></p></td>
 <p>Create buckets when creating a new tenant. Skip if bucket with given
 name already exists</p></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td style="text-align: left;"><p><strong><code>logging</code></strong>
 <em><a
 href="#logging">Logging</a></em></p></td>
@ -1722,7 +1787,7 @@ href="#logging">Logging</a></em></p></td>
 </p>
 <p>Enable JSON, Anonymous logging for MinIO tenants.</p></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td
 style="text-align: left;"><p><strong><code>configuration</code></strong>
 <em><a
@ -1734,7 +1799,7 @@ configurations to be used for the MinIO pools. The secret is expected to
 have a key named config.env containing all exported environment
 variables for MinIO+</p></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td
 style="text-align: left;"><p><strong><code>initContainers</code></strong>
 <em><a
@ -1744,7 +1809,7 @@ array</em></p></td>
 </p>
 <p>Add custom initContainers to StatefulSet</p></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td
 style="text-align: left;"><p><strong><code>additionalVolumes</code></strong>
 <em><a
@ -1756,7 +1821,7 @@ array</em></p></td>
 rules for the corresponding volumes and volume mounts. We will not test
 this rule, k8s will show the result.</p></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td
 style="text-align: left;"><p><strong><code>additionalVolumeMounts</code></strong>
 <em><a
--- a/source/includes/k8s/operator-values.yaml
+++ b/source/includes/k8s/operator-values.yaml
@ -10,10 +10,6 @@ operator:
  # .. code-block:: yaml
  #
  #    env:
-  #    - name: MINIO_OPERATOR_DEPLOYMENT_NAME
-  #      valueFrom:
-  #        fieldRef:
-  #          fieldPath: metadata.labels['app.kubernetes.io/name']
  #    - name: CLUSTER_DOMAIN
  #      value: "cluster.domain"
  #    - name: WATCHED_NAMESPACE
@ -32,14 +28,14 @@ operator:
  ###
  # Specify the Operator container image to use for the deployment.
  # ``image.tag``
-  # For example, the following sets the image to the ``quay.io/minio/operator`` repo and the v6.0.3 tag.
+  # For example, the following sets the image to the ``quay.io/minio/operator`` repo and the v7.0.0 tag.
  # The container pulls the image if not already present:
  #
  # .. code-block:: yaml
  #
  #    image:
  #      repository: quay.io/minio/operator
-  #      tag: v6.0.3
+  #      tag: v7.0.0
  #      pullPolicy: IfNotPresent
  #
  # The chart also supports specifying an image based on digest value:
@ -53,20 +49,20 @@ operator:
  #
  image:
    repository: quay.io/minio/operator
-    tag: v6.0.3
+    tag: v7.0.0
    pullPolicy: IfNotPresent
  ###
  # Specify the sidecar container image to deploy on tenant pods for init container and sidecar.
  # Only need to change this if want to use a different version that the default, or want to set a custom registry.
  # ``sidecarImage.tag``
-  # For example, the following sets the image to the ``quay.io/minio/operator-sidecar`` repo and the v6.0.3 tag.
+  # For example, the following sets the image to the ``quay.io/minio/operator-sidecar`` repo and the v7.0.0 tag.
  # The container pulls the image if not already present:
  #
  # .. code-block:: yaml
  #
  #    sidecarImage:
  #      repository: quay.io/minio/operator-sidecar
-  #      tag: v6.0.3
+  #      tag: v7.0.0
  #      pullPolicy: IfNotPresent
  #
  # The chart also supports specifying an image based on digest value:
--- a/source/includes/k8s/tenant-values.yaml
+++ b/source/includes/k8s/tenant-values.yaml
@ -8,14 +8,14 @@ tenant:
  ###
  # Specify the Operator container image to use for the deployment.
  # ``image.tag`` 
-  # For example, the following sets the image to the ``quay.io/minio/operator`` repo and the v6.0.3 tag.
+  # For example, the following sets the image to the ``quay.io/minio/operator`` repo and the v7.0.0 tag.
  # The container pulls the image if not already present:
  #
  # .. code-block:: yaml
  # 
  #    image:
  #       repository: quay.io/minio/minio
-  #       tag: RELEASE.2024-08-17T01-24-54Z
+  #       tag: RELEASE.2024-11-07T00-52-20Z
  #       pullPolicy: IfNotPresent
  #
  # The chart also supports specifying an image based on digest value:
@ -30,7 +30,7 @@ tenant:
  #
  image:
    repository: quay.io/minio/minio
-    tag: RELEASE.2024-08-17T01-24-54Z
+    tag: RELEASE.2024-11-07T00-52-20Z
    pullPolicy: IfNotPresent
  ###
  #
@ -38,6 +38,30 @@ tenant:
  # Only one array element is supported at this time.
  imagePullSecret: { }
  ###
+  #
+  # Specify `initContainers <https://kubernetes.io/docs/concepts/workloads/pods/init-containers/>`__ to perform setup or configuration tasks before the main Tenant pods starts.
+  #
+  # Example of init container which waits for idenity provider to be reachable before starting MinIO Tenant:
+  # 
+  # .. code-block:: yaml
+  #
+  #    initContainers:
+  #     - name: wait-for-idp
+  #       image: busybox
+  #       command:
+  #         - sh
+  #         - -c
+  #         - |
+  #           URL="https://idp-url"
+  #           echo "Checking IdP reachability (${URL})"
+  #           until $(wget -q -O "/dev/null" ${URL}) ; do
+  #             echo "IdP (${URL}) not reachable. Waiting to be reachable..."
+  #             sleep 5
+  #           done
+  #           echo "IdP (${URL}) reachable. Starting MinIO..."
+  #
+  initContainers: [ ]
+  ###
  # The Kubernetes `Scheduler <https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/>`__ to use for dispatching Tenant pods.
  #
  # Specify an empty dictionary ``{}`` to dispatch pods with the default scheduler.
@ -62,12 +86,24 @@ tenant:
  #
  #    name: myminio-env-configuration
  #    accessKey: minio
-  #    secretKey: minio123
+  #      secretKey: minio123
  #
  configSecret:
    name: myminio-env-configuration
    accessKey: minio
    secretKey: minio123
+    #existingSecret: true
+
+  ###
+  # Metadata that will be added to the statefulset and pods of all pools
+  poolsMetadata:
+    ###
+    # Specify `annotations <https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/>`__ to associate to Tenant pods.
+    annotations: { }
+    ###
+    # Specify `labels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/>`__ to associate to Tenant pods.
+    labels: { }
+
  ###
  # If this variable is set to true, then enable the usage of an existing Kubernetes secret to set environment variables for the Tenant.
  # The existing Kubernetes secret name must be placed under .tenant.configuration.name e.g. existing-minio-env-configuration
@ -113,6 +149,9 @@ tenant:
      # Specify `storageAnnotations <https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/>`__ to associate to PVCs.
      storageAnnotations: { }
      ###
+      # Specify `storageLabels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/>`__ to associate to PVCs.
+      storageLabels: { }
+      ###
      # Specify `annotations <https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/>`__ to associate to Tenant pods.
      annotations: { }
      ###
@ -253,8 +292,8 @@ tenant:
  # .. code-block:: yaml
  #
  #    - name: my-minio-bucket
-  #         objectLock: false        # optional
-  #         region: us-east-1        # optional
+  #      objectLock: false        # optional
+  #      region: us-east-1        # optional
  buckets: [ ]
  ###
  # Array of Kubernetes secrets from which the Operator generates MinIO users during tenant provisioning.
@ -347,14 +386,14 @@ tenant:
  #  # Image from tag (original behavior), for example:
  #  # image:
  #  #   repository: quay.io/minio/kes
-  #  #   tag: 2024-08-16T14-39-28Z
+  #  #   tag: 2024-11-25T13-44-31Z
  #  # Image from digest (added after original behavior), for example:
  #  # image:
  #  #   repository: quay.io/minio/kes@sha256
  #  #   digest: fb15af611149892f357a8a99d1bcd8bf5dae713bd64c15e6eb27fbdb88fc208b
  #  image:
  #    repository: quay.io/minio/kes
-  #    tag: 2024-08-16T14-39-28Z
+  #    tag: 2024-11-25T13-44-31Z
  #    pullPolicy: IfNotPresent
  #  env: [ ]
  #  replicas: 2