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.

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

DOCS-1021: Adding helm information #1060

Merged
merged 9 commits into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,9 @@ sync-operator-version:
;; \
esac

@echo "Updating Helm Charts"
# @$(shell curl --retry 10 -Ls -o source/includes/k8s/operator-values.yaml https://raw.githubusercontent.com/minio/operator/v${OPERATOR}/helm/operator/values.yaml)

sync-kes-version:
@echo "Retrieving latest stable KES version"
@$(eval KES = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/kes/releases/latest | sed "s/https:\/\/github.com\/minio\/kes\/releases\/tag\///"))
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Sphinx-Substitution-Extensions == 2020.9.30.0
sphinx-sitemap == 2.5.0
sphinx-togglebutton === 0.3.2
sphinxcontrib-images === 0.9.4
sphinxcontrib-autoyaml === 1.1.1
sphinx_reredirects === 0.1.2
myst-parser === 1.0.0
linkify === 1.4
Expand Down
5 changes: 5 additions & 0 deletions source/default-conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
'sphinx_design',
'sphinx.ext.intersphinx',
'sphinx_reredirects',
'sphinxcontrib.autoyaml',
]

# -- External Links
Expand Down Expand Up @@ -204,6 +205,10 @@
}


# sphinxcontrib-autoyaml customization

autoyaml_level = 5

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
50 changes: 4 additions & 46 deletions source/includes/k8s/deploy-operator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ Prerequisites
Kubernetes Version 1.19.0
~~~~~~~~~~~~~~~~~~~~~~~~~

.. important::

MinIO **strongly recommends** upgrading Production clusters running `End-Of-Life <https://kubernetes.io/releases/patch-releases/#non-active-branch-history>`__ Kubernetes APIs.

Starting with v4.0.0, the MinIO Operator and MinIO Kubernetes Plugin **require** Kubernetes 1.19.0 and later.
The Kubernetes infrastructure *and* the ``kubectl`` CLI tool must have the same version of 1.19.0+.

Expand Down Expand Up @@ -155,52 +159,6 @@ The output of the example command above may differ from the output in your termi
Alternatively, you can generate x.509 TLS certificates signed by a known and trusted CA and pass those certificates to MinIO Tenants.
See :ref:`minio-tls` for more complete documentation.

Configure MinIO Operator to Trust Custom Certificates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you use custom certificates for your deployment, add the certificate so that MinIO Operator trusts it.

This procedure assumes you have an existing custom certificate.

1. Use the following command to generate a secret from the certificate:

.. code-block:: shell
:class: copyable

kubectl create secret generic MY-CUSTOM-TLS -n MY-CLUSTER-NAMESPACE --from-file=<path/to/public.crt>

Replace the following placeholders in the above command:
- ``MY-CUSTOM-TLS`` with the name of your secrets file
- ``MY-CLUSTER-NAMESPACE`` with your cluster's namespace
- ``<path/to/public.crt>`` with the relative path to the public certificate to use to create the secret

2. Add a volume to the yaml for your cluster under ``.spec.template.spec``

.. code-block:: yaml
:class: copyable

volumes:
- name: tls-certificates
projected:
defaultMode: 420
sources:
- secret:
items:
- key: public.crt
path: CAs/custom-public.crt
name: MY-CUSTOM-TLS

- replace ``MY-CUSTOM-TLS`` with the name of your secrets file.

3. Add a ``volumeMount`` to the yaml for your cluster under ``.spec.template.spec.container[0]``

.. code-block:: yaml
:class: copyable

volumeMounts:
- mountPath: /tmp/certs
name: tls-certificates

Procedure
---------

Expand Down
Loading