minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Code Activity

New kubectl minio flags (#1171)

Browse Source 
New option `--volumes-per-server` for `kubectl minio tenant create` and
`kubectl minio tenant expand`.

Staged


http://192.241.195.202:9000/staging/DOCS-1129-kubectl/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.html#kubectl.minio.tenant.create.-volumes

http://192.241.195.202:9000/staging/DOCS-1129-kubectl/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-expand.html#kubectl.minio.tenant.expand.-volumes

Partly addresses https://github.com/minio/docs/issues/1129
This commit is contained in:
Andrea Longo
2024-04-01 16:14:09 -06:00
committed by GitHub
parent 8b5be57ee3
commit b0ab2be7ba
2 changed files with 77 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -70,25 +70,29 @@ Syntax
.. code-block:: shell .. code-block:: shell
kubectl minio tenant create \ kubectl minio tenant create \
TENANT_NAME \ TENANT_NAME \
[--interactive] \ [--interactive] \
[--disable-tls] \ [--disable-tls] \
[--enable-audit-logs] \ [--enable-audit-logs] \
[--enable-prometheus] \ [--enable-prometheus] \
[--expose-console-service] \ [--expose-console-service] \
[--expose-minio-service] \ [--expose-minio-service] \
[--image] \ [--image] \
[--image-pull-secret] \ [--image-pull-secret] \
[--kes-config] \ [--kes-config] \
[--kes-image] \ [--kes-image] \
[--namespace] \ [--namespace] \
[--output] \ [--output] \
[--pool] \ [--pool] \
[--storage-class] \ [--storage-class] \
--capacity \ --capacity \
--servers \ --servers \
--volumes \ --volumes | --volumes-per-server \
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Flags Flags
@@ -139,19 +143,33 @@ The command supports the following flags:
.. mc-cmd:: --volumes .. mc-cmd:: --volumes
:required: :required:
Total number of volumes to use in the MinIO tenant. 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`.
: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 ``PVC`` to associate to each MinIO Pod in the cluster: 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``. - 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 ``PVC`` to associate to each ``minio`` server by dividing :mc-cmd:`~kubectl minio tenant create --volumes` by :mc-cmd:`~kubectl minio tenant create --servers`. - :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 ``PV`` that are locally-attached to the node running that Pod. 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 ``PV`` available on the cluster, :mc:`kubectl minio tenant create` hangs and waits until the required ``PV`` exist. 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 total number of volumes (:mc-cmd:`~kubectl minio tenant create --volumes-per-server` multiplied by :mc-cmd:`~kubectl minio tenant create --servers`) 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 .. mc-cmd:: --disable-tls
:optional: :optional:

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

@@ -54,15 +54,19 @@ Syntax
.. code-block:: shell .. code-block:: shell
kubectl minio tenant expand \ kubectl minio tenant expand \
TENANT_NAME \ TENANT_NAME \
--capacity \ [--output] \
--servers \ [--pool] \
--volumes \
--namespace \
[--output] \
[--pool] \
[--storage-class] [--storage-class]
--capacity \
--servers \
--volumes | --volumes-per-server \
--namespace
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Flags Flags
----- -----
@@ -92,18 +96,33 @@ The command supports the following flags:
.. mc-cmd:: --volumes .. mc-cmd:: --volumes
:required: :required:
The number of volumes in the new MinIO Tenant Pool. 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. :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 ``PVC`` to associate to each MinIO Pod in the new Pool: 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``. - 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 ``PVC`` to associate to each ``minio`` server by dividing :mc-cmd:`~kubectl minio tenant expand --volumes` by :mc-cmd:`~kubectl minio tenant expand --servers`. - :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 ``PV`` that are locally-attached to the node running that Pod. 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 ``PV`` available in the cluster, :mc:`kubectl minio tenant expand` hangs and waits until the required ``PV`` exist. 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 total number of volumes (:mc-cmd:`~kubectl minio tenant expand --volumes-per-server` multiplied by :mc-cmd:`~kubectl minio tenant expand --servers`) 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 .. mc-cmd:: --namespace
:optional: :optional:
@@ -134,4 +153,4 @@ The command supports the following flags:
MinIO strongly recommends creating a Storage Class that corresponds to locally-attached volumes on the host machines on which the Tenant deploys. 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. 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. See the :ref:`Deploy MinIO Tenant <minio-k8s-deploy-minio-tenant>` tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.