Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Partial updates for Operator v5.0.7 docs #978

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Partial updates for Operator v5.0.7 docs #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d989d6
kubectl minio tenant info includes tenant root creds
feorlen Aug 30, 2023
3d1dc82
Delete Operator and all tenants without confirmation
feorlen Aug 30, 2023
4eea13b
review feedback
feorlen Aug 30, 2023
ea25d6d
Clarify related recommended PVC storage class retain policy
feorlen Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion source/operations/install-deploy-manage/deploy-minio-tenant.rst
View file
Open in desktop
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
View file
Open in desktop
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`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I recall correctly, this may also delete the PVC and PV underlying if the PVC retention isn't set to retain - https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reclaim-policy

Maybe worth warning here and confirming with someone on the K8s team that deleting tenants could trigger PVC cleaning.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 That could be an unexpected surprise. I'll follow up with k8s folks about it.

And in the meantime add an example for the other update.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pedro confirmed the PVC and PV aren't deleted, because finalizers. But added a note about setting the storage class retain policy to Retain for good measure.


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.
39 changes: 37 additions & 2 deletions source/reference/kubectl-minio-plugin/kubectl-minio-tenant-info.rst
View file
Open in desktop
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"