minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-27 08:41:57 +03:00
Code Activity

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

Browse Source 
# 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
This commit is contained in:
Ravind Kumar
2025-02-11 14:00:44 -05:00
committed by GitHub
parent 22a6a3b562
commit 265af648e2
8 changed files with 139 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files

295
source/includes/openshift/deploy-minio-on-openshift.rst
View File

@ -1,295 +0,0 @@
.. _deploy-operator-openshift:
=========================================
Deploy MinIO Operator on RedHat OpenShift
=========================================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
Overview
--------
Red Hat® OpenShift® is an enterprise-ready Kubernetes container platform with full-stack automated operations to manage hybrid cloud, multi-cloud, and edge deployments.
OpenShift includes an enterprise-grade Linux operating system, container runtime, networking, monitoring, registry, and authentication and authorization solutions.
You can deploy the MinIO Kubernetes Operator through the :openshift-docs:`Red Hat® OpenShift® Container Platform 4.8+ <welcome/index.html>`.
You can deploy and manage MinIO Tenants through OpenShift after deploying the MinIO Operator.
This procedure includes instructions for the following deployment paths:
- Purchase and Deploy MinIO through the `RedHat Marketplace <https://marketplace.redhat.com/en-us/products/minio-hybrid-cloud-object-storage>`__.
- Deploy MinIO through the OpenShift `OperatorHub <https://operatorhub.io/operator/minio-operator>`__
After deploying the MinIO Operator into your OpenShift cluster, you can create and manage MinIO Tenants through the :openshift-docs:`OperatorHub <operators/understanding/olm-understanding-operatorhub.html>` user interface.
This documentation assumes familiarity with all referenced Kubernetes and OpenShift concepts, utilities, and procedures.
While this documentation *may* provide guidance for configuring or deploying Kubernetes-related or OpenShift-related resources on a best-effort basis, it is not a replacement for the official :kube-docs:`Kubernetes Documentation <>` and :openshift-docs:`OpenShift Container Platform 4.8+ Documentation <welcome/index.html>`.
Prerequisites
-------------
RedHat OpenShift 4.8+
~~~~~~~~~~~~~~~~~~~~~
The MinIO Kubernetes Operator is available starting with `OpenShift 4.8+ <https://docs.openshift.com/container-platform/4.13/welcome/index.html>`__.
Red Hat Marketplace installation requires registration of the OpenShift cluster with the Marketplace for the necessary namespaces.
See `Register OpenShift cluster with Red Hat Marketplace <https://marketplace.redhat.com/en-us/documentation/clusters>`__ for complete instructions.
For older versions of OpenShift, use the generic :ref:`deploy-operator-kubernetes` procedure.
Administrator Access
~~~~~~~~~~~~~~~~~~~~
Installation of operators through the Red Hat Marketplace and the Operator Hub is restricted to OpenShift cluster administrators (``cluster-admin`` privileges).
This procedure requires logging into the Marketplace and/or OpenShift with an account that has those privileges.
OpenShift ``oc`` CLI
~~~~~~~~~~~~~~~~~~~~
:openshift-docs:`Download and Install <cli_reference/openshift_cli/getting-started-cli.html>` the OpenShift :abbr:`CLI (command-line interface)` ``oc`` for use in this procedure.
Procedure
---------
1) Access the MinIO Operator Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Select the tab that corresponds to your preferred installation method:
.. tab-set::
.. tab-item:: Red Hat OperatorHub
Log into the OpenShift Web Console as a user with ``cluster-admin`` privileges.
From the :guilabel:`Administrator` panel, select :guilabel:`Operators`, then :guilabel:`OperatorHub`.
From the :guilabel:`OperatorHub` page, type "MinIO" into the :guilabel:`Filter` text entry. Select the :guilabel:`MinIO Operator` tile from the search list.
.. image:: /images/openshift/minio-openshift-select-minio.png
:align: center
:width: 90%
:class: no-scaled-link
:alt: From the OperatorHub, search for MinIO, then select the MinIO Tile.
Select the :guilabel:`MinIO Operator` tile, then click :guilabel:`Install` to begin the installation.
.. tab-item:: Red Hat Marketplace
Open the `MinIO Red Hat Marketplace listing <https://marketplace.redhat.com/en-us/products/minio-hybrid-cloud-object-storage>`__ in your browser.
Click :guilabel:`Login` to log in with your Red Hat Marketplace account.
After logging in, click :guilabel:`Purchase` to purchase the MinIO Operator for your account.
After completing the purchase, click :guilabel:`Workplace` from the top navigation and select :guilabel:`My Software`.
.. image:: /images/openshift/minio-openshift-marketplace-my-software.png
:align: center
:width: 90%
:class: no-scaled-link
:alt: From the Red Hat Marketplace, select Workplace, then My Software
Click :guilabel:`MinIO Hybrid Cloud Object Storage` and select :guilabel:`Install Operator` to start the Operator Installation procedure in OpenShift.
2) Configure and Deploy the Operator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :guilabel:`Install Operator` page provides a walkthrough for configuring the MinIO Operator installation.
.. image:: /images/openshift/minio-openshift-operator-installation.png
:align: center
:width: 90%
:class: no-scaled-link
:alt: Complete the Operator Installation Walkthrough
- For :guilabel:`Update channel`, select any of the available options.
- For :guilabel:`Installation Mode`, select :guilabel:`All namespaces on the cluster`
- For :guilabel:`Installed Namespace`, select :guilabel:`openshift-operators`
- For :guilabel:`Approval Strategy`, select the approval strategy of your choice.
See the :openshift-docs:`Operator Installation Documentation <operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster>` :guilabel:`Step 5` for complete descriptions of each displayed option.
Click :guilabel:`Install` to start the installation procedure.
The web console displays a widget for tracking the installation progress.
.. image:: /images/openshift/minio-openshift-operator-installation-progress.png
:align: center
:width: 70%
:class: no-scaled-link
:alt: Wait for Installation to Complete.
Once installation completes, click :guilabel:`View Operator` to view the MinIO Operator page.
3) Configure TLS Certificates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have installed the MinIO Operator from Red Hat OperatorHub, the installation process also configures the :openshift-docs:`OpenShift Service CA Operator <security/certificate_types_descriptions/service-ca-certificates.html>`.
This Operator manages the TLS certificates required to access MinIO Tenants.
It automatically renews and rotates the certificates 13 months before expiration.
No additional action is required.
For Operator installations deployed by other methods, configure the :openshift-docs:`Service CA certificates <security/certificate_types_descriptions/service-ca-certificates.html>` manually.
See the dropdowns below for details.
.. dropdown:: OpenShift Service CA Certificate configuration
To manually enable the ``service-ca`` Operator to manage TLS certificates:
#. Use the following :openshift-docs:`oc <cli_reference/openshift_cli/getting-started-cli.html>` command to edit the deployment:
.. code-block:: shell
:class: copyable
oc edit deployment minio-operator -n minio-operator
If needed, replace ``minio-operator`` with the name and namespace of your deployment.
``oc edit`` opens the deployment configuration file in an editor.
#. In the ``spec`` section, add the highlighted MinIO Operator :ref:`environment variables <minio-server-environment-variables>`:
.. code-block:: shell
:class: copyable
:emphasize-lines: 5-8
containers:
- args:
- controller
env:
- name: MINIO_CONSOLE_TLS_ENABLE
value: 'on'
- name: MINIO_OPERATOR_RUNTIME
value: OpenShift
#. In the ``volumes`` section, add the following volumes and volume mounts:
- ``sts-tls``
- ``openshift-service-ca``
- ``openshift-csr-signer-ca``
The added volume configuration resembles the following:
.. code-block:: shell
:class: copyable
volumes:
- name: sts-tls
projected:
sources:
- secret:
name: sts-tls
items:
- key: tls.crt
path: public.crt
- key: tls.key
path: private.key
optional: true
defaultMode: 420
- name: openshift-service-ca
configMap:
name: openshift-service-ca.crt
items:
- key: service-ca.crt
path: service-ca.crt
defaultMode: 420
optional: true
- name: openshift-csr-signer-ca
projected:
sources:
- secret:
name: openshift-csr-signer-ca
items:
- key: tls.crt
path: tls.crt
optional: true
defaultMode: 420
volumeMounts:
- name: openshift-service-ca
mountPath: /tmp/service-ca
- name: openshift-csr-signer-ca
mountPath: /tmp/csr-signer-ca
- name: sts-tls
mountPath: /tmp/sts
.. dropdown:: OpenShift Service CA Certificate for Helm deployments
For Helm deployments on OpenShift, add the following :ref:`environment variables <minio-server-environment-variables>` and volumes to the ``values.yaml`` in the Operator Helm chart before deploying.
The added YAML configuration for the ``operator`` pod resembles the following:
.. code-block::
:class: copyable
operator:
env:
- name: MINIO_OPERATOR_RUNTIME
value: "OpenShift"
- name: MINIO_CONSOLE_TLS_ENABLE
value: "on"
volumes:
- name: sts-tls
projected:
sources:
- secret:
name: sts-tls
items:
- key: tls.crt
path: public.crt
- key: tls.key
path: private.key
optional: true
defaultMode: 420
- name: openshift-service-ca
configMap:
name: openshift-service-ca.crt
items:
- key: service-ca.crt
path: service-ca.crt
defaultMode: 420
optional: true
- name: openshift-csr-signer-ca
projected:
sources:
- secret:
name: openshift-csr-signer-ca
items:
- key: tls.crt
path: tls.crt
optional: true
defaultMode: 420
volumeMounts:
- name: openshift-service-ca
mountPath: /tmp/service-ca
- name: openshift-csr-signer-ca
mountPath: /tmp/csr-signer-ca
- name: sts-tls
mountPath: /tmp/sts
4) Open the MinIO Operator Interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can find the MinIO Operator Interface from the :guilabel:`Operators` left-hand navigation header
1. Go to :guilabel:`Operators`, then :guilabel:`Installed Operators`.
2. For the :guilabel:`Project` dropdown, select :guilabel:`openshift-operators`.
3. Select :guilabel:`MinIO Operators` from the list of installed operators.
The :guilabel:`Status` column must read :guilabel:`Success` to access the Operator interface.
5) Next Steps
~~~~~~~~~~~~~
After deploying the MinIO Operator, you can create a new MinIO Tenant.
To deploy a MinIO Tenant using OpenShift, see :ref:`deploy-minio-tenant-redhat-openshift`.