diff --git a/.github/ISSUE_TEMPLATE/doc-change.md b/.github/ISSUE_TEMPLATE/doc-change.md new file mode 100644 index 000000000..35a7a09d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc-change.md @@ -0,0 +1,17 @@ +--- +name: Documentation update issue +about: Opening a new issue to update the documentation after a PR submission in other projects +title: '' +labels: 'doc-change' +assignees: '' + +--- + +Opening a new issue to document a new feature/change. + +The reference PR is in the title, kindly make sure that the PR is +approved and merged first. + +If the feature/change is not yet merged to latest stable, leave the PR in the RFM state and merge/publish only when we have a new release of the related product. +Ping the PR owner if you have further questions about the documentation change. + diff --git a/.gitignore b/.gitignore index 9f1bd19ee..f3f362bbf 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,5 @@ main.min.css main.css objects.inv output.log -.DS_Store \ No newline at end of file +.DS_Store +source/conf.py diff --git a/Makefile b/Makefile index fb3d1c5c2..10a202731 100644 --- a/Makefile +++ b/Makefile @@ -29,13 +29,13 @@ clean: sync-minio-version: @echo "Retrieving current MinIO version" $(shell wget -O /tmp/downloads-minio.json https://min.io/assets/downloads-minio.json) - $(eval DEB = $(shell cat /tmp/downloads-minio.json | jq '.Linux."MinIO Server".amd64.DEB.download')) - $(eval RPM = $(shell cat /tmp/downloads-minio.json | jq '.Linux."MinIO Server".amd64.RPM.download')) + $(eval DEB = $(shell cat /tmp/downloads-minio.json | jq '.Linux."MinIO Server".amd64.DEB.download' | sed "s|linux-amd64|linux-amd64/archive|g")) + $(eval RPM = $(shell cat /tmp/downloads-minio.json | jq '.Linux."MinIO Server".amd64.RPM.download' | sed "s|linux-amd64|linux-amd64/archive|g")) $(eval MINIO = $(shell curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio/releases/latest | sed "s/https:\/\/github.com\/minio\/minio\/releases\/tag\///")) @cp source/default-conf.py source/conf.py - @kname=$(uname -s) + @$(eval kname = $(shell uname -s)) @case "${kname}" in \ Darwin) \ sed -i "" "s|MINIOLATEST|${MINIO}|g" source/conf.py; \ @@ -49,13 +49,6 @@ sync-minio-version: ;; \ esac - @if [ "$(shell git diff --name-only | grep 'conf.py')" == "" ]; then \ - echo "MinIO Server Version already latest"; \ - else \ - echo "New MinIO Server Version available" ; \ - git add source/conf.py && git commit -m "Updating MinIO server to ${MINIO}"; \ - fi - sync-java-docs: @echo "Retrieving Java docs from github.com/minio/minio-java" @$(eval LATEST = $(shell wget -q https://api.github.com/repos/minio/minio-java/releases/latest -O - | jq -r '.tag_name')) @@ -89,12 +82,15 @@ sync-deps: @make sync-dotnet-docs stage: - @make clean && make html + @make clean + @make sync-minio-version + @make html python -m http.server --directory $(BUILDDIR)/$(GITDIR)/html publish: @make clean - make html + @make sync-minio-version + @make html # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/README.md b/README.md index 397905cec..ba4a69cf7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ static HTML pages using ReSTructured Text (rST). ### Linux -1. Run `git checkout https://github.com/minio/docs` and `cd docs` to move into +1. Run `git clone https://github.com/minio/docs` and `cd docs` to move into the working directory. 2. Create a new virtual environment `python3 -m venv venv`. Activate it using @@ -37,7 +37,7 @@ static HTML pages using ReSTructured Text (rST). ### MacOS -1. Run `git checkout https://github.com/minio/docs` and `cd docs` to move into +1. Run `git clone https://github.com/minio/docs` and `cd docs` to move into the working directory. 2. Create a new virtual environment `python3 -m venv venv`. Activate it using @@ -59,7 +59,7 @@ Prereq: - Checkout the MinIO docs repository using your preferred `git` method - `git checkout https://github.com/minio/docs` + `git clone https://github.com/minio/docs` All instructions use PowerShell running as an administrator. @@ -93,4 +93,4 @@ All instructions use PowerShell running as an administrator. This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode). -See [CONTRIBUTIONS](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) for more information on contributing content to the MinIO Documentation project. \ No newline at end of file +See [CONTRIBUTIONS](https://github.com/minio/docs/tree/master/CONTRIBUTING.md) for more information on contributing content to the MinIO Documentation project. diff --git a/source/_static/scss/includes/_header.scss b/source/_static/scss/includes/_header.scss index d74548dac..acf31c358 100644 --- a/source/_static/scss/includes/_header.scss +++ b/source/_static/scss/includes/_header.scss @@ -142,7 +142,7 @@ border-width: 0 6px 4px; border-color: transparent transparent #fff; position: absolute; - bottom: -2px; + bottom: 0; transition: opacity 200ms; z-index: 2; } @@ -245,7 +245,7 @@ transform: translateX(calc(-50% + 3rem)); position: absolute; left: 0; - top: 2.65rem; + top: 100%; opacity: 0; transition: opacity 200ms; pointer-events: none; diff --git a/source/_templates/layout.html b/source/_templates/layout.html index a20cc7c57..56d715017 100644 --- a/source/_templates/layout.html +++ b/source/_templates/layout.html @@ -117,10 +117,15 @@

-
{% endblock %} - --> - {% block body %} {% endblock %} +

This work is licensed under a Creative Commons Attribution 4.0 International License.

diff --git a/source/conf.py b/source/conf.py deleted file mode 100644 index b458ba848..000000000 --- a/source/conf.py +++ /dev/null @@ -1,153 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -# The current working dir seems to be /source, so we have to pop up a level -sys.path.append(os.path.abspath('../sphinxext')) - - -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'MinIO Baremetal Documentation' -copyright = '2020-Present, MinIO, Inc. ' -author = 'Ravind Kumar' - -# The full version, including alpha/beta/rc tags -release = '0.1' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.extlinks', - 'minio', - 'cond', - 'sphinx_copybutton', - 'sphinx_markdown_tables', - 'sphinx-prompt', - 'sphinx_substitution_extensions', - 'sphinx_togglebutton', - 'sphinxcontrib.images', - 'myst_parser', - 'sphinx_design', - 'sphinx.ext.intersphinx', -] - -# -- External Links - -# Add roots for short external link references in the documentation. -# Helpful for sites we tend to make lots of references to. - -extlinks = { - 'kube-docs' : ('https://kubernetes.io/docs/%s', ''), - 'minio-git' : ('https://github.com/minio/%s',''), - 'github' : ('https://github.com/%s',''), - 'kube-api' : ('https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/%s',''), - 'aws-docs' : ('https://docs.aws.amazon.com/%s',''), - 's3-docs' : ('https://docs.aws.amazon.com/AmazonS3/latest/userguide/%s',''), - 's3-api' : ('https://docs.aws.amazon.com/AmazonS3/latest/API/%s',''), - 'iam-docs' : ('https://docs.aws.amazon.com/IAM/latest/UserGuide/%s',''), - 'minio-release' : ('https://github.com/minio/minio/releases/tag/%s',''), - 'mc-release' : ('https://github.com/minio/mc/releases/tag/%s',''), - 'legacy' : ('https://docs.min.io/docs/%s',''), - 'docs-k8s' : ('https://docs.min.io/minio/k8s/%s',''), - 'prometheus-docs' : ('https://prometheus.io/docs/%s',''), - 'podman-docs' : ('https://docs.podman.io/en/latest/%s',''), - 'podman-git' : ('https://github.com/containers/podman/%s','') - -} - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['includes/*.rst', 'includes/imports/*', '*-template.rst'] - -# Copy-Button Customization - -copybutton_selector = "div.copyable pre" - -# sphinxcontrib-images customization - -images_config = { - 'override_image_directive' : True -} - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -html_favicon = '_static/favicon.png' - -html_sidebars = { - '**' : [ - 'searchbox.html', - 'navigation.html' - ] -} - -html_theme_options = { - 'fixed_sidebar' : 'true', - 'show_relbars': 'false' -} - -html_short_title = "MinIO Object Storage for Baremetal Infrastructure" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -html_css_files = ['css/main.min.css', 'custom.css'] - -html_js_files = ['js/main.js'] - -html_extra_path = [ 'extra'] - -html_permalinks_icon = "" - -html_title = 'MinIO Baremetal Documentation' - -# -- Options for Sphinx Tabs ------------------------------------------------- - -sphinx_tabs_disable_css_loading = True - -rst_prolog = """ - -.. |podman| replace:: `Podman `__ -.. |kes-stable| replace:: 0.16.1 - -.. |minio-tag| replace:: `RELEASE.2022-06-11T19-55-32Z `__ -.. |minio-latest| replace:: RELEASE.2022-06-11T19-55-32Z -.. |minio-rpm| replace:: https://dl.min.io/server/minio/release/linux-amd64/minio-20220611195532.0.0.x86_64.rpm -.. |minio-deb| replace:: https://dl.min.io/server/minio/release/linux-amd64/minio_20220611195532.0.0_amd64.deb -.. |subnet| replace:: `MinIO SUBNET `__ -.. |subnet-short| replace:: `SUBNET `__ -.. |SNSD| replace:: :abbr:`SNSD (Single-Node Single-Drive)` -.. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)` -.. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)` - - -""" diff --git a/source/includes/common-installation.rst b/source/includes/common-installation.rst index de462847f..2b0882472 100644 --- a/source/includes/common-installation.rst +++ b/source/includes/common-installation.rst @@ -51,8 +51,9 @@ recommends using RPM or DEB installation routes. .. start-upgrade-minio-binary-desc -The following tabs provide examples of updating MinIO onto 64-bit Linux -operating systems using RPM, DEB, or binary: +The following tabs provide examples of updating MinIO onto 64-bit Linux operating systems using RPM, DEB, or binary executable. + +For infrastructure managed by tools such as Ansible or Terraform, defer to your internal procedures for updating packages or binaries across multiple managed hosts. .. tab-set:: @@ -66,7 +67,7 @@ operating systems using RPM, DEB, or binary: :class: copyable :substitutions: - wget |minio-rpm| -O minio.deb + curl |minio-rpm| --output minio.rpm sudo dnf update minio.rpm .. tab-item:: DEB (Debian/Ubuntu) @@ -79,7 +80,7 @@ operating systems using RPM, DEB, or binary: :class: copyable :substitutions: - wget |minio-deb| -O minio.deb + curl |minio-deb| --output minio.deb sudo dpkg -i minio.deb .. tab-item:: Binary @@ -91,12 +92,21 @@ operating systems using RPM, DEB, or binary: .. code-block:: shell :class: copyable - wget https://dl.min.io/server/minio/release/linux-amd64/minio + curl https://dl.min.io/server/minio/release/linux-amd64/minio chmod +x minio sudo mv minio /usr/local/bin/ - Replace ``/usr/local/bin`` with the location of the existing MinIO - binary. Run ``which minio`` to identify the path if not already known. + Replace ``/usr/local/bin`` with the location of the existing MinIO binary. + Run ``which minio`` to identify the path if not already known. + +You can validate the upgrade by computing the ``SHA256`` checksum of each binary and ensuring the checksum matches across all hosts: + +.. code-block:: shell + :class: copyable + + shasum -a 256 /usr/local/bin/minio + +The output of :mc-cmd:`minio --version ` should also match across all hosts. .. end-upgrade-minio-binary-desc diff --git a/source/installation/upgrade-minio.rst b/source/installation/upgrade-minio.rst index 3cf069344..d5a637088 100644 --- a/source/installation/upgrade-minio.rst +++ b/source/installation/upgrade-minio.rst @@ -10,98 +10,102 @@ Upgrade a MinIO Deployment :local: :depth: 2 -.. admonition:: Test Upgrades Before Applying To Production - :class: important +MinIO uses an update-then-restart methodology for upgrading a deployment to a newer release: + +1. Update the MinIO binary on all hosts with the newer release. +2. Restart the deployment using :mc-cmd:`mc admin service restart`. - MinIO **strongly discourages** performing blind updates to production - clusters. You should *always* test upgrades in a lower environment - (dev/QA/staging) *before* applying upgrades to production deployments. +This procedure does not require taking downtime and is non-disruptive to ongoing operations. - Exercise particular caution if upgrading to a :minio-git:`release - ` that has backwards breaking changes. MinIO includes - warnings in release notes for any version known to not support - downgrades. +This page documents methods for upgrading using the update-then-restart method for both ``systemctl`` and user-managed MinIO deployments. +Deployments using Ansible, Terraform, or other management tools can use the procedures here as guidance for implementation within the existing automation framework. + +.. admonition:: Test Upgrades In a Lower Environment + :class: important - For MinIO deployments that are significantly behind latest stable - (6+ months), consider using - `MinIO SUBNET `__ for additional support - and guidance during the upgrade procedure. + Your unique deployment topology, workload patterns, or overall environment requires testing of any MinIO upgrades in a lower environment (Dev/QA/Staging) *before* applying those upgrades to Production deployments, or any other environment containing critical data. + Performing "blind" updates to production environments is done at your own risk. -Upgrade Checklist ------------------ + For MinIO deployments that are significantly behind latest stable (6+ months), consider using |SUBNET| for additional support and guidance during the upgrade procedure. -Review all items on the following checklist before performing an upgrade on -your MinIO deployments: +Considerations +-------------- -.. list-table:: - :stub-columns: 1 - :widths: 25 75 - :width: 100% +Upgrades Are Non-Disruptive +~~~~~~~~~~~~~~~~~~~~~~~~~~~ - * - Test in Lower Environments - - Test all upgrades in a lower environment such as a dedicated - testing, development, or QA deployment. +MinIO's upgrade-then-restart procedure does *not* require taking downtime or scheduling a maintenance period. +MinIO restarts are fast, such that restarting all server processes in parallel typically completes in a few seconds. +MinIO operations are atomic and strictly consistent, such that applications using MinIO or S3 SDKs can rely on the built-in :aws-docs:`transparent retry ` without further client-side logic. +This ensures upgrades are non-disruptive to ongoing operations. - **Never** perform blind upgrades on production deployments. +"Rolling" or serial "one-at-a-time" upgrade methods do not provide any advantage over the recommended "parallel" procedure, and can introduce unnecessary complexity to the upgrade procedure. +For virtualized environments which *require* rolling updates, you should amend the recommend procedure as follows: - * - Upgrade Only When Necessary - - MinIO follows a rapid development model where there may be multiple - releases in a week. There is no requirement to follow these updates - if your deployment is otherwise stable and functional. +1. Update the MinIO Binary in the virtual machine or container one at a time. +2. Restart the MinIO deployment using :mc-cmd:`mc admin service restart`. +3. Update the virtual machine/container configuration to use the matching newer MinIO image. +4. Perform the rolling restart of each machine/container with the updated image. - Upgrade only if there is a specific feature, bug fix, or other - requirement necessary for your workload. Review the - :minio-git:`Release Notes ` for each Server release - between your current MinIO version and the target version. +Check Release Notes +~~~~~~~~~~~~~~~~~~~ - * - Upgrades require Simultaneous Restart - - Ensure your preferred method of node management supports operating on - all nodes simultaneously. - - .. include:: /includes/common-installation.rst - :start-after: start-nondisruptive-upgrade-desc - :end-before: end-nondisruptive-upgrade-desc +MinIO publishes :minio-git:`Release Notes ` for your reference as part of identifying the changes applied in each release. +Review the associated release notes between your current MinIO version and the newer release such that you have a complete view of any changes. + +Pay particular attention to any releases that are backwards incompatible. +You cannot trivially downgrade from any such release. .. _minio-upgrade-systemctl: Update ``systemctl``-Managed MinIO Deployments ---------------------------------------------- -Deployments managed using ``systemctl``, such as those created -using the MinIO :ref:`DEB/RPM packages `, -require manual update and simultaneous restart of all nodes in the -MinIO deployment. +Use these steps to upgrade a MinIO deployment where the MinIO server process is managed by ``systemctl``, such as those created using the MinIO :ref:`DEB/RPM packages `. -1. **Update the MinIO Binary on Each Node** +1. Update the MinIO Binary on Each Node .. include:: /includes/common-installation.rst :start-after: start-upgrade-minio-binary-desc :end-before: end-upgrade-minio-binary-desc -2. **Restart the Deployment** +2. Restart the Deployment - Run ``systemctl restart minio`` simultaneously across all nodes in the - deployment. Utilize your preferred method for coordinated execution of - terminal/shell commands. + Run the :mc-cmd:`mc admin service restart` command to restart all MinIO server processes in the deployment simultaneously. + + The restart process typically completes within a few seconds and is *non-disruptive* to ongoing operations. - .. include:: /includes/common-installation.rst - :start-after: start-nondisruptive-upgrade-desc - :end-before: end-nondisruptive-upgrade-desc + .. code-block:: shell + :class: copyable -.. _minio-upgrade-mc-admin-update: + mc admin service restart ALIAS -Update MinIO Deployments using ``mc admin update`` --------------------------------------------------- + Replace :ref:`alias ` of the MinIO deployment to restart. -.. include:: /includes/common-installation.rst - :start-after: start-nondisruptive-upgrade-desc - :end-before: end-nondisruptive-upgrade-desc +3. Validate the Upgrade -The :mc-cmd:`mc admin update` command updates all MinIO server binaries in -the target MinIO deployment before restarting all nodes simultaneously. + Use the :mc-cmd:`mc admin info` command to check that all MinIO servers are online, operational, and reflect the installed MinIO version. -:mc-cmd:`mc admin update` is intended for baremetal (non-orchestrated) -deployments using manual management of server binaries. +4. Update MinIO Client + + You should upgrade your :mc:`mc` binary to match or closely follow the MinIO server release. + You can use the :mc:`mc update` command to update the binary to the latest stable release: + + .. code-block:: shell + :class: copyable + + mc update + +.. _minio-upgrade-mc-admin-update: + +Update Non-System Managed MinIO Deployments +------------------------------------------- + +Use these steps to upgrade a MinIO deployment where the MinIO server process is managed outside of the system (``systemd``, ``systemctl``), such as by a user, an automated script, or some other process management tool. +This procedure only works for systems where the user running the MinIO process has write permissions for the path to the MinIO binary. + +The :mc-cmd:`mc admin update` command updates all MinIO server binaries in the target MinIO deployment before restarting all nodes simultaneously. +The restart process typically completes within a few seconds and is *non-disruptive* to ongoing operations. - For deployments managed using ``systemctl``, see :ref:`minio-upgrade-systemctl`. @@ -109,79 +113,25 @@ deployments using manual management of server binaries. - For Kubernetes or other containerized environments, defer to the native mechanisms for updating container images across a deployment. -:mc-cmd:`mc admin update` requires write access to the directory in which -the MinIO binary is saved (e.g. ``/usr/local/bin``). - -The following command updates a MinIO deployment with the specified -:ref:`alias ` to the latest stable release: +The following command updates a MinIO deployment with the specified :ref:`alias ` to the latest stable release: .. code-block:: shell :class: copyable mc admin update ALIAS -You should upgrade your :mc:`mc` binary to match or closely follow the -MinIO server release. You can use the :mc:`mc update` command to update the -binary to the latest stable release: - -.. code-block:: shell - :class: copyable - - mc update - You can specify a URL resolving to a specific MinIO server binary version. -Airgapped or internet-isolated deployments may utilize this feature for updating -from an internally-accessible server: +Airgapped or internet-isolated deployments may utilize this feature for updating from an internally-accessible server: .. code-block:: shell :class: copyable mc admin update ALIAS https://minio-mirror.example.com/minio -Update MinIO Manually ---------------------- - -The following steps manually download the MinIO binary and restart the -deployment. These steps are intended for fully manual baremetal deployments -without ``systemctl`` or similar process management. These steps may also -apply to airgapped or similarly internet-isolated deployments which -cannot use :mc-cmd:`mc admin update` to retrieve the binary over the network. - -1. **Add the MinIO Binary to each node in the deployment** +You should upgrade your :mc:`mc` binary to match or closely follow the MinIO server release. +You can use the :mc:`mc update` command to update the binary to the latest stable release: - Follow your organizations preferred procedure for adding a new binary - to the node. The following command downloads the latest stable MinIO - binary: - - .. code-block:: shell - :class: copyable - - wget https://dl.min.io/server/minio/release/linux-amd64/minio - -2. **Overwrite the existing MinIO binary with the newer version** - - The following command sets the binary to executable and copies it to - ``/usr/local/bin``. Replace this path with the location of the existing - MinIO binary: - - .. code-block:: shell - :class: copyable - - chmod +x minio - sudo mv minio /usr/local/bin/ - -3. **Restart the deployment** - - Once all nodes have the updated binary, restart all nodes simultaneously - using the :mc-cmd:`mc admin service` command: - - .. code-block:: shell - :class: copyable - - mc admin service ALIAS - - Replace ``ALIAS`` with the :ref:`alias ` for the target deployment. +.. code-block:: shell + :class: copyable - .. include:: /includes/common-installation.rst - :start-after: start-nondisruptive-upgrade-desc - :end-before: end-nondisruptive-upgrade-desc + mc update diff --git a/source/monitoring/metrics-alerts/minio-metrics-and-alerts.rst b/source/monitoring/metrics-alerts/minio-metrics-and-alerts.rst index f48fd787c..692cbfbda 100644 --- a/source/monitoring/metrics-alerts/minio-metrics-and-alerts.rst +++ b/source/monitoring/metrics-alerts/minio-metrics-and-alerts.rst @@ -303,6 +303,26 @@ Node Metrics Uptime for MinIO process per node in seconds. +.. metric:: minio_node_scanner_bucket_scans_finished + + Total number of bucket scans finished since server start. + +.. metric:: minio_node_scanner_bucket_scans_started + + Total number of bucket scans started since server start. + +.. metric:: minio_node_scanner_directories_scanned + + Total number of directories scanned since server start. + +.. metric:: minio_node_scanner_objects_scanned + + Total number of unique objects scanned since server start. + +.. metric:: minio_node_scanner_versions_scanned + + Total number of object versions scanned since server start. + .. metric:: minio_node_syscall_read_total Total read SysCalls to the kernel. ``/proc/[pid]/io syscr`` diff --git a/source/object-retention/minio-object-retention.rst b/source/object-retention/minio-object-retention.rst index 5bfdd7e50..73965ea03 100644 --- a/source/object-retention/minio-object-retention.rst +++ b/source/object-retention/minio-object-retention.rst @@ -18,9 +18,6 @@ the full history of that object. MinIO also supports objects to ensure complete immutability for a specified duration *or* until the lock is explicitly lifted. -Both versioning and object locking features are available only with -:ref:`distributed MinIO deployments `. - .. card:: Bucket Versioning :link: minio-bucket-versioning :link-type: ref diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index a7808fc5e..c61b0db84 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -35,7 +35,7 @@ See :ref:`minio-mc-commands` for a list of supported commands. licensed Free and Open Source (FOSS) software. Applications integrating :program:`mc` may trigger AGPLv3 compliance - requirements. `MinIO Commericla Licensing `__ + requirements. `MinIO Commericial Licensing `__ is the best option for applications which trigger AGPLv3 obligations where open-sourcing the application is not an option. diff --git a/source/reference/minio-mc/mc-mb.rst b/source/reference/minio-mc/mc-mb.rst index c60c1fe31..e9e448586 100644 --- a/source/reference/minio-mc/mc-mb.rst +++ b/source/reference/minio-mc/mc-mb.rst @@ -74,7 +74,7 @@ Parameters .. code-block:: none - mc ls ~/mydata/object.txt + mc mb ~/mydata/mydir .. mc-cmd:: --ignore-existing, p diff --git a/source/reference/minio-mc/mc-retention-info.rst b/source/reference/minio-mc/mc-retention-info.rst index 8a127638c..817d0dbec 100644 --- a/source/reference/minio-mc/mc-retention-info.rst +++ b/source/reference/minio-mc/mc-retention-info.rst @@ -78,7 +78,7 @@ Parameters *Required* - The full path to the object for which to retreive + The full path to the object for which to retrieve the object lock configuration. Specify the :ref:`alias ` of a configured S3-compatible service as the prefix to the ``ALIAS`` bucket path. For example: diff --git a/source/reference/minio-server/minio-server.rst b/source/reference/minio-server/minio-server.rst index a9345bc61..dcaea71ec 100644 --- a/source/reference/minio-server/minio-server.rst +++ b/source/reference/minio-server/minio-server.rst @@ -33,7 +33,7 @@ see :docs-k8s:`Kubernetes documentation <>`. licensed Free and Open Source (FOSS) software. Applications integrating :program:`mc` may trigger AGPLv3 compliance - requirements. `MinIO Commericla Licensing `__ + requirements. `MinIO Commercial Licensing `__ is the best option for applications which trigger AGPLv3 obligations where open-sourcing the application is not an option. diff --git a/source/security/server-side-encryption/configure-minio-kes-aws.rst b/source/security/server-side-encryption/configure-minio-kes-aws.rst index 2fdd3e691..114f408cd 100644 --- a/source/security/server-side-encryption/configure-minio-kes-aws.rst +++ b/source/security/server-side-encryption/configure-minio-kes-aws.rst @@ -192,13 +192,14 @@ Manager: # This example assumes that the associated AWS account has the necessary # access key and secret key keystore: - secretsmanager: - endpoint: secretsmanager.REGION.amazonaws # use the Secrets Manager endpoint for your region - region: REGION # e.g. us-east-1 - kmskey: "" # Optional. The root AWS KMS key to use for cryptographic operations. Formerly described as the "Customer Master Key". - credentials: - accesskey: "${AWSACCESSKEY}" # AWS Access Key - secretkey: "${AWSSECRETKEY}" # AWS Secret Key + aws: + secretsmanager: + endpoint: secretsmanager.REGION.amazonaws.com # use the Secrets Manager endpoint for your region + region: REGION # e.g. us-east-1 + kmskey: "" # Optional. The root AWS KMS key to use for cryptographic operations. Formerly described as the "Customer Master Key". + credentials: + accesskey: "${AWSACCESSKEY}" # AWS Access Key + secretkey: "${AWSSECRETKEY}" # AWS Secret Key Save the configuration file as ``~/kes/config/kes-config.yaml``. Any field with diff --git a/source/support/support-overview.rst b/source/support/support-overview.rst index 8d407bf1d..970be211e 100644 --- a/source/support/support-overview.rst +++ b/source/support/support-overview.rst @@ -13,7 +13,7 @@ Overview MinIO users have two options for support. -#. Community support from the `public Slack channel `_. +#. Community support from the `public Slack channel `_. Community support is best-effort only and has no :abbr:`SLA (Service Level Agreement)` or :abbr:`SLO (Service Level Objective)`. #. The MinIO Subscription Network, |subnet-short|, provides either 24 hour or 1 hour :abbr:`SLA (Service Level Agreement)` depending on subscription level.