mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
Adding kubectl ref docs
This commit is contained in:
Daryl White
@ -0,0 +1,69 @@
|
||||
|
||||
.. _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
|
||||
|
||||
Flags
|
||||
-----
|
||||
|
||||
The command supports the following flags:
|
||||
|
||||
.. mc-cmd:: --namespace
|
||||
:required:
|
||||
|
||||
The namespace of the operator to delete.
|
||||
|
||||
Defaults to ``minio-operator``.
|
||||
|
||||
150
source/reference/kubectl-minio-plugin/kubectl-minio-init.rst
Normal file
150
source/reference/kubectl-minio-plugin/kubectl-minio-init.rst
Normal file
@ -0,0 +1,150 @@
|
||||
|
||||
.. _kubectl-minio-init:
|
||||
|
||||
=========================
|
||||
``kubectl minio init``
|
||||
=========================
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. mc:: kubectl minio init
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
.. start-kubectl-minio-init-desc
|
||||
|
||||
The :mc:`kubectl minio init` command initializes the MinIO Operator.
|
||||
:mc:`kubectl minio init` requires the operator for core functionality.
|
||||
|
||||
.. end-kubectl-minio-init-desc
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLE
|
||||
|
||||
The following command initializes a new MinIO Operator deployment using operator v4.4.22, on the ``minio-operator`` namespace, using the cluster domain of ``cluster.local`` and watching the default namespace.:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
kubectl minio init \
|
||||
--image=minio/operator:v4.4.22 \
|
||||
--namespace=minio-operator \
|
||||
--cluster-domain=cluster.local \
|
||||
--namespace-to-watch=default \
|
||||
--image-pull-secret=
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
The command has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
kubectl minio init \
|
||||
[--cluster-domain] \
|
||||
[--console-image] \
|
||||
[--default-console-image] \
|
||||
[--default-kes-image] \
|
||||
[--default-minio-image] \
|
||||
[--image] \
|
||||
[--image-pull-secret] \
|
||||
[--namespace] \
|
||||
[--namespace-to-watch] \
|
||||
[--output] \
|
||||
[--prometheus-name] \
|
||||
[--prometheus-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:: --cluster-domain
|
||||
:optional:
|
||||
|
||||
The domain name to use when configuring the DNS hostname of the operator.
|
||||
Defaults to ``cluster.local``.
|
||||
|
||||
.. mc-cmd:: --console-image
|
||||
:optional:
|
||||
|
||||
The image to use when deploying the :minio-git:`MinIO Console <console>` in Operator mode, where administrators can create and manage MinIO tenants using a Graphical User Interface.
|
||||
Defaults to ``minio/console:v0.17.3``.
|
||||
|
||||
.. mc-cmd:: --default-console-image
|
||||
:optional:
|
||||
|
||||
The default :minio-git:`MinIO Console <console>` image to use when creating a new MinIO tenant.
|
||||
Defaults to ``minio/console:v0.17.3``.
|
||||
|
||||
.. mc-cmd:: --default-kes-image
|
||||
:optional:
|
||||
|
||||
The default :minio-git:`kes <kes>` image to use when creating a new MinIO tenant.
|
||||
Defaults to ``minio/kes:v0.18.0``.
|
||||
|
||||
.. mc-cmd:: --default-minio-image
|
||||
:optional:
|
||||
|
||||
The default :minio-git:`minio <minio>` image to use when creating a new MinIO tenant.
|
||||
Defaults to ``minio/minio:RELEASE.2022-05-26T05-48-41Z``.
|
||||
|
||||
.. mc-cmd:: --image
|
||||
:optional:
|
||||
|
||||
The image to use for deploying the operator.
|
||||
Defaults to the :minio-git:`latest release of the operator <operator/releases/latest>`.
|
||||
|
||||
.. mc-cmd:: --image-pull-secret
|
||||
:optional:
|
||||
|
||||
Secret key for use with pulling the :mc-cmd:`~kubectl minio init --image`.
|
||||
|
||||
The MinIO-hosted ``minio/k8s-operator`` image is *not* password protected.
|
||||
This option is only required for non-MinIO image sources which are password protected.
|
||||
|
||||
.. mc-cmd:: --namespace
|
||||
:optional:
|
||||
|
||||
The namespace into which to deploy the operator.
|
||||
Defaults to ``minio-operator``.
|
||||
|
||||
.. mc-cmd:: --namespace-to-watch
|
||||
:optional:
|
||||
|
||||
The namespace which the operator watches for MinIO tenants.
|
||||
Defaults to ``""`` for *all namespaces*.
|
||||
|
||||
.. mc-cmd:: --output
|
||||
:optional:
|
||||
|
||||
Performs a dry run and outputs the generated YAML to ``STDOUT``.
|
||||
Use this option to customize the YAML and apply it manually using ``kubectl apply -f <FILE>``.
|
||||
|
||||
.. mc-cmd:: --prometheus-name
|
||||
:optional:
|
||||
|
||||
The name of the Prometheus service managed by the Prometheus Operator.
|
||||
Defaults to ``PROMETHEUS_NAME``
|
||||
|
||||
.. mc-cmd:: --prometheus-namespace
|
||||
:optional:
|
||||
|
||||
The namespace into which to deploy Prometheus.
|
||||
Defaults to ``PROMETHEUS_NAMESPACE``
|
||||
@ -0,0 +1,72 @@
|
||||
|
||||
.. _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 <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
|
||||
|
||||
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.
|
||||
Defaults to ``minio-operator``.
|
||||
@ -0,0 +1,191 @@
|
||||
|
||||
.. _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 <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 \
|
||||
[--enable-host-sharing] \
|
||||
[--image] \
|
||||
[--image-pull-secret] \
|
||||
[--kes-config] \
|
||||
[--namespace] \
|
||||
[--output] \
|
||||
[--storage-class]
|
||||
|
||||
|
||||
Flags
|
||||
-----
|
||||
|
||||
The command supports the following flags:
|
||||
|
||||
.. 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:
|
||||
|
||||
Total number of volumes to use in the MinIO tenant.
|
||||
|
||||
: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 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`.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
.. mc-cmd:: --enable-host-sharing
|
||||
:optional:
|
||||
|
||||
.. important::
|
||||
|
||||
To be used in testing environments only.
|
||||
This flag is **not** supported in production environments.
|
||||
|
||||
Disable pod anti-affinity to allow co-location of pods on a single node.
|
||||
|
||||
.. 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:: --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:: --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 <deploy-minio-tenant>` tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.
|
||||
|
||||
Defaults to ``default``.
|
||||
@ -0,0 +1,85 @@
|
||||
|
||||
.. _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 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 delete \
|
||||
minio-tenant-1 \
|
||||
--namespace minio-tenant-1
|
||||
|
||||
.. tab-item:: SYNTAX
|
||||
|
||||
The command has the following syntax:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
kubectl minio tenant delete \
|
||||
TENANT_NAME \
|
||||
--force \
|
||||
--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.
|
||||
@ -0,0 +1,131 @@
|
||||
|
||||
.. _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 \
|
||||
--servers \
|
||||
--volumes \
|
||||
--namespace \
|
||||
[--output] \
|
||||
[--storage-class]
|
||||
|
||||
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:
|
||||
|
||||
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 ``PVC`` 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 ``PVC`` 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.
|
||||
|
||||
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.
|
||||
|
||||
.. 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:: --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 <deploy-minio-tenant>` tutorial for guidance on creating Storage Classes for supporting the MinIO Tenant.
|
||||
@ -0,0 +1,70 @@
|
||||
|
||||
.. _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.
|
||||
|
||||
.. 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``.
|
||||
@ -0,0 +1,45 @@
|
||||
|
||||
.. _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
|
||||
@ -0,0 +1,78 @@
|
||||
|
||||
.. _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.
|
||||
@ -0,0 +1,90 @@
|
||||
|
||||
.. _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.
|
||||
@ -0,0 +1,52 @@
|
||||
|
||||
.. _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
|
||||
@ -0,0 +1,37 @@
|
||||
.. _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
|
||||
Reference in New Issue
Block a user