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

Jump to bottom

DOCS-1159: RELEASE.2024-03-15T01-07-19Z #1211

Merged
merged 2 commits into from
May 9, 2024
Merged

DOCS-1159: RELEASE.2024-03-15T01-07-19Z #1211

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
355594b
DOCS-1159: RELEASE.2024-03-15T01-07-19Z
ravindk89 May 8, 2024
abddb0c
Apply suggestions from code review
ravindk89 May 9, 2024
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
2 changes: 1 addition & 1 deletion source/operations/concepts/thresholds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ S3 API Limits
* - Maximum length for each ``/`` separated object name segment
- 255

* - Maximum number of object verions for a unique object
* - Maximum number of object versions for a unique object
- 10000 (Configurable)

Erasure Code Limits
Expand Down
121 changes: 71 additions & 50 deletions source/reference/minio-server/settings/core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This page covers settings that control core behavior of the MinIO process.
:start-after: start-minio-settings-test-before-prod
:end-before: end-minio-settings-test-before-prod

MinIO Options
~~~~~~~~~~~~~
MinIO Server CLI Options
------------------------

.. tab-set::

Expand All @@ -47,12 +47,9 @@ For example, to set up ftp access, you could set the variable to something like

On Unix-like systems, you can save a file with the environment variable to ``/etc/defaults/minio`` instead of setting the variable manually.

Common Settings
Storage Volumes
---------------

Volumes
~~~~~~~

.. tab-set::

.. tab-item:: Environment Variable
Expand All @@ -71,7 +68,7 @@ Volumes
:end-before: end-minio-settings-no-config-option

Environment Variable File Path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------

.. tab-set::

Expand All @@ -90,7 +87,7 @@ Environment Variable File Path
:end-before: end-minio-settings-no-config-option

Workers for Expiration
~~~~~~~~~~~~~~~~~~~~~~
----------------------

.. tab-set::

Expand All @@ -110,7 +107,7 @@ Workers for Expiration
:end-before: end-minio-settings-no-config-option

Domain
~~~~~~
------

.. tab-set::

Expand Down Expand Up @@ -145,7 +142,7 @@ Domain
.. _minio-scanner-speed-options:

Scanner Speed
~~~~~~~~~~~~~
-------------

.. tab-set::

Expand Down Expand Up @@ -196,74 +193,55 @@ All of the settings in this section fall under the following top-level key:

.. mc-conf:: compression

Allow Encryption
~~~~~~~~~~~~~~~~
Enable Compression
~~~~~~~~~~~~~~~~~~

.. tab-set::

.. tab-item:: Environment Variable
:sync: envvar

.. envvar:: MINIO_COMPRESSION_ALLOW_ENCRYPTION
.. envvar:: MINIO_COMPRESSION_ENABLE

.. tab-item:: Configuration Setting
:sync: config

.. mc-conf:: compression allow_encryption
.. mc-conf:: compression enable
:delimiter: " "

*Optional*

Set to ``on`` to encrypt objects after compressing them.
Set to ``on`` to enable data compression for new objects.
Defaults to ``off``.

.. admonition:: Encrypting compressed objects may compromise security
:class: warning

MinIO strongly recommends against encrypting compressed objects.
If you require encryption, carefully evaluate the risk of potentially leaking information about the contents of encrypted objects.
Enabling or disabling data compression does not change existing objects.

Enable Compression
~~~~~~~~~~~~~~~~~~
Allow Encryption
~~~~~~~~~~~~~~~~

.. tab-set::

.. tab-item:: Environment Variable
:sync: envvar

.. envvar:: MINIO_COMPRESSION_ENABLE
.. envvar:: MINIO_COMPRESSION_ALLOW_ENCRYPTION

.. tab-item:: Configuration Setting
:sync: config

.. mc-conf:: compression enable
.. mc-conf:: compression allow_encryption
:delimiter: " "

*Optional*

Set to ``on`` to enable data compression for new objects.
Set to ``on`` to encrypt objects after compressing them.
Defaults to ``off``.

Enabling or disabling data compression does not change existing objects.

Comments
~~~~~~~~

.. tab-set::

.. tab-item:: Environment Variable

This setting does not have an environment variable option.
Use the configuration variable instead.

.. tab-item:: Configuration Setting
:selected:

.. envvar:: compression comment

*Optional*
.. admonition:: Encrypting compressed objects may compromise security
:class: warning

Specify a comment to associate with the data compression configuration.
MinIO strongly recommends against encrypting compressed objects.
If you require encryption, carefully evaluate the risk of potentially leaking information about the contents of encrypted objects.

Compression Extensions
~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -287,12 +265,11 @@ Comma-separated list of the file extensions to compress.
Setting a new list of file extensions replaces the previously configured list.
Defaults to ``".txt, .log, .csv, .json, .tar, .xml, .bin"``.

.. admonition:: Default excluded files
:class: note
.. versionchanged:: RELEASE.2024-03-15T01-07-19Z

Some types of files cannot be significantly reduced in size.
MinIO will *not* compress these, even if specified in an :mc-conf:`~compression.extensions` argument.
See :ref:`Excluded types <minio-data-compression-excluded-types>` for details.
Specify ``"*"`` to direct MinIO to compress all supported file types.

MinIO does not support compressing file types on the :ref:`Excluded File Types <minio-data-compression-excluded-types>` list, even if explicitly specified in this argument.

Compression MIME Types
~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -323,8 +300,27 @@ Defaults to ``"text/*, application/json, application/xml, binary/octet-stream"``
MinIO will *not* compress these, even if specified in an :mc-conf:`~compression.mime_types` argument.
See :ref:`Excluded types <minio-data-compression-excluded-types>` for details.

Comments
~~~~~~~~

.. tab-set::

.. tab-item:: Environment Variable

This setting does not have an environment variable option.
Use the configuration variable instead.
ravindk89 marked this conversation as resolved.
Show resolved Hide resolved

.. tab-item:: Configuration Setting
:selected:

.. envvar:: compression comment

*Optional*

Specify a comment to associate with the data compression configuration.

Erasure Stripe Size
~~~~~~~~~~~~~~~~~~~
-------------------

.. tab-set::

Expand Down Expand Up @@ -357,5 +353,30 @@ The selected stripe size is **immutable** after the cluster has been initialized
MinIO's stripe selection algorithms set appropriate defaults for the majority of workloads.
Changing the stripe size from this default is unusual and generally not necessary or advised.

Maximum Object Versions
-----------------------

.. tab-set::

.. tab-item:: Environment Variable
:sync: envvar

.. envvar:: MINIO_API_OBJECT_MAX_VERSIONS

.. tab-item:: Configuration Variable
ravindk89 marked this conversation as resolved.
Show resolved Hide resolved
:sync: config

.. mc-conf:: api object_max_versions
:delimiter: " "

*Optional*

Overrides the default maximum version per object limit of ``10000`` with the user specified value.

.. important::

The default limit of 10,000 provides a safety valve against incorrect or inefficient application behavior in versioned buckets.
Lifting this limit without first ensuring application's are designed for versioned operations may result in a negative performance impact over time.
ravindk89 marked this conversation as resolved.
Show resolved Hide resolved



Loading