mirror of
https://github.com/minio/docs.git
synced 2025-08-06 14:42:56 +03:00
a7acdcdfe8
Closes #1076 Smaller than I expected, and a few things I don't think we need to document. Staged: - http://192.241.195.202:9000/staging/DOCS-1076/k8s/developers/sts-for-operator.html - http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.html#kubectl.minio.tenant.create.-kes-image - http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete.html#kubectl.minio.tenant.delete.-retain-namespace - http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/operator-environment-variables.html --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com> Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
99 lines
2.6 KiB
ReStructuredText
99 lines
2.6 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 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. |