1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Files
docs/source/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete.rst
2022-06-15 13:34:04 -05:00

85 lines
2.2 KiB
ReStructuredText

.. _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.