Skip to content

Commit cfaedc8

Browse files
authored
Minor fixes for several smaller issues (#1380)
- Adds missing config settings throughout storage class page. Closes #1349 - Adds instructions for adding certificates for connecting by sftp. Closes #1354 - Corrects information about which key to use for self-signed CAs. Closes #1358 - Moves `context` to optional for batch key rotate jobs. Closes #1356 - clean up missing ref links causing build warnings.
1 parent 774f4d5 commit cfaedc8

File tree

6 files changed

+62
-21
lines changed

6 files changed

+62
-21
lines changed

source/administration/batch-framework-job-keyrotate.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ Required Fields
4242
* - ``key:``
4343
- Only for use with the ``sse-kms`` type.
4444
The key to use to unseal the key vault.
45-
* - ``context:``
46-
- Only for use with the ``sse-kms`` type.
47-
The context within which to perform actions.
48-
4945

5046
Optional Fields
5147
~~~~~~~~~~~~~~~
@@ -73,6 +69,9 @@ For **flag based filters**
7369
- A date in ``YYYY-MM-DD`` format.
7470

7571
Keys rotate only for objects created prior to the date.
72+
* - ``context:``
73+
- Only for use with the ``sse-kms`` type.
74+
The context within which to perform actions.
7675
* - ``tags:``
7776
- Rotate keys only for objects with tags that match the specified ``key:`` and ``value:``.
7877
* - ``metadata:``

source/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ Procedure
110110

111111
This procedure requires repeating steps for each MinIO deployment participating in the multi-site replication configuration. Depending on the number of deployments, this procedure may require significant time and care in implementation. MinIO recommends reading through the procedure *before* attempting to implement the documented steps.
112112

113-
- :ref:`Configure Multi-Site Bucket Replication Using the Command Line <minio-bucket-replication-multi-site-minio-cli-procedure>`
114-
- :ref:`Create Replication Remote Targets <minio-bucket-replication-multi-site-minio-cli-create-remote-targets>`
113+
- Configure Multi-Site Bucket Replication Using the Command Line
114+
115115
- :ref:`Create New Bucket Replication Rules <minio-bucket-replication-multi-site-minio-cli-create-replication-rules>`
116116
- :ref:`Validate the Replication Configuration <minio-bucket-replication-multi-site-minio-cli-verify-replication-config>`
117117

@@ -129,8 +129,6 @@ This procedure assumes each alias corresponds to a user with the :ref:`necessary
129129
:mc:`mc replicate add` automatically creates the necessary replication targets, removing the need for using the deprecated ``mc admin remote bucket add`` command.
130130
This procedure only documents the procedure as of that release.
131131

132-
.. _minio-bucket-replication-multi-site-minio-cli-create-remote-targets:
133-
134132
.. _minio-bucket-replication-multi-site-minio-cli-create-replication-rules:
135133

136134
1) Create New Bucket Replication Rules

source/administration/minio-console.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ Once logged in to the MinIO Console, users can perform many kinds of tasks.
151151
- :ref:`Manage objects <minio-console-managing-objects>` by browsing existing objects, uploading objects, or modifying bucket settings.
152152
- :ref:`Review or modify identity and security <minio-console-security-access>` with access keys, policies, and Identity Provider settings.
153153
- :ref:`Monitor the health and activities <minio-console-managing-deployment>` with metrics and notifications.
154-
- :ref:`Manage your deployment's license <minio-console-subscription>`
155154

156155
.. toctree::
157156
:titlesonly:

source/includes/linux/file-transfer-protocol-not-k8s.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,52 @@ Once the MinIO Server verifies the client's certificate, the user can connect to
273273
274274
sftp -P <SFTP port> <server IP>
275275
276+
277+
Procedure
278+
+++++++++
279+
280+
The following procedure generates two key-value pairs, signs one with the other, then uses the resulting signed key to log in to the SFTP server.
281+
282+
1. Generate a key-value pair for the MinIO Server
283+
284+
.. code-block:: bash
285+
:class: copyable
286+
287+
ssh-keygen -f ./ca_user_key
288+
289+
2. Generate a key-value pair for the user
290+
291+
.. code-block:: bash
292+
:class: copyable
293+
294+
ssh-keygen -f ./minioadmin
295+
296+
Replace ``minioadmin`` with the user accessing the MinIO Server by SFTP.
297+
298+
3. Sign the user key-value pair key with the MinIO Server key-value pair key
299+
300+
.. code-block:: bash
301+
:class: copyable
302+
303+
ssh-keygen -s ca_user_key -I minioadmin -n minioadmin -V +30d -z 1 minioadmin.pub
304+
305+
Move the ``minioadmin.pub`` key to the same directory as ``minioadmin`` key-value pair, such as ``~/.ssh/meaningful-directory``.
306+
307+
4. Start or restart the MinIO Server passing the generated public keys
308+
309+
.. code-block:: bash
310+
:class: copyable
311+
312+
minio server --sftp="address=:8022" --sftp="ssh-private-key=/path/to/ca_user_key" --sftp="trusted-user-ca-key=/path/to/ca_user_key.pub"
313+
314+
5. Connect to the MinIO Server by sftp
315+
316+
.. code-block:: bash
317+
:class: copyable
318+
319+
sftp -i ./minioadmin -oPort=8022 minioadmin@localhost
320+
321+
276322
Require service account or LDAP for authentication
277323
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278324

source/operations/network-encryption.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,13 @@ Self-signed, Internal, Private Certificates, and Public CAs with Intermediate Ce
585585
586586
mv myCA.crt /opt/minio/certs/CAs/
587587
588-
For a self-signed certificate, the Certificate Authority is typically the private key used to sign the cert.
588+
.. important::
589+
590+
Do not use or share the private key of the self-signed certificate.
591+
Only the public certificate should be shared or distributed for trust purposes.
592+
593+
For certificates signed by an internal, private, or other non-global Certificate Authority, use the same CA that signed the cert.
594+
A non-global CA must include the full chain of trust from the intermediate certificate to the root.
589595

590596
For certificates signed by an internal, private, or other non-global Certificate Authority, use the same CA that signed the cert.
591597
A non-global CA must include the full chain of trust from the intermediate certificate to the root.
@@ -621,7 +627,3 @@ Self-signed, Internal, Private Certificates, and Public CAs with Intermediate Ce
621627
:class: copyable
622628
623629
kubectl rollout restart deployments.apps/minio-operator -n minio-operator
624-
625-
626-
627-

source/reference/minio-server/settings/storage-class.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ Standard Storage Class
4444
.. tab-item:: Configuration Setting
4545
:sync: config
4646

47-
.. include:: /includes/common-mc-admin-config.rst
48-
:start-after: start-minio-settings-no-config-option
49-
:end-before: end-minio-settings-no-config-option
47+
.. mc-conf:: storage_class standard
48+
:delimiter: " "
5049

5150
The :ref:`parity level <minio-ec-parity>` for the deployment.
5251
MinIO shards objects written with the default ``STANDARD`` storage class using this parity value.
@@ -113,9 +112,8 @@ Reduced Redundancy Storage Class
113112
.. tab-item:: Configuration Setting
114113
:sync: config
115114

116-
.. include:: /includes/common-mc-admin-config.rst
117-
:start-after: start-minio-settings-no-config-option
118-
:end-before: end-minio-settings-no-config-option
115+
.. mc-conf:: storage_class rrs
116+
:delimiter: " "
119117

120118
The :ref:`parity level <minio-ec-parity>` for objects written with the ``REDUCED`` storage class.
121119

@@ -133,7 +131,6 @@ Defaults to ``EC:0`` for deployments of erasure set size of 1.
133131
Parity Retention Optimization
134132
-----------------------------
135133

136-
137134
.. tab-set::
138135

139136
.. tab-item:: Environment Variable

0 commit comments

Comments
 (0)