diff --git a/source/default-conf.py b/source/default-conf.py index 12cc1ebf..6fa802f6 100644 --- a/source/default-conf.py +++ b/source/default-conf.py @@ -332,6 +332,9 @@ rst_prolog = """ .. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)` .. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)` .. |operator-version-stable| replace:: OPERATOR +.. |helm-charts| replace:: `Helm Charts `__ +.. |helm-operator-chart| replace:: `Helm Operator Charts `__ +.. |helm-tenant-chart| replace:: `Helm Tenant Charts `__ .. |cpp-sdk-version| replace:: CPPVERSION .. |dotnet-sdk-version| replace:: DOTNETVERSION diff --git a/source/index.rst b/source/index.rst index 9fe25ddd..c59636bf 100644 --- a/source/index.rst +++ b/source/index.rst @@ -213,6 +213,7 @@ For more about connecting to ``play``, see :ref:`MinIO Console play Login `. - The Community Helm Chart is community built, maintained, and supported. + The Community Helm Chart is built, maintained, and supported by the community. MinIO does not guarantee support for any given bug, feature request, or update referencing that chart. - The Operator Tenant Chart is officially maintained and supported by MinIO. - MinIO strongly recommends the official Helm Chart for Operator and Tenants for production environments. + The :ref:`Operator Tenant Chart ` is officially maintained and supported by MinIO. + MinIO strongly recommends the official Helm Chart for :ref:`Operator ` and :ref:`Tenants ` for production environments. Prerequisites ------------- @@ -101,6 +101,9 @@ You can modify the Operator deployment after installation. --create-namespace \ MINIO_TENANT_NAME minio-operator/tenant + For details on the options available in the MinIO Tenant ``values.yaml``, see :ref:`minio-tenant-chart-values`. + + #. Validate the Tenant installation Check the contents of the specified namespace to ensure all pods and services have started successfully. @@ -178,6 +181,7 @@ This method may support easier pre-configuration of the Tenant compared to the : curl -O https://raw.githubusercontent.com/minio/operator/master/helm-releases/tenant-|operator-version-stable|.tgz Each chart contains a ``values.yaml`` file you can customize to suit your needs. + For details on the options available in the MinIO Tenant ``values.yaml``, see :ref:`minio-tenant-chart-values`. For example, you may wish to change the MinIO root user credentials or the Tenant name. For more about customizations, see `Helm Charts `__. diff --git a/source/operations/install-deploy-manage/deploy-operator-helm.rst b/source/operations/install-deploy-manage/deploy-operator-helm.rst index 7e26047f..2b1f7ac3 100644 --- a/source/operations/install-deploy-manage/deploy-operator-helm.rst +++ b/source/operations/install-deploy-manage/deploy-operator-helm.rst @@ -200,6 +200,8 @@ This method may support easier pre-configuration of the Operator compared to the curl -O https://raw.githubusercontent.com/minio/operator/master/helm-releases/operator-|operator-version-stable|.tgz The chart contains a ``values.yaml`` file you can customize to suit your needs. + For details on the options available in the MinIO Operator ``values.yaml``, see :ref:`minio-operator-chart-values`. + For more about customizations, see `Helm Charts `__. #. Deploy Operator diff --git a/source/reference/operator-chart-values.rst b/source/reference/operator-chart-values.rst index f6c91ef6..383eccf6 100644 --- a/source/reference/operator-chart-values.rst +++ b/source/reference/operator-chart-values.rst @@ -1,8 +1,8 @@ .. _minio-operator-chart-values: -=============================== -Operator and Tenant Helm Charts -=============================== +==================== +Operator Helm Charts +==================== .. default-domain:: minio @@ -10,10 +10,11 @@ Operator and Tenant Helm Charts :local: :depth: 1 -MinIO publishes `Helm Charts `__ for the MinIO Operator and Tenants. +MinIO publishes |helm-charts| for the |helm-operator-chart| and |helm-tenant-chart|. You can use these charts to deploy the MinIO Operator and managed Tenants through Helm. -The following page documents the ``values.yaml`` for each chart. +The following page documents the ``values.yaml`` chart for the MinIO Operator. +For documentation on the chart for a MinIO Tenant, see :ref:`minio-tenant-chart-values` .. _minio-operator-chart-operator-values: @@ -29,18 +30,3 @@ MinIO Operator Chart .. tab-item:: YAML .. literalinclude:: /includes/k8s/operator-values.yaml - -.. _minio-operator-chart-tenant-values: - -MinIO Tenant Chart ------------------- - -.. tab-set:: - - .. tab-item:: Reference - - .. autoyaml:: /source/includes/k8s/tenant-values.yaml - - .. tab-item:: YAML - - .. literalinclude:: /includes/k8s/tenant-values.yaml \ No newline at end of file diff --git a/source/reference/tenant-chart-values.rst b/source/reference/tenant-chart-values.rst new file mode 100644 index 00000000..60e291ea --- /dev/null +++ b/source/reference/tenant-chart-values.rst @@ -0,0 +1,33 @@ +.. _minio-tenant-chart-values: + +================== +Tenant Helm Charts +================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 1 + +MinIO publishes |helm-charts| for the |helm-operator-chart| and |helm-tenant-chart|. +You can use these charts to deploy the MinIO Operator and managed Tenants through Helm. + +The following page documents the ``values.yaml`` chart for a MinIO Tenant. +For documentation on the chart for a MinIO Operator, see :ref:`minio-operator-chart-values` + +.. _minio-tenant-chart-operator-values: + + +MinIO Tenant Chart +------------------ + +.. tab-set:: + + .. tab-item:: Reference + + .. autoyaml:: /source/includes/k8s/tenant-values.yaml + + .. tab-item:: YAML + + .. literalinclude:: /includes/k8s/tenant-values.yaml \ No newline at end of file