Skip to content

Commit

Permalink
Partial updates for Operator v5.0.7 docs (#978)
Browse files Browse the repository at this point in the history
  • Loading branch information
feorlen authored Aug 31, 2023
1 parent 1fae334 commit 33b2882
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ Persistent Volumes

MinIO can use any Kubernetes :kube-docs:`Persistent Volume (PV) <concepts/storage/persistent-volumes>` that supports the :kube-docs:`ReadWriteOnce <concepts/storage/persistent-volumes/#access-modes>` access mode.
MinIO's consistency guarantees require the exclusive storage access that ``ReadWriteOnce`` provides.
Additionally, MinIO recommends setting a reclaim policy of ``Retain`` for the PVC :kube-docs:`StorageClass <concepts/storage/storage-classes>`.

For Kubernetes clusters where nodes have Direct Attached Storage, MinIO strongly recommends using the `DirectPV CSI driver <https://min.io/directpv?ref=docs>`__.
DirectPV provides a distributed persistent volume manager that can discover, format, mount, schedule, and monitor drives across Kubernetes nodes.
Expand Down Expand Up @@ -769,4 +770,4 @@ Kubernetes provides multiple options for configuring external access to services

.. cond:: k8s and not (openshift or eks)

.. include:: /includes/k8s/steps-deploy-tenant-cli.rst
.. include:: /includes/k8s/steps-deploy-tenant-cli.rst
19 changes: 17 additions & 2 deletions source/reference/kubectl-minio-plugin/kubectl-minio-delete.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ Syntax

.. code-block:: shell
kubectl minio delete \
--namespace
kubectl minio delete \
--namespace \
[--force --dangerous]

Flags
-----
Expand All @@ -67,3 +68,17 @@ The command supports the following flags:

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.
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,15 @@ 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``.
Expand All @@ -44,7 +45,7 @@ Syntax
kubectl minio tenant info \
minio-tenant-1 \
--namespace minio-namespace-1
--namespace minio-namespace-1
.. tab-item:: SYNTAX

Expand All @@ -68,3 +69,37 @@ The command supports the following flag:
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"

0 comments on commit 33b2882

Please sign in to comment.