minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity

attempt to remove plugin from docs (#1219)

Browse Source 
The Kubernetes plugin is gone, this PR replaces the procedures that use
`kubectl minio` in all its various forms. The plugin was referenced on
many pages and for many purposes so there is _a lot_ of restructuring
involved.

Some procedures no longer have CLI instructions, which can be addressed
in subsequent PRs. Everything should have at least one working method,
even if it's to use Operator Console.

- Remove references to plugin, except for pre-4.5.8 upgrade paths
- Move pre-4.5.8 upgrade paths to new child page (currently hidden from
TOC, linked in page)
- Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:
- [Operator
deploy](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/installation.html)
- [Operator
upgrade](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/install-deploy-manage/upgrade-minio-operator.html)
- [Deploy and manage
Tenants](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/deploy-manage-tenants.html)

Fixes https://github.com/minio/docs/issues/1213
This commit is contained in:
Andrea Longo
2024-06-07 09:05:39 -06:00
committed by GitHub
parent 52e66839f1
commit d17c896f75
56 changed files with 811 additions and 2577 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
source/reference/kubectl-minio-plugin.rst
View File

@ -1,100 +0,0 @@
:orphan:
.. _minio-kubectl-plugin:
=======================
MinIO Kubernetes Plugin
=======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
Overview
--------
.. admonition:: Current Stable Version is |operator-version-stable|
:class: note
This reference documentation reflects |operator-version-stable| of the
MinIO Kubernetes Operator and :mc:`kubectl minio` plugin.
The :mc:`kubectl minio` plugin brings native support for deploying MinIO tenants to Kubernetes clusters using the ``kubectl`` CLI.
Use :mc:`kubectl minio` to deploy a MinIO tenant with little to no interaction with ``YAML`` configuration files.
.. image:: /images/minio-k8s.svg
:align: center
:width: 90%
:class: no-scaled-link
:alt: Kubernetes Orchestration with the MinIO Operator facilitates automated deployment of MinIO clusters.
Installing :mc:`kubectl minio` implies installing the
:minio-git:`MinIO Kubernetes Operator <operator>`.
.. _minio-plugin-installation:
.. mc:: kubectl minio
Installation
------------
The MinIO Kubernetes Plugin requires Kubernetes 1.19.0 or later.
The following code downloads the latest stable version |operator-version-stable| of the MinIO Kubernetes Plugin and installs it to the system ``$PATH``.
.. tab-set::
.. tab-item:: krew
This procedure uses the Kubernetes krew plugin manager for installing the MinIO Kubernetes Operator and Plugin.
See the ``krew`` `installation documentation <https://krew.sigs.k8s.io/docs/user-guide/setup/install/>`__ for specific instructions.
.. code-block:: shell
:class: copyable
kubectl krew update
kubectl krew install minio
.. tab-item:: shell
.. code-block:: shell
:substitutions:
:class: copyable
wget https://github.com/minio/operator/releases/download/v|operator-version-stable|/kubectl-minio_|operator-version-stable|_linux_amd64 -O kubectl-minio
chmod +x kubectl-minio
mv kubectl-minio /usr/local/bin/
You can access the plugin using the :mc:`kubectl minio` command. Run
the following command to verify installation of the plugin:
.. code-block:: shell
:class: copyable
kubectl minio version
Subcommands
-----------
:mc:`kubectl minio` has the following subcommands:
- :mc:`~kubectl minio init`
- :mc:`~kubectl minio proxy`
- :mc:`~kubectl minio tenant`
- :mc:`~kubectl minio delete`
- :mc:`~kubectl minio version`
.. toctree::
:titlesonly:
:hidden:
/reference/kubectl-minio-plugin/kubectl-minio-init
/reference/kubectl-minio-plugin/kubectl-minio-proxy
/reference/kubectl-minio-plugin/kubectl-minio-tenant
/reference/kubectl-minio-plugin/kubectl-minio-delete
/reference/kubectl-minio-plugin/kubectl-minio-version

84
source/reference/kubectl-minio-plugin/kubectl-minio-delete.rst
View File

@ -1,84 +0,0 @@
.. _kubectl-minio-delete:
========================
``kubectl minio delete``
========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio delete
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-delete-desc
Deletes the MinIO Operator along with all associated resources, including all MinIO Tenant instances in the :mc-cmd:`watched namespace <kubectl minio init --namespace-to-watch>`.
.. end-kubectl-minio-delete-desc
.. warning::
If the underlying Persistent Volumes (``PV``) were created with a reclaim policy of ``recycle`` or ``delete``, deleting the MinIO Tenant results in complete loss of all objects stored on the tenant.
Ensure you have performed all due diligence in confirming the safety of any data on each Operator-managed MinIO Tenant prior to deletion.
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example deletes a the MinIO Operator in the ``minio-operator`` namesapce and all its tenants:
.. code-block:: shell
:class: copyable
kubectl minio delete --namespace minio-operator
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio delete \
--namespace \
[--force --dangerous]
Flags
-----
The command supports the following flags:
.. mc-cmd:: --namespace
:required:
The namespace of the operator to delete.
Defaults to ``minio-operator``.
.. mc-cmd:: --dangerous
:optional:
Safety flag to confirm deletion of the MinIO Operator and all tenants with :mc-cmd:`~kubectl minio delete --force`.
This operation is irreversible.
.. mc-cmd:: --force
:optional:
Deletes the MinIO Operator and all tenants without confirmation.
Requires the :mc-cmd:`~kubectl minio delete --dangerous` flag.
This operation is irreversible.

1
source/reference/kubectl-minio-plugin/kubectl-minio-init.rst
View File

@ -1,3 +1,4 @@
:orphan:
.. _kubectl-minio-init:

85
source/reference/kubectl-minio-plugin/kubectl-minio-proxy.rst
View File

@ -1,85 +0,0 @@
.. _kubectl-minio-proxy:
=======================
``kubectl minio proxy``
=======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio proxy
Description
-----------
.. start-kubectl-minio-proxy-desc
:mc-cmd:`kubectl minio proxy` creates a temporary proxy to forward traffic from the local host machine to the MinIO Operator Console.
The :ref:`Operator Console <minio-operator-console>` provides a rich user interface for :ref:`deploying and managing MinIO Tenants <minio-k8s-deploy-minio-tenant>`.
This command is an alternative to configuring `Ingress <https://kubernetes.io/docs/concepts/services-networking/ingress/>`__ to grant access to the Operator Console pods.
.. end-kubectl-minio-proxy-desc
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. cond:: openshift
.. versionchanged:: Operator 5.0.0
The ``kubectl minio proxy`` command now supports retrieving the JWT for use with OpenShift deployments.
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following command creates proxy to use to access the operator graphical user interface for the ``myminio`` namespace:
.. code-block:: shell
:class: copyable
kubectl minio proxy --namespace myminio
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
kubectl minio init \
[--namespace]
Flags
-----
..
Default values update frequently and can be found in the following files:
https://github.com/minio/operator/blob/master/kubectl-minio/cmd/init.go
https://github.com/minio/operator/blob/master/kubectl-minio/cmd/helpers/constants.go
For minio/console, run ``kubectl minio init -o | grep minio/console``
The command supports the following flags:
.. mc-cmd:: --namespace
:optional:
The namespace for which to access the operator.
.. cond:: not openshift
Defaults to ``minio-operator``.
.. cond:: openshift
Defaults to ``openshift-operators``.

327
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.rst
View File

@ -1,327 +0,0 @@
.. _kubectl-minio-tenant-create:
===============================
``kubectl minio tenant create``
===============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant create
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-create-desc
:mc-cmd:`kubectl minio tenant create` adds a new MinIO tenant and associated resources to a Kubernetes cluster.
The :ref:`Operator Console <minio-operator-console>` provides a rich user interface for :ref:`deploying and managing MinIO Tenants <minio-k8s-deploy-minio-tenant>`.
:mc-cmd:`~kubectl minio tenant create` always uses the latest stable version of the :github:`MinIO Server <minio/releases>` and :github:`MinIO Console <console/releases>`.
.. end-kubectl-minio-tenant-create-desc
On success, the command returns the following:
- The administrative username and password for the Tenant.
.. important::
Store these credentials in a secure location, such as a password protected key manager.
MinIO does *not* show these credentials again.
- The Service created for connecting to the MinIO Console.
The Console supports administrative operations on the Tenant, such as configuring Identity and Access Management (IAM) and bucket configurations.
- The Service created for connecting to the MinIO Tenant.
Applications should use this service for performing operations against the MinIO Tenant.
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example creates a MinIO Tenant in the namespace ``minio-tenant-1`` consisting of 4 MinIO servers with 8 drives each and a total capacity of 32Ti.
.. code-block:: shell
:class: copyable
kubectl minio tenant create \
minio-tenant-1 \
--servers 4 \
--volumes 8 \
--capacity 32Ti \
--namespace minio-tenant-1 \
--storage-class local-storage
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant create \
TENANT_NAME \
--capacity \
--servers \
--volumes | --volumes-per-server \
[--interactive] \
[--disable-tls] \
[--enable-audit-logs] \
[--enable-prometheus] \
[--expose-console-service] \
[--expose-minio-service] \
[--image] \
[--image-pull-secret] \
[--kes-config] \
[--kes-image] \
[--namespace] \
[--output] \
[--pool] \
[--storage-class]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Flags
-----
The command supports the following flags:
.. mc-cmd:: --interactive
:optional:
Offers command line prompts to request the information required to set up a new tenant.
This command is mutually exclusive of the other flags when creating a new tenant.
When added, prompts ask for input for the following values:
- Tenant name
- Total servers
- Total volumes
- Namespace
- Capacity
- Disable TLS
- Disable audit logs
- Disable prometheus
.. mc-cmd:: TENANT_NAME
:required:
The name of the MinIO tenant which the command creates.
The name *must* be unique in the :mc-cmd:`~kubectl minio tenant create --namespace`.
.. mc-cmd:: --capacity
:required:
Total raw capacity of the MinIO tenant, such as 16Ti.
Include a string that is a number and a standard storage capacity unit.
The total capacity of the MinIO tenant. :mc:`kubectl minio` divides the capacity by the number of :mc-cmd:`~kubectl minio tenant create --volumes` to determine the amount of ``resources.requests.storage`` to set for each Persistent Volume Claim (``PVC``).
If no Persistent Volumes (``PV``) can satisfy the requested storage, :mc:`kubectl minio tenant create` hangs and waits until the required storage exists.
.. mc-cmd:: --servers
:required:
The number of ``minio`` servers to deploy on the Kubernetes cluster.
Ensure that the specified number of :mc-cmd:`~kubectl minio tenant create --servers` does *not* exceed the number of nodes in the Kubernetes cluster.
.. mc-cmd:: --volumes
:required:
Mutually exclusive with :mc-cmd:`~kubectl minio tenant create --volumes-per-server`.
Use either :mc-cmd:`~kubectl minio tenant create --volumes` or :mc-cmd:`~kubectl minio tenant create --volumes-per-server`.
The total number of volumes in the new MinIO Tenant Pool.
:mc-cmd:`kubectl minio tenant create` generates one :kube-docs:`Persistent Volume Claim (PVC) <concepts/storage/persistent-volumes/#persistentvolumeclaims>` for each volume.
The number of volumes affects both the requested storage of each ``PVC`` *and* the number of ``PVCs`` to associate to each MinIO Pod in the cluster:
- The command :mc:`kubectl minio` divides the :mc-cmd:`~kubectl minio tenant create --capacity` by the number of volumes to determine the amount of ``resources.requests.storage`` to set for each ``PVC``.
- :mc:`kubectl minio` determines the number of ``PVCs`` to associate to each ``minio`` server by dividing :mc-cmd:`~kubectl minio tenant create --volumes` by :mc-cmd:`~kubectl minio tenant create --servers`.
The command generates each ``PVC`` with Pod-specific selectors, such that each Pod only uses ``PVs`` that are locally-attached to the node running that Pod.
If the specified number of volumes exceeds the number of unbound ``PVs`` available on the cluster, :mc:`kubectl minio tenant create` hangs and waits until the required ``PVs`` exist.
.. mc-cmd:: --volumes-per-server
:required:
Mutually exclusive with :mc-cmd:`~kubectl minio tenant create --volumes`.
Use either :mc-cmd:`~kubectl minio tenant create --volumes-per-server` or :mc-cmd:`~kubectl minio tenant create --volumes`.
Number of volumes to use for each server in the pool.
Similar to :mc-cmd:`~kubectl minio tenant create --volumes`, but instead of specifying the total number of volumes for all MinIO servers, associate ``--volumes-per-server`` volumes to each server.
If the combined total number of volumes exceeds the number of unbound ``PVs`` available on the cluster, :mc:`kubectl minio tenant create` hangs and waits until the required ``PVs`` exist.
.. mc-cmd:: --disable-tls
:optional:
Disables automatic TLS certificate provisioning on the Tenant.
.. mc-cmd:: --enable-audit-logs
:optional:
.. include:: /includes/common/common-k8s-deprecation-audit-prometheus.rst
:start-after: start-deprecate-audit-logs
:end-before: end-deprecate-audit-logs
Defaults to ``true``.
Deploys the MinIO Tenant with a PostgreSQL Pod which, combined with an additional auto-deployed service, enables Audit Logging in the Tenant Console.
You can control the configuration of the PostgreSQL pod using the following optional parameters:
.. list-table::
:header-rows: 1
:widths: 40 60
:width: 80%
* - Option
- Description
* - ``--audit-logs-disk-space <int>``
- Specify the amount of storage to provision for the PostgreSQL pod.
The Operator provisions a PVC requesting the specified amount of storage in gigabytes.
Defaults to ``5``
If no Persistent Volume can meet the PVC request, the pod fails to deploy.
* - ``--audit-logs-pg-image``
- Specify the Docker image to use for deploying the PostgreSQL pod.
* - ``--audit-logs-storage-class``
- Specify the storage class to assign to the generated PVC for the PostgreSQL Pod.
Specify ``false`` to deploy the Tenant without the PostgreSQL and Audit Logging Console feature.
.. mc-cmd:: --enable-prometheus
:optional:
.. include:: /includes/common/common-k8s-deprecation-audit-prometheus.rst
:start-after: start-deprecate-prometheus
:end-before: end-deprecate-prometheus
Defaults to ``true``.
Deploys the MinIO Tenant with a Prometheus pod which enables the :ref:`MinIO Console Metrics <minio-console-monitoring>` view.
You can control the configuration of the Prometheus pod using the following optional parameters:
.. list-table::
:header-rows: 1
:widths: 40 60
:width: 80%
* - Option
- Description
* - ``--prometheus-disk-space <int>``
- Specify the amount of storage to provision for the Prometheus pod.
The Operator provisions a PVC requesting the specified amount of storage in gigabytes.
Defaults to ``5``.
* - ``--prometheus-image``
- Specify the Docker image to use for deploying the Prometheus pod.
* - ``--prometheus-storage-class``
- Specify the storage class to assign to the generated PVC for the Prometheus pod.
.. mc-cmd:: --expose-console-service
:optional:
Directs the Operator to configure the MinIO Tenant Console service with the :kube-docs:`LoadBalancer <concepts/services-networking/service/#loadbalancer>` networking type.
For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.
.. mc-cmd:: --expose-minio-service
:optional:
Directs the Operator to configure the MinIO API service with the :kube-docs:`LoadBalancer <concepts/services-networking/service/#loadbalancer>` networking type.
For Kubernetes clusters configured with a global load balancer, this option allows the Console to request an external IP address automatically.
.. mc-cmd:: --image
:optional:
MinIO image to use for the tenant.
Defaults to the latest minio release.
.. mc-cmd:: --image-pull-secret
:optional:
The image secret to use for pulling MinIO.
.. mc-cmd:: --kes-config
:optional:
The name of the Kubernetes Secret which contains the MinIO Key Encryption Service (KES) configuration.
Required for enabling Server Side Encryption of objects (SSE-S3).
For more, see the `Github documentation <https://github.com/minio/operator/blob/master/examples/kes-secret.yaml>`__.
.. mc-cmd:: --kes-image
:optional:
.. versionadded:: v5.0.11
The KES image to use when deploying KES pods in the tenant.
.. important::
You cannot downgrade KES images after deployment.
.. mc-cmd:: --namespace
:optional:
The namespace in which to create the MinIO Tenant and its associated resources.
MinIO supports exactly *one* MinIO Tenant per namespace.
Create a unique namespace for each MinIO Tenant deployed into the cluster.
Defaults to ``minio``.
.. mc-cmd:: --output
:optional:
Dry run the command and generate the ``YAML``.
:mc-cmd:`~kubectl minio tenant create --output` does **not** create the MinIO Tenant.
Use ``kubectl apply -f <FILE>`` to manually create the MinIO tenant using the generated file.
.. mc-cmd:: --pool
:optional:
Assign a name for the pool added for the tenant.
.. mc-cmd:: --storage-class
:optional:
The type of storage to use for this tenant.
The name of the Kubernetes :kube-docs:`Storage Class <concepts/storage/storage-classes/>` to use when creating Persistent Volume Claims (``PVC``) for the MinIO Tenant.
The specified :mc-cmd:`~kubectl minio tenant create --storage-class` *must* match the ``storage-class`` of the Persistent Volumes (``PVs``) to which the ``PVCs`` should bind.
MinIO strongly recommends creating a Storage Class that corresponds to locally-attached volumes on the host machines on which the Tenant deploys.
This ensures each pod can use locally-attached storage for maximum performance and throughput.
See the :ref:`Deploy MinIO Tenant <minio-k8s-deploy-minio-tenant>` tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.
Defaults to ``default``.

99
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete.rst
View File

@ -1,99 +0,0 @@
.. _kubectl-minio-tenant-delete:
===============================
``kubectl minio tenant delete``
===============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant delete
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-delete-desc
Deletes the MinIO Tenant and its associated resources.
The delete behavior of each Persistent Volume Claims (``PVC``) generated by the Tenant depends on the :kube-docs:`Reclaim Policy <concepts/storage/persistent-volumes/#reclaim-policy>` of its bound Persistent Volume (``PV``):
- For ``recycle`` or ``delete`` policies, the command deletes the ``PVC``.
- For ``retain``, the command retains the ``PVC``.
Deletion of the underlying ``PV``, whether automatic or manual, results in the loss of any objects stored on the MinIO Tenant.
Perform all due diligence in ensuring the safety of stored data *prior* to deleting the tenant.
.. end-kubectl-minio-tenant-delete-desc
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example deletes a MinIO Tenant in the namespace ``minio-tenant-1``.
It keeps the namespace intact after deleting the tenant.
.. code-block:: shell
:class: copyable
kubectl minio tenant delete \
minio-tenant-1 \
--namespace minio-tenant-1 \
--retain-namespace
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant delete \
TENANT_NAME \
--force \
--namespace \
[--retain-namespace] \
Flags
-----
The command supports the following flags:
.. mc-cmd:: TENANT_NAME
:required:
The name of the MinIO tenant which the command deletes.
.. mc-cmd:: --force
:optional:
Forces the deletion of the tenant.
.. mc-cmd:: --namespace
:required:
The namespace scope to access.
.. mc-cmd:: --retain-namespace
:optional:
Keeps the namespace after deleting the tenant.
Omit to delete the namespace after deleting the tenant.
.. warning::
Deleting a namespace deletes all resources associated to that namespace.

156
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-expand.rst
View File

@ -1,156 +0,0 @@
.. _kubectl-minio-tenant-expand:
===============================
``kubectl minio tenant expand``
===============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant expand
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-expand-desc
Extends the total capacity of a MinIO Tenant by adding a new Pool.
A Pool consists of an independent set of pods running the MinIO Server and MinIO Console.
The new pool uses the same MinIO Server and Console Docker images as the existing Tenant pool(s).
.. end-kubectl-minio-tenant-expand-desc
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example expands a MinIO Tenant with a Pool consisting of 4 MinIO servers with 8 drives each and a total additional capacity of 32Ti:
.. code-block:: shell
:class: copyable
kubectl minio tenant expand \
minio-tenant-1 \
--servers 4 \
--volumes 8 \
--capacity 32Ti \
--namespace minio-tenant-1 \
--storage-class local-storage
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant expand \
TENANT_NAME \
--capacity \
--namespace \
--servers \
--volumes | --volumes-per-server \
[--output] \
[--pool] \
[--storage-class]
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Flags
-----
The command supports the following flags:
.. mc-cmd:: TENANT_NAME
:required:
The name of the MinIO tenant to expand.
.. mc-cmd:: --capacity
:optional:
The total capacity of the new MinIO Tenant Pool. :mc:`kubectl minio` divides the capacity by the number of :mc-cmd:`~kubectl minio tenant expand --volumes` to determine the
amount of ``resources.requests.storage`` to set for each Persistent Volume Claim (``PVC``).
If the existing Persistent Volumes (``PV``) can satisfy the requested storage, :mc:`kubectl minio tenant expand` hangs and waits until the required storage exists.
.. mc-cmd:: --servers
:required:
The number of ``minio`` servers to deploy in the new MinIO Tenant Pool.
Ensure that the specified number of :mc-cmd:`~kubectl minio tenant expand --servers` does *not* exceed the number of available nodes in the Kubernetes cluster.
.. mc-cmd:: --volumes
:required:
Mutually exclusive with :mc-cmd:`~kubectl minio tenant expand --volumes-per-server`.
Use either :mc-cmd:`~kubectl minio tenant expand --volumes` or :mc-cmd:`~kubectl minio tenant expand --volumes-per-server`.
The number of volumes in the new MinIO Tenant Pool.
:mc:`kubectl minio` generates one Persistent Volume Claim (``PVC``) for each volume.
The number of volumes affects both the requested storage of each ``PVC`` *and* the number of ``PVCs`` to associate to each MinIO Pod in the new Pool:
- The command :mc:`kubectl minio` divides the :mc-cmd:`~kubectl minio tenant expand --capacity` by the number of volumes to determine the amount of ``resources.requests.storage`` to set for each ``PVC``.
- :mc:`kubectl minio` determines the number of ``PVCs`` to associate to each ``minio`` server by dividing :mc-cmd:`~kubectl minio tenant expand --volumes` by :mc-cmd:`~kubectl minio tenant expand --servers`.
The command generates each ``PVC`` with Pod-specific selectors, such that each Pod only uses ``PVs`` that are locally-attached to the node running that Pod.
If the specified number of volumes exceeds the number of unbound ``PVs`` available in the cluster, :mc:`kubectl minio tenant expand` hangs and waits until the required ``PVs`` exist.
.. mc-cmd:: --volumes-per-server
:required:
Mutually exclusive with :mc-cmd:`~kubectl minio tenant expand --volumes`.
Use either :mc-cmd:`~kubectl minio tenant expand --volumes-per-server` or :mc-cmd:`~kubectl minio tenant expand --volumes`.
Number of volumes to use for each server in the pool.
Similar to :mc-cmd:`~kubectl minio tenant expand --volumes`, but instead of specifying the total number of volumes for all MinIO servers, associate ``--volumes-per-server`` volumes to each server.
If the combined total number of volumes exceeds the number of unbound ``PVs`` available on the cluster, :mc:`kubectl minio tenant expand` hangs and waits until the required ``PVs`` exist.
.. mc-cmd:: --namespace
:optional:
The namespace in which to create the new MinIO Tenant Pool.
The namespace *must* match that of the MinIO Tenant being extended.
Defaults to ``minio``.
.. mc-cmd:: --output
:optional:
Outputs the generated ``YAML`` objects to ``STDOUT`` for further customization.
:mc-cmd:`~kubectl minio tenant expand --output` does **not** create the new MinIO Tenant Pool.
Use ``kubectl apply -f <FILE>`` to manually create the MinIO tenant using the generated file.
.. mc-cmd:: --pool
:optional:
The name to assign to the pool created for this expansion.
.. mc-cmd:: --storage-class
:optional:
The name of the Kubernetes :kube-docs:`Storage Class <concepts/storage/storage-classes/>` to use when creating Persistent Volume Claims (``PVC``) for the new MinIO Tenant Pool.
The specified :mc-cmd:`~kubectl minio tenant expand --storage-class` *must* match the ``storage-class`` of the Persistent Volumes (``PVs``) to which the ``PVCs`` should bind.
MinIO strongly recommends creating a Storage Class that corresponds to locally-attached volumes on the host machines on which the Tenant deploys.
This ensures each pod can use locally-attached storage for maximum performance and throughput.
See the :ref:`Deploy MinIO Tenant <minio-k8s-deploy-minio-tenant>` tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.

105
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-info.rst
View File

@ -1,105 +0,0 @@
.. _kubectl-minio-tenant-info:
=============================
``kubectl minio tenant info``
=============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant info
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-info-desc
Displays information on a MinIO Tenant, including but not limited to:
- The total capacity of the Tenant
- The version of MinIO server and MinIO Console running on the Tenant
- The configuration of each Pool in the Tenant.
- The root user credentials for the Tenant.
.. end-kubectl-minio-tenant-info-desc
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example retrieves the information of the MinIO Tenant ``minio-tenant-1`` in the namespace ``minio-namespace-1``.
.. code-block:: shell
:class: copyable
kubectl minio tenant info \
minio-tenant-1 \
--namespace minio-namespace-1
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant info \
TENANT_NAME \
--namespace
Flags
-----
The command supports the following flag:
.. mc-cmd:: --namespace
:optional:
The namespace in which to look for the MinIO Tenant.
Defaults to ``minio``.
Example
-------
Display Tenant Details
~~~~~~~~~~~~~~~~~~~~~~
The following command outputs information for the Tenant ``minio-tenant`` in the namespace ``minio-ns``:
.. code-block:: shell
:class: copyable
kubectl minio tenant info \
minio-tenant \
--namespace minio-ns
The output resembles the following:
.. code-block:: shell
Tenant 'minio-tenant', Namespace 'minio-ns', Total capacity 16 GiB
Current status: Initialized
MinIO version: minio/minio:RELEASE.2023-06-23T20-26-00Z
MinIO service: minio/ClusterIP (port 443)
Console service: minio-tenant-console/ClusterIP (port 9443)
POOL SERVERS VOLUMES(SERVER) CAPACITY(VOLUME)
0 4 1 4.0 GiB
MinIO Root User Credentials:
MINIO_ROOT_USER="root_user"
MINIO_ROOT_PASSWORD="root_password"

45
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-list.rst
View File

@ -1,45 +0,0 @@
.. _kubectl-minio-tenant-list:
=============================
``kubectl minio tenant list``
=============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant list
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-list-desc
Displays a list of all of the tenants managed by the MinIO Operator.
.. end-kubectl-minio-tenant-list-desc
The output includes information for each tenant similar to the following:
- Tenant name
- Tenant's namespace
- Total capacity
- Current status
- MinIO version
Syntax
------
The command has the following syntax:
.. code-block:: shell
:class: copyable
kubectl minio tenant list

78
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-report.rst
View File

@ -1,78 +0,0 @@
.. _kubectl-minio-tenant-report:
===============================
``kubectl minio tenant report``
===============================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant report
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-report-desc
Saves pod logs from the MinIO Tenant and its associated resources.
.. end-kubectl-minio-tenant-report-desc
The logs output to a zip archive file.
When unzipped, the contents include three files for each pool:
- JSON formatted file listing events
- JSON formatted file listing the status
- Human readable log file
The folder also contains the yaml file for the tenant in ``TENANT_NAME.yaml``
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example creates a MinIO Tenant in the namespace ``minio-tenant-1`` consisting of 4 MinIO servers with 8 drives each and a total capacity of 32Ti.
.. code-block:: shell
:class: copyable
kubectl minio tenant report \
TENANT1 \
--namespace minio-namespace
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant report \
TENANT_NAME \
--namespace
Flags
-----
The command supports the following flags:
.. mc-cmd:: TENANT_NAME
:required:
The name of the MinIO tenant to expand.
.. mc-cmd:: --namespace
:optional:
The namespace in which to look for the MinIO Tenant.

90
source/reference/kubectl-minio-plugin/kubectl-minio-tenant-upgrade.rst
View File

@ -1,90 +0,0 @@
.. _kubectl-minio-tenant-upgrade:
================================
``kubectl minio tenant upgrade``
================================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant upgrade
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-tenant-upgrade-desc
Upgrades the ``minio`` server container image used by the MinIO Tenant.
.. end-kubectl-minio-tenant-upgrade-desc
.. important::
MinIO upgrades the image used by all pods in the Tenant at once.
Applications typically transparently retry operations against the MinIO Tenant, such that there should be no perceived downtime.
Test all upgrades in a staging environment, such as a separate MinIO Tenant, before applying to production tenants.
Syntax
------
.. tab-set::
.. tab-item:: EXAMPLE
The following example expands a MinIO Tenant with a Pool consisting of 4 MinIO servers with 8 drives each and a total additional capacity of 32Ti:
.. code-block:: shell
:class: copyable
:substitutions:
kubectl minio tenant upgrade \
minio-tenant-1 \
--image quay.io/minio/minio:|minio-latest|
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
kubectl minio tenant upgrade
TENANT_NAME \
--image \
--namespace \
[--output]
Flags
-----
The command supports the following flags:
.. mc-cmd:: TENANT_NAME
:required:
The name of the MinIO tenant to upgrade.
.. mc-cmd:: --image
:required:
The container image to use for upgrading the MinIO Tenant.
.. mc-cmd:: --namespace
:optional:
The namespace in which to look for the MinIO Tenant.
Defaults to ``minio``.
.. mc-cmd:: --output
:optional:
Displays the generated ``YAML`` objects, but does not upgrade the tenant.

52
source/reference/kubectl-minio-plugin/kubectl-minio-tenant.rst
View File

@ -1,52 +0,0 @@
.. _kubectl-minio-tenant:
========================
``kubectl minio tenant``
========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio tenant
Description
-----------
.. start-kubectl-minio-tenant-desc
:mc-cmd:`kubectl minio tenant` creates and manages tenants for the MinIO Operator.
.. end-kubectl-minio-tenant-desc
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
Subcommands
-----------
The :mc-cmd:`kubectl minio tenant` command includes the following subcommands:
- :mc-cmd:`~kubectl minio tenant create`
- :mc-cmd:`~kubectl minio tenant list`
- :mc-cmd:`~kubectl minio tenant info`
- :mc-cmd:`~kubectl minio tenant expand`
- :mc-cmd:`~kubectl minio tenant report`
- :mc-cmd:`~kubectl minio tenant upgrade`
- :mc-cmd:`~kubectl minio tenant delete`
.. toctree::
:titlesonly:
:hidden:
/reference/kubectl-minio-plugin/kubectl-minio-tenant-create
/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete
/reference/kubectl-minio-plugin/kubectl-minio-tenant-expand
/reference/kubectl-minio-plugin/kubectl-minio-tenant-info
/reference/kubectl-minio-plugin/kubectl-minio-tenant-list
/reference/kubectl-minio-plugin/kubectl-minio-tenant-report
/reference/kubectl-minio-plugin/kubectl-minio-tenant-upgrade

37
source/reference/kubectl-minio-plugin/kubectl-minio-version.rst
View File

@ -1,37 +0,0 @@
.. _kubectl-minio-version:
=========================
``kubectl minio version``
=========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: kubectl minio version
Description
-----------
.. include:: /includes/facts-kubectl-plugin.rst
:start-after: start-kubectl-minio-requires-operator-desc
:end-before: end-kubectl-minio-requires-operator-desc
.. start-kubectl-minio-version-desc
Displays the version number for the currently installed ``kubectl minio`` plugin.
.. end-kubectl-minio-version-desc
Syntax
------
The command has the following syntax:
.. code-block:: shell
:class: copyable
kubectl minio version

4
source/reference/minio-mc.rst
View File

@ -460,7 +460,7 @@ Configuration File
certain kinds of information, such as the :mc-cmd:`aliases <mc alias>` for
each configured S3-compatible service.
For Linux and OSX, the default configuration file location is
For Linux and macOS, the default configuration file location is
``~/.mc/config.json``.
For Windows, :mc-cmd:`mc` attempts to construct a default file path by trying
@ -482,7 +482,7 @@ Certificates
The MinIO Client stores certificates and CAs for deployments to the following paths:
Linux, MacOS, and other Unix-like systems:
Linux, macOS, and other Unix-like systems:
.. code-block:: shell

2
source/reference/minio-server/minio-server.rst
View File

@ -284,7 +284,7 @@ The command accepts the following arguments:
Omit to use the default directory paths:
- Linux/OSX: ``${HOME}/.minio/certs``
- Linux/macOS: ``${HOME}/.minio/certs``
- Windows: ``%%USERPROFILE%%\.minio\certs``.
See :ref:`minio-TLS` for more information on TLS/SSL connectivity.