--------------------------------------------------------------------------------
/source/developers/dotnet/minio-dotnet.rst:
--------------------------------------------------------------------------------
1 | .. _minio-dotnet-quickstart:
2 |
3 | =====================
4 | .NET Quickstart Guide
5 | =====================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. include:: /developers/dotnet/quickstart.md
14 | :parser: myst_parser.sphinx_
15 |
16 | .. toctree::
17 | :titlesonly:
18 | :hidden:
19 |
20 | /developers/dotnet/API.md
21 |
--------------------------------------------------------------------------------
/source/developers/javascript/minio-javascript.rst:
--------------------------------------------------------------------------------
1 | .. _minio-javascript-quickstart:
2 |
3 | ===========================
4 | JavaScript Quickstart Guide
5 | ===========================
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. include:: /developers/javascript/quickstart.md
12 | :parser: myst_parser.sphinx_
13 |
14 | .. toctree::
15 | :titlesonly:
16 | :hidden:
17 |
18 | /developers/javascript/API.md
19 |
--------------------------------------------------------------------------------
/source/developers/python/minio-py.rst:
--------------------------------------------------------------------------------
1 | .. _minio-python-quickstart:
2 |
3 | =======================
4 | Python Quickstart Guide
5 | =======================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. include:: /developers/python/quickstart.md
14 | :parser: myst_parser.sphinx_
15 |
16 | .. toctree::
17 | :titlesonly:
18 | :hidden:
19 |
20 | /developers/python/API.md
21 |
--------------------------------------------------------------------------------
/source/developers/rust/minio-rust.rst:
--------------------------------------------------------------------------------
1 | .. _minio-rust-quickstart:
2 |
3 | =====================
4 | Rust Quickstart Guide
5 | =====================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. include:: /developers/rust/quickstart.md
14 | :parser: myst_parser.sphinx_
15 |
16 | .. .. toctree::
17 | .. :titlesonly:
18 | .. :hidden:
19 |
20 | .. /developers/rust/API.md
21 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | docutils == 0.19
2 | sphinx == 6.2.1
3 | sphinx-copybutton == 0.5.2
4 | sphinx-design == 0.4.1
5 | sphinx-markdown-tables == 0.0.15
6 | Sphinx-Substitution-Extensions == 2022.02.16
7 | sphinx-sitemap == 2.5.0
8 | sphinx-togglebutton === 0.3.2
9 | sphinxcontrib-images === 0.9.4
10 | sphinxcontrib-autoyaml === 1.1.1
11 | sphinx_reredirects === 0.1.2
12 | myst-parser === 1.0.0
13 | linkify === 1.4
14 | linkify-it-py === 2.0.0
15 | pyyaml === 6.0.1
16 |
--------------------------------------------------------------------------------
/source/_static/img/icons/menu.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/release.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Release
3 | about: Document a new product release
4 | title: "[RELEASE] PRODUCT RELEASE-TAG"
5 | labels: triage
6 | assignees: ''
7 |
8 | ---
9 |
10 | PRODUCT [TAG](TAG-URL) has changes that impact the docs:
11 |
12 | - [ ] change description [PR #NNNN](Link to PR)
13 | - [ ] change description [PR #NNNN](Link to PR)
14 | - [ ] change description [PR #NNNN](Link to PR)
15 | - [ ] change description [PR #NNNN](Link to PR)
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/source/_static/img/icons/arrow-back.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/stage.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -e
4 |
5 | source staging.env
6 | BRANCH=$(git rev-parse --symbolic-full-name --abbrev-ref HEAD)
7 |
8 | function main() {
9 |
10 | echo "Staging to $STAGEHOST:"
11 | rsync --mkpath -rv --delete -e "ssh -i $SSHKEY -p $SSHPORT" build/$BRANCH/mindocs/* $STAGEUSER@$STAGEHOST:/var/www/html/$STAGEPROJECT/$BRANCH
12 | echo "Staging complete"
13 | echo "Staged to http://$STAGEHOST:$STAGEPORT/$STAGEPROJECT/$BRANCH/html/index.html"
14 |
15 | }
16 |
17 | main "$@"
18 |
--------------------------------------------------------------------------------
/source/includes/common/common-design.rst:
--------------------------------------------------------------------------------
1 | Included Header
2 | ---------------
3 |
4 |
5 | This is content inside of the above header.
6 | The header decoration *must* match that of the "parent" document
7 |
8 | Another Header
9 | --------------
10 |
11 | This is content inside the above header.
12 | This should be the same level as the previous header.
13 |
14 | SubHeader
15 | ~~~~~~~~~
16 |
17 | This is content subsectioned to the previous header.
18 | It should be one level down from the previous header.
19 |
--------------------------------------------------------------------------------
/source/includes/common/common-k8s-operator-console-jwt.rst:
--------------------------------------------------------------------------------
1 | Use the following command to retrieve the JSON Web Token (JWT) necessary for logging in to the Operator Console:
2 |
3 | .. code-block:: shell
4 | :class: copyable
5 |
6 | kubectl get secret/console-sa-secret -n minio-operator -o json | jq -r '.data.token' | base64 -d
7 |
8 | If your local host does not have the ``jq`` utility installed, you can run the ``kubectl`` part of this command (before ``| jq``) and locate the ``data.token`` section of the output.
9 |
--------------------------------------------------------------------------------
/source/_templates/cookie.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Your privacy is important to us:
5 | We use cookies in order to give you a better experience. If you wish so, you can always review our
6 | Privacy Policy.
7 |
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/source/extra/examples/ConsoleAdmin.json:
--------------------------------------------------------------------------------
1 | {
2 | "Version": "2012-10-17",
3 | "Statement": [
4 | {
5 | "Action": [
6 | "admin:*"
7 | ],
8 | "Effect": "Allow",
9 | "Sid": ""
10 | },
11 | {
12 | "Action": [
13 | "s3:*"
14 | ],
15 | "Effect": "Allow",
16 | "Resource": [
17 | "arn:aws:s3:::*"
18 | ],
19 | "Sid": ""
20 | }
21 | ]
22 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 | venv
3 | .vscode
4 | __pycache__
5 | node_modules
6 | npm-debug.log
7 | .python-version
8 | main.min.css
9 | main.css
10 | objects.inv
11 | output.log
12 | .DS_Store
13 | source/conf.py
14 | package-lock.json
15 | build.log
16 | source/developers/go/*.md
17 | source/developers/dotnet/*.md
18 | source/developers/haskell/*.md
19 | source/developers/java/*.md
20 | source/developers/javascript/*.md
21 | source/developers/python/*.md
22 | source/operations/monitoring/*.md
23 | source/includes/common-metrics-*.md
24 | *.inv
25 |
--------------------------------------------------------------------------------
/source/_static/scss/includes/_footer.scss:
--------------------------------------------------------------------------------
1 | div.footer {
2 | all: revert;
3 | width: 100%;
4 | margin: 3rem 0 0 0;
5 | font-size: $font-size-sm;
6 | opacity: 0.75;
7 | text-align: center;
8 | border-top: 1px solid var(--theme-light-bg);
9 | padding-top: 1.15rem;
10 |
11 | &, a {
12 | color: var(--text-muted-color);
13 | }
14 |
15 | a {
16 | &:hover {
17 | text-decoration: underline;
18 | }
19 | }
20 |
21 | p {
22 | margin: 0;
23 | }
24 | }
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/baremetal.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/download.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/scss/main.scss:
--------------------------------------------------------------------------------
1 | @import 'includes/mixins';
2 | @import 'includes/variables';
3 | @import 'includes/font';
4 | @import 'includes/reset';
5 | @import 'includes/theme';
6 | @import 'includes/base';
7 | @import 'includes/layout';
8 | @import 'includes/header';
9 | @import 'includes/aside';
10 | @import 'includes/toc';
11 | @import 'includes/tab';
12 | @import 'includes/misc';
13 | @import 'includes/search';
14 | @import 'includes/footer';
15 | @import 'includes/nav';
16 | @import 'includes/alert';
17 | @import 'includes/content';
18 | @import 'includes/temp';
--------------------------------------------------------------------------------
/source/includes/minio-kubernetes-operator.rst:
--------------------------------------------------------------------------------
1 | .. tab-set::
2 |
3 | .. tab-item:: SSH
4 |
5 | .. code-block:: shell
6 | :class: copyable
7 |
8 | mkdir -p ~/minio-kubernetes/git
9 | cd ~/minio-examples/git
10 |
11 | git clone git@github.com:minio/minio-operator.git
12 |
13 | .. tab-item:: HTTPS
14 |
15 | .. code-block:: shell
16 | :class: copyable
17 |
18 | mkdir -p ~/minio-kubernetes/git
19 | cd ~/minio-examples/git
20 |
21 | git clone https://github.com/minio/minio-operator.git
--------------------------------------------------------------------------------
/source/_templates/head.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/source/_templates/icons/moon.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/task.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Task
3 | about: Tasks created by MinIO related to internal timelines
4 | title: ''
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Summary**
11 |
12 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13 |
14 | **Goals**
15 |
16 | List the in-scope goals
17 |
18 | - [ ] Goal 1
19 | - [ ] Goal 2
20 | - [ ] Goal 3
21 |
22 | **Non-Goals**
23 |
24 | List any items that are out of scope
25 |
26 | **Additional context**
27 | Add any other context or screenshots about the feature request here.
28 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/overview.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/erasure-code-calculator.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/firewall.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/console.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/identity.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_templates/icons/external-link.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/observability.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/scss/includes/_tab.scss:
--------------------------------------------------------------------------------
1 | .sd-tab-set {
2 | --sd-color-tabs-label-inactive: var(--text-muted-color);
3 | --sd-color-tabs-label-hover: var(--text-color);
4 | --sd-color-tabs-label-active: var(--headings-color);
5 | --sd-color-tabs-underline-active: var(--tab-active-border-color);
6 | --sd-color-tabs-overline: var(--tab-border-color);
7 | --sd-color-tabs-underline: transparent;
8 | --sd-color-tabs-underline-hover: transparent;
9 |
10 | & > label {
11 | padding: 0.5rem 0;
12 | margin-right: 2rem;
13 | opacity: 1;
14 | font-weight: $font-weight-medium;
15 | transition: border 300ms, color 300ms, opacity 300ms;
16 | }
17 | }
--------------------------------------------------------------------------------
/source/includes/common-mc-support.rst:
--------------------------------------------------------------------------------
1 | .. start-minio-only
2 |
3 | .. admonition:: SUBNET Registration Required
4 | :class: note
5 |
6 | The ``mc support`` commands are designed for MinIO deployments registered with |subnet| to ensure optimal outcome of diagnostics and performance testing.
7 | Deployments not registered with SUBNET cannot use the ``mc support`` commands.
8 |
9 | .. end-minio-only
10 |
11 | .. start-support-logs-opt-in
12 |
13 | The uploading feature remains disabled by default until explicitly enabled for a deployment on an opt-in only basis.
14 | If enabled, you can disable the feature at any time with :mc-cmd:`mc support callhome disable`.
15 |
16 | .. end-support-logs-opt-in
--------------------------------------------------------------------------------
/source/extra/examples/LifecycleManagementAdmin.json:
--------------------------------------------------------------------------------
1 | {
2 | "Version": "2012-10-17",
3 | "Statement": [
4 | {
5 | "Action": [
6 | "admin:SetTier",
7 | "admin:ListTier"
8 | ],
9 | "Effect": "Allow",
10 | "Sid": "EnableRemoteTierManagement"
11 | },
12 | {
13 | "Action": [
14 | "s3:PutLifecycleConfiguration",
15 | "s3:GetLifecycleConfiguration"
16 | ],
17 | "Resource": [
18 | "arn:aws:s3:::*"
19 | ],
20 | "Effect": "Allow",
21 | "Sid": "EnableLifecycleManagementRules"
22 | }
23 | ]
24 | }
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/replication.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/images/logos/macos.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature request
3 | about: Suggest an idea for this project
4 | title: "[FEATURE]"
5 | labels: triage
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 |
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 |
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 |
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 |
--------------------------------------------------------------------------------
/source/_templates/custom-scripts.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/extra/examples/LifecycleManagementUser.json:
--------------------------------------------------------------------------------
1 | {
2 | "Version": "2012-10-17",
3 | "Statement": [
4 | {
5 | "Action": [
6 | "s3:ListBucket"
7 | ],
8 | "Effect": "Allow",
9 | "Resource": [
10 | "arn:aws:s3:::MyDestinationBucket"
11 | ],
12 | "Sid": ""
13 | },
14 | {
15 | "Action": [
16 | "s3:GetObject",
17 | "s3:PutObject",
18 | "s3:DeleteObject"
19 | ],
20 | "Effect": "Allow",
21 | "Resource": [
22 | "arn:aws:s3:::MyDestinationBucket/*"
23 | ],
24 | "Sid": ""
25 | }
26 | ]
27 | }
28 |
--------------------------------------------------------------------------------
/source/operations/deployments/baremetal-upgrade-minio-deployment.rst:
--------------------------------------------------------------------------------
1 | .. _minio-upgrade:
2 |
3 | ==========================
4 | Upgrade a MinIO Deployment
5 | ==========================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. important::
14 |
15 | For deployments older than :minio-release:`RELEASE.2024-03-30T09-41-56Z` running with :ref:`AD/LDAP ` enabled, you **must** read through the release notes for :minio-release:`RELEASE.2024-04-18T19-09-19Z` before starting this procedure.
16 | You must take the extra steps documented in the linked release as part of the upgrade.
17 |
18 | .. include:: /includes/linux/steps-upgrade-minio-deployment.rst
--------------------------------------------------------------------------------
/sitemap_index.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | https://www.min.io/sitemap.xml
6 |
7 |
8 | https://www.min.io/docs/minio/linux/sitemap.xml
9 |
10 |
11 | https://www.min.io/docs/minio/windows/sitemap.xml
12 |
13 |
14 | https://www.min.io/docs/minio/macos/sitemap.xml
15 |
16 |
17 | https://www.min.io/docs/minio/kubernetes/upstream/sitemap.xml
18 |
19 |
20 | https://www.min.io/docs/minio/container/sitemap.xml
21 |
22 |
--------------------------------------------------------------------------------
/source/_static/img/icons/play-dark.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/operations/deployments/baremetal-deploy-minio-server.rst:
--------------------------------------------------------------------------------
1 | .. _deploy-minio-standalone:
2 |
3 | ========================
4 | Install the MinIO Server
5 | ========================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 1
12 |
13 | MinIO supports deploying onto baremetal infrastructure - physical machines or virtualized hosts - running Linux, MacOS, and Windows.
14 |
15 | .. toctree::
16 | :titlesonly:
17 | :hidden:
18 |
19 | /operations/deployments/baremetal-deploy-minio-on-redhat-linux
20 | /operations/deployments/baremetal-deploy-minio-on-ubuntu-linux
21 | /operations/deployments/baremetal-deploy-minio-as-a-container
22 | /operations/deployments/baremetal-deploy-minio-on-macos
23 | /operations/deployments/baremetal-deploy-minio-on-windows
--------------------------------------------------------------------------------
/source/_static/img/icons/ref-hardware.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/macos.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/operator-crd.rst:
--------------------------------------------------------------------------------
1 | .. _minio-operator-crd:
2 |
3 | ================================
4 | MinIO Custom Resource Definition
5 | ================================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 |
14 | The MinIO Operator installs a :kube-docs:`Custom Resource Definition (CRD) ` that describes a MinIO Tenant object.
15 | The Operator uses this CRD for provisioning and managing Tenant resources within a Kubernetes cluster.
16 |
17 | This page documents the CRD reference for use in customizing Operator-deployed Tenants.
18 | This documentation assumes familiarity with all referenced Kubernetes concepts, utilities, and procedures.
19 |
20 | .. include:: /includes/k8s/ext-tenant-crd.md
21 | :parser: myst_parser.sphinx_
--------------------------------------------------------------------------------
/source/_static/img/icons/macos-inactive.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/extra/kes.service:
--------------------------------------------------------------------------------
1 | [Unit]
2 | Description=KES
3 | Documentation=https://github.com/minio/kes/wiki
4 | Wants=network-online.target
5 | After=network-online.target
6 | AssertFileIsExecutable=/usr/local/bin/kes
7 |
8 | [Service]
9 | WorkingDirectory=/etc/kes/
10 |
11 | AmbientCapabilities=CAP_IPC_LOCK
12 |
13 | User=kes
14 | Group=kes
15 | ProtectProc=invisible
16 |
17 | ExecStart=/usr/local/bin/kes server --config=/opt/kes/config.yaml
18 |
19 | # Let systemd restart this service always
20 | Restart=always
21 |
22 | # Specifies the maximum file descriptor number that can be opened by this process
23 | LimitNOFILE=65536
24 |
25 | # Specifies the maximum number of threads this process can create
26 | TasksMax=infinity
27 |
28 | # Disable timeout logic and wait until process is stopped
29 | TimeoutStopSec=infinity
30 | SendSIGKILL=no
31 |
32 | [Install]
33 | WantedBy=multi-user.target
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/events.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/make.bat:
--------------------------------------------------------------------------------
1 | @ECHO OFF
2 |
3 | pushd %~dp0
4 |
5 | REM Command file for Sphinx documentation
6 |
7 | if "%SPHINXBUILD%" == "" (
8 | set SPHINXBUILD=sphinx-build
9 | )
10 | set SOURCEDIR=source
11 | set BUILDDIR=build
12 |
13 | if "%1" == "" goto help
14 |
15 | %SPHINXBUILD% >NUL 2>NUL
16 | if errorlevel 9009 (
17 | echo.
18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19 | echo.installed, then set the SPHINXBUILD environment variable to point
20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you
21 | echo.may add the Sphinx directory to PATH.
22 | echo.
23 | echo.If you don't have Sphinx installed, grab it from
24 | echo.http://sphinx-doc.org/
25 | exit /b 1
26 | )
27 |
28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29 | goto end
30 |
31 | :help
32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33 |
34 | :end
35 | popd
36 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/immutability.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/tenant-chart-values.rst:
--------------------------------------------------------------------------------
1 | .. _minio-tenant-chart-values:
2 |
3 | ==================
4 | Tenant Helm Charts
5 | ==================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 1
12 |
13 | MinIO publishes |helm-charts| for the |helm-operator-chart| and |helm-tenant-chart|.
14 | You can use these charts to deploy the MinIO Operator and managed Tenants through Helm.
15 |
16 | The following page documents the ``values.yaml`` chart for a MinIO Tenant.
17 | For documentation on the chart for a MinIO Operator, see :ref:`minio-operator-chart-values`
18 |
19 | .. _minio-tenant-chart-operator-values:
20 |
21 |
22 | MinIO Tenant Chart
23 | ------------------
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: Reference
28 |
29 | .. autoyaml:: /source/includes/k8s/tenant-values.yaml
30 |
31 | .. tab-item:: YAML
32 |
33 | .. literalinclude:: /includes/k8s/tenant-values.yaml
--------------------------------------------------------------------------------
/source/_static/img/icons/anchor.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/anchor-dark.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/operator-chart-values.rst:
--------------------------------------------------------------------------------
1 | .. _minio-operator-chart-values:
2 |
3 | ====================
4 | Operator Helm Charts
5 | ====================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 1
12 |
13 | MinIO publishes |helm-charts| for the |helm-operator-chart| and |helm-tenant-chart|.
14 | You can use these charts to deploy the MinIO Operator and managed Tenants through Helm.
15 |
16 | The following page documents the ``values.yaml`` chart for the MinIO Operator.
17 | For documentation on the chart for a MinIO Tenant, see :ref:`minio-tenant-chart-values`
18 |
19 | .. _minio-operator-chart-operator-values:
20 |
21 | MinIO Operator Chart
22 | --------------------
23 |
24 | .. tab-set::
25 |
26 | .. tab-item:: Reference
27 |
28 | .. autoyaml:: /source/includes/k8s/operator-values.yaml
29 |
30 | .. tab-item:: YAML
31 |
32 | .. literalinclude:: /includes/k8s/operator-values.yaml
33 |
--------------------------------------------------------------------------------
/source/_static/img/docs-logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/catalog.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/includes/common/common-k8s-deprecation-audit-prometheus.rst:
--------------------------------------------------------------------------------
1 | .. start-deprecate-audit-logs
2 |
3 | .. important::
4 |
5 | MinIO plans to deprecate the Tenant Console Audit Log feature and remove it in an upcoming release.
6 | MinIO recommends disabling this feature in preparation for this change.
7 |
8 | As an alternative, use any webhook-capable database or logging service to capture :ref:`audit logs ` from the Tenant.
9 |
10 | .. end-deprecate-audit-logs
11 |
12 | .. start-deprecate-prometheus
13 |
14 | .. important::
15 |
16 | MinIO plans to deprecate the Tenant Prometheus pod feature and remove it in an upcoming release.
17 | MinIO recommends setting this value to ``false`` in preparation for this change.
18 |
19 | As an alternative, use any Prometheus service deployed within the Kubernetes cluster or externally to :ref:`capture Tenant metrics `.
20 |
21 | .. end-deprecate-prometheus
--------------------------------------------------------------------------------
/source/integrations/integrations.rst:
--------------------------------------------------------------------------------
1 | ============
2 | Integrations
3 | ============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | The following pages provide integration guides between MinIO and select third-party software.
12 | The guides on this page were previously hosted under the :guilabel:`Cookbook` heading of our legacy documentation.
13 |
14 | All provided guides assume familiarity with the third-party integration software, and do not replace the official documentation for that software.
15 |
16 | .. toctree::
17 | :titlesonly:
18 | :hidden:
19 |
20 | /integrations/using-minio-with-veeam.md
21 | /integrations/disaggregated-spark-and-hadoop-hive-with-minio.md
22 | /integrations/aws-cli-with-minio.md
23 | /integrations/setup-nginx-proxy-with-minio
24 | /integrations/presigned-put-upload-via-browser.md
25 | /integrations/generate-lets-encrypt-certificate-using-certbot-for-minio.md
26 |
27 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/architecture.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/openshift.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/lifecycle.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: "[BUG]"
5 | labels: triage
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 |
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 |
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 |
26 | **Desktop (please complete the following information):**
27 | - OS: [e.g. iOS]
28 | - Browser [e.g. chrome, safari]
29 | - Version [e.g. 22]
30 |
31 | **Smartphone (please complete the following information):**
32 | - Device: [e.g. iPhone6]
33 | - OS: [e.g. iOS8.1]
34 | - Browser [e.g. stock browser, safari]
35 | - Version [e.g. 22]
36 |
37 | **Additional context**
38 | Add any other context about the problem here.
39 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "minio-documentation",
3 | "version": "1.0.0",
4 | "description": "Official MinIO documentation",
5 | "main": "index.rst",
6 | "scripts": {
7 | "watch": "gulp watch",
8 | "build": "gulp",
9 | "gulp": "gulp",
10 | "test": "echo \"Error: no test specified\" && exit 1"
11 | },
12 | "repository": {
13 | "type": "git",
14 | "url": "git+https://github.com/minio/docs.git"
15 | },
16 | "author": "MinIO Documentation Team",
17 | "license": "Apache-2.0",
18 | "bugs": {
19 | "url": "https://github.com/minio/docs/issues"
20 | },
21 | "homepage": "https://github.com/minio/docs#readme",
22 | "devDependencies": {
23 | "gulp": "^4.0.2",
24 | "gulp-autoprefixer": "^8.0.0",
25 | "gulp-clean-css": "^4.3.0",
26 | "gulp-connect": "^5.7.0",
27 | "gulp-load-plugins": "^2.0.7",
28 | "gulp-rename": "^2.0.0",
29 | "gulp-sass": "^5.1.0",
30 | "gulp-terser": "^2.1.0",
31 | "sass": "^1.49.0"
32 | },
33 | "browserslist": [
34 | "last 2 versions"
35 | ]
36 | }
37 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/kms.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/includes/play-alias-available.rst:
--------------------------------------------------------------------------------
1 | play-alias-only
2 |
3 | The following example assumes that the ``play`` alias exists in the
4 | :mc-cmd:`mc` :ref:`configuration file `. You can
5 | replace ``play`` with the alias for your preferred S3-compatible deployment.
6 |
7 | See :mc:`mc alias` for more information on aliases.
8 |
9 | end-play-alias-only
10 |
11 |
12 | play-s3-alias
13 |
14 | The following example assumes that the ``play`` and ``s3`` aliases exist in the
15 | :mc-cmd:`mc` :ref:`configuration file `. You can replace
16 | ``play`` and ``s3`` with the aliases for your preferred S3-compatible
17 | deployments.
18 |
19 | See :mc:`mc alias` for more information on aliases.
20 |
21 | end-play-s3-alias
22 |
23 | myminio-alias
24 |
25 | The following example uses the default ``myminio`` alias. The ``myminio``
26 | alias points to a local ``minio`` server running on port ``9000``. See
27 | for more information on installing and running
28 | a local ``minio`` server instance.
29 |
30 | See :mc:`mc alias` for more information on aliases.
31 |
32 | end-myminio-alias
--------------------------------------------------------------------------------
/source/_static/scss/includes/_base.scss:
--------------------------------------------------------------------------------
1 | * {
2 | box-sizing: border-box;
3 | -webkit-font-smoothing: antialiased;
4 | -moz-osx-font-smoothing: grayscale;
5 |
6 | &:focus,
7 | &:active {
8 | outline: none;
9 | }
10 | }
11 |
12 | html {
13 | font-size: $root-font-size;
14 | scroll-padding: 1rem;
15 |
16 | @include breakpoint-min(breakpoints(lg)) {
17 | &.read-mode {
18 | body {
19 | height: 100vh;
20 | overflow: hidden;
21 | }
22 | }
23 | }
24 | }
25 |
26 | body {
27 | all: unset;
28 | font-family: $font-family-base;
29 | font-size: 1rem;
30 | line-height: $body-line-height;
31 | color: var(--text-color);
32 | font-weight: $font-weight-normal;
33 | background-color: var(--body-bg);
34 | display: flex;
35 | flex-direction: column;
36 | word-break: break-word;
37 | overflow-x: hidden;
38 | font-variant-ligatures: none;
39 |
40 | @include breakpoint-min(breakpoints(xl)) {
41 | background: url(../img/bg.png) no-repeat top 5rem right;
42 | background-size: 120px;
43 | }
44 | }
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/gcs.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/rancher.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/extra/examples/ReplicationAdminPolicy.json:
--------------------------------------------------------------------------------
1 | {
2 | "Version": "2012-10-17",
3 | "Statement": [
4 | {
5 | "Action": [
6 | "admin:SetBucketTarget",
7 | "admin:GetBucketTarget",
8 | "admin:ListBatchJobs",
9 | "admin:DescribeBatchJob",
10 | "admin:StartBatchJob",
11 | "admin:CancelBatchJob"
12 | ],
13 | "Effect": "Allow",
14 | "Sid": "EnableRemoteBucketConfiguration"
15 | },
16 | {
17 | "Effect": "Allow",
18 | "Action": [
19 | "s3:GetReplicationConfiguration",
20 | "s3:ListBucket",
21 | "s3:ListBucketMultipartUploads",
22 | "s3:GetBucketLocation",
23 | "s3:GetBucketVersioning",
24 | "s3:GetObjectRetention",
25 | "s3:GetObjectLegalHold",
26 | "s3:PutReplicationConfiguration"
27 | ],
28 | "Resource": [
29 | "arn:aws:s3:::*"
30 | ],
31 | "Sid": "EnableReplicationRuleConfiguration"
32 | }
33 | ]
34 | }
35 |
--------------------------------------------------------------------------------
/source/reference/minio-server/settings/iam.rst:
--------------------------------------------------------------------------------
1 | .. _minio-server-envvar-iam:
2 |
3 | =======================================
4 | Identity and Access Management Settings
5 | =======================================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | The pages in this section document settings for configuring MinIO to work with identity and access management (IAM) solutions.
14 | There is a page of settings for each of the IAM methods MinIO supports.
15 |
16 | - :ref:`Active Directory / LDAP `
17 | - :ref:`OpenID `
18 | - :ref:`MinIO Identity Management Plugin `
19 | - :ref:`MinIO Access Management Plugin `
20 |
21 | .. toctree::
22 | :titlesonly:
23 | :hidden:
24 |
25 | /reference/minio-server/settings/iam/ldap
26 | /reference/minio-server/settings/iam/openid
27 | /reference/minio-server/settings/iam/minio-identity-plugin
28 | /reference/minio-server/settings/iam/minio-access-plugin
--------------------------------------------------------------------------------
/source/includes/k8s/deploy-tenant-requirements.rst:
--------------------------------------------------------------------------------
1 | .. start-local-persistent-volume
2 |
3 | .. code-block:: yaml
4 | :class: copyable
5 | :emphasize-lines: 4, 12, 14, 22
6 |
7 | apiVersion: v1
8 | kind: PersistentVolume
9 | metadata:
10 | name:
11 | spec:
12 | capacity:
13 | storage: 1Ti
14 | volumeMode: Filesystem
15 | accessModes:
16 | - ReadWriteOnce
17 | persistentVolumeReclaimPolicy: Retain
18 | storage-class:
19 | local:
20 | path:
21 | nodeAffinity:
22 | required:
23 | nodeSelectorTerms:
24 | - matchExpressions:
25 | - key: kubernetes.io/hostname
26 | operator: In
27 | values:
28 | -
29 |
30 | .. end-local-persistent-volume
31 |
32 | .. start-storage-class
33 |
34 | .. code-block:: yaml
35 | :class: copyable
36 |
37 | apiVersion: storage.k8s.io/v1
38 | kind: StorageClass
39 | metadata:
40 | name: minio-local-storage
41 | provisioner: kubernetes.io/no-provisioner
42 | volumeBindingMode: WaitForFirstConsumer
43 |
44 | .. end-storage-class
45 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/tanzu.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/erasure-code-calculator.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/scss/includes/_mixins.scss:
--------------------------------------------------------------------------------
1 | // Get theme colors
2 | @function breakpoints($key) {
3 | @return map-get($breakpoints, $key);
4 | }
5 |
6 |
7 | // Breakpoints
8 | @mixin breakpoint-min($bp) {
9 | @media (min-width: $bp) {
10 | @content;
11 | }
12 | }
13 |
14 | @mixin breakpoint-max($bp) {
15 | @media (max-width: ($bp - 1)) {
16 | @content;
17 | }
18 | }
19 |
20 | @mixin breakpoint-between($lower, $upper) {
21 | @media (min-width: $lower) and (max-width: ($upper - 1)) {
22 | @content;
23 | }
24 | }
25 |
26 | // Hide Scrollbars
27 | @mixin hide-scrollbars {
28 | overflow: -moz-scrollbars-none;
29 | -ms-overflow-style: none;
30 |
31 | &::-webkit-scrollbar {
32 | display: none;
33 | width: 0;
34 | }
35 | }
36 |
37 | // Dark/Light Theme
38 | @mixin theme-switch($map) {
39 | :root {
40 | &:not(.dark-mode) {
41 | @each $property, $value in $map {
42 | $light: nth($value, 1);
43 | $dark: nth($value, 2);
44 |
45 | #{$property}: #{$light};
46 | }
47 | }
48 |
49 | &.dark-mode {
50 | @each $property, $value in $map {
51 | $light: nth($value, 1);
52 | $dark: nth($value, 2);
53 |
54 | #{$property}: #{$dark};
55 | }
56 | }
57 | }
58 |
59 | }
--------------------------------------------------------------------------------
/source/operations/checklists.rst:
--------------------------------------------------------------------------------
1 | =====================
2 | Deployment Checklists
3 | =====================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | The following checklists provide a high-level guideline for validating production-readiness of MinIO deployments.
12 |
13 | These checklists may not meet the precise requirements of your unique deployment topology or architecture, and are intended as a best-effort guide to reliable production deployments.
14 |
15 | |subnet| users can `log in `__ and create a new issue for pre-production deployment reviews.
16 | Coordination with MinIO Engineering via SUBNET ensures end-to-end support for performant and reliable deployments.
17 |
18 | Community users can seek support on the `MinIO Community Slack `__.
19 | Community Support is best-effort only and has no SLAs around responsiveness.
20 |
21 | Checklists:
22 |
23 | - :ref:`Hardware Checklist `
24 | - :ref:`Security Checklist `
25 | - :ref:`Software Checklist `
26 |
27 | .. toctree::
28 | :titlesonly:
29 | :hidden:
30 | :glob:
31 |
32 | /operations/checklists/*
--------------------------------------------------------------------------------
/source/_static/img/icons/play.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/source/operations/deployments/baremetal.rst:
--------------------------------------------------------------------------------
1 | .. _minio-baremetal:
2 | .. _minio-installation-platform-support:
3 | .. _deploy-minio-distributed-baremetal:
4 |
5 | =========================
6 | Deploy MinIO on Baremetal
7 | =========================
8 |
9 | .. default-domain:: minio
10 |
11 | .. contents:: Table of Contents
12 | :local:
13 | :depth: 1
14 |
15 | MinIO supports deploying onto baremetal infrastructure - physical machines or virtualized hosts - running Linux, MacOS, and Windows.
16 | You can also deploy MinIO as a container onto supported Operating Systems.
17 |
18 | - :ref:`Deploy MinIO onto RedHat Linux `
19 | - :ref:`Deploy MinIO onto Ubuntu Linux `
20 | - :ref:`Deploy MinIO onto Apple MacOS `
21 | - :ref:`Deploy MinIO as a Container `
22 | - :ref:`Deploy MinIO onto Microsoft Windows `
23 |
24 | .. toctree::
25 | :titlesonly:
26 | :hidden:
27 |
28 | /operations/deployments/baremetal-deploy-minio-server
29 | /operations/deployments/baremetal-upgrade-minio-deployment
30 | /operations/deployments/baremetal-expand-minio-deployment
31 | /operations/deployments/baremetal-decommission-server-pool
32 | /operations/deployments/baremetal-migrate-fs-gateway
--------------------------------------------------------------------------------
/source/reference/minio-server/settings/ilm.rst:
--------------------------------------------------------------------------------
1 | .. _minio-server-envvar-ilm:
2 |
3 | ============
4 | ILM Settings
5 | ============
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | This page covers settings that control Information Lifecycle Management (ILM) for the MinIO process.
14 |
15 | .. include:: /includes/common-mc-admin-config.rst
16 | :start-after: start-minio-settings-defined
17 | :end-before: end-minio-settings-defined
18 |
19 | .. include:: /includes/common-mc-admin-config.rst
20 | :start-after: start-minio-settings-test-before-prod
21 | :end-before: end-minio-settings-test-before-prod
22 |
23 | Expiration Workers
24 | ------------------
25 |
26 | .. tab-set::
27 |
28 | .. tab-item:: Environment Variable
29 | :sync: envvar
30 |
31 | .. envvar:: MINIO_ILM_EXPIRATION_WORKERS
32 |
33 | .. tab-item:: Configuration Setting
34 | :sync: config
35 |
36 | .. mc-conf:: ilm expiration_workers
37 | :delimiter: " "
38 |
39 | .. versionadded:: MinIO Server RELEASE.2024-03-03T17-50-39Z
40 |
41 | Set the number of workers to use for :ref:`expiring objects `.
42 | Valid values are ``1`` to ``500``.
43 |
44 | The default value is ``100``.
45 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/ref-hardware.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/versioning.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/s3.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/integrations.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/subnet.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-scanner.rst:
--------------------------------------------------------------------------------
1 | ====================
2 | ``mc admin scanner``
3 | ====================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin scanner
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-admin-scanner-desc
18 |
19 | The :mc:`mc admin scanner` commands provide information about the :ref:`scanner ` process.
20 |
21 | .. end-mc-admin-scanner-desc
22 |
23 | Subcommands
24 | -----------
25 |
26 | :mc:`mc admin scanner` includes the following subcommands:
27 |
28 | .. list-table::
29 | :header-rows: 1
30 | :widths: 30 70
31 | :width: 100%
32 |
33 | * - Subcommand
34 | - Description
35 |
36 | * - :mc:`~mc admin scanner status`
37 | - .. include:: /reference/minio-mc-admin/mc-admin-scanner-status.rst
38 | :start-after: start-mc-admin-scanner-status-desc
39 | :end-before: end-mc-admin-scanner-status-desc
40 |
41 | * - :mc:`~mc admin scanner trace`
42 | - .. include:: /reference/minio-mc-admin/mc-admin-scanner-trace.rst
43 | :start-after: start-mc-admin-scanner-trace-desc
44 | :end-before: end-mc-admin-scanner-trace-desc
45 |
46 | .. toctree::
47 | :titlesonly:
48 | :hidden:
49 |
50 | /reference/minio-mc-admin/mc-admin-scanner-status
51 | /reference/minio-mc-admin/mc-admin-scanner-trace
52 |
--------------------------------------------------------------------------------
/source/includes/common-bucket-notifications.rst:
--------------------------------------------------------------------------------
1 | .. start-bucket-notification-find-arn
2 |
3 | .. admonition:: Identifying the ARN for your bucket notifications
4 | :class: note
5 |
6 | You defined the ```` to assign to the target ARN for your bucket notifications when creating the endpoint previously.
7 | The steps below return the ARNs configured on the deployment.
8 | Identify the ARN created previously by looking for the ```` you specified.
9 |
10 | **Review the JSON output**
11 |
12 | #. Copy and run the following command, replacing ``ALIAS`` with the :ref:`alias ` of the deployment.
13 |
14 | .. code-block:: shell
15 | :class: copyable
16 |
17 | mc admin info --json ALIAS
18 |
19 | #. In the JSON output, look for the key ``info.sqsARN``.
20 |
21 | The ARN you need is the value of that key that matches the ```` you specified.
22 |
23 | For example, |ARN|.
24 |
25 | **Use jq to parse the JSON for the value**
26 |
27 | #. `Install jq `_
28 | #. Copy and run the following command, replacing ``ALIAS`` with the :ref:`alias ` of the deployment.
29 |
30 | .. code-block:: shell
31 | :class: copyable
32 |
33 | mc admin info --json ALIAS | jq .info.sqsARN
34 |
35 | This returns the ARN to use for notifications, such as |ARN|
36 |
37 | .. end-bucket-notification-find-arn
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/cache.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/workflows/makefile.yml:
--------------------------------------------------------------------------------
1 | name: Makefile CI
2 |
3 | on:
4 | push:
5 | branches: [ "main" ]
6 |
7 | jobs:
8 | build:
9 |
10 | runs-on: ubuntu-latest
11 |
12 | steps:
13 | - name: checkout
14 | uses: actions/checkout@v4
15 |
16 | - name: install-python
17 | uses: actions/setup-python@v5
18 | with:
19 | python-version: '3.12'
20 |
21 | - name: pip-requirements
22 | run: pip install -r requirements.txt
23 |
24 | - name: npm-setup
25 | uses: actions/setup-node@v4
26 | with:
27 | node-version: 20
28 |
29 | - name: npm-install-setup
30 | uses: bahmutov/npm-install@v1
31 | with:
32 | working-directory: ./
33 |
34 | - name: build-docs
35 | run: ./build-docs-ci.sh
36 |
37 | - name: upload-artifact
38 | uses: actions/upload-artifact@v4
39 | with:
40 | name: assets
41 | compression-level: 9
42 | path: ./minio
43 |
44 | - name: Publishing
45 | uses: burnett01/rsync-deployments@7.0.2
46 | with:
47 | path: ./minio/
48 | switches: --mkpath -rv --delete
49 | remote_path: ${{ secrets.DEPLOY_PATH }}/${{ github.event.pull_request.head.ref }}
50 | remote_host: ${{ secrets.DEPLOY_HOST }}
51 | remote_port: ${{ secrets.DEPLOY_PORT }}
52 | remote_user: ${{ secrets.DEPLOY_USER }}
53 | remote_key: ${{ secrets.DEPLOY_KEY }}
54 | remote_key_pass: ${{ secrets.DEPLOY_KEY_PASS }}
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-prometheus.rst:
--------------------------------------------------------------------------------
1 | =======================
2 | ``mc admin prometheus``
3 | =======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin prometheus
12 |
13 | Description
14 | -----------
15 |
16 | .. start-mc-admin-prometheus-desc
17 |
18 | The :mc:`mc admin prometheus` command and its subcommands provide access to MinIO Prometheus metrics.
19 |
20 | .. end-mc-admin-prometheus-desc
21 |
22 | Subcommands
23 | -----------
24 |
25 | :mc:`mc admin prometheus` includes the following subcommands:
26 |
27 | .. list-table::
28 | :header-rows: 1
29 | :widths: 30 70
30 | :width: 100%
31 |
32 | * - Subcommand
33 | - Description
34 |
35 | * - :mc:`~mc admin prometheus generate`
36 | - .. include:: /reference/minio-mc-admin/mc-admin-prometheus-generate.rst
37 | :start-after: start-mc-admin-prometheus-generate-desc
38 | :end-before: end-mc-admin-prometheus-generate-desc
39 |
40 | * - :mc:`~mc admin prometheus metrics`
41 | - .. include:: /reference/minio-mc-admin/mc-admin-prometheus-metrics.rst
42 | :start-after: start-mc-admin-prometheus-metrics-desc
43 | :end-before: end-mc-admin-prometheus-metrics-desc
44 |
45 | .. toctree::
46 | :titlesonly:
47 | :hidden:
48 |
49 | /reference/minio-mc-admin/mc-admin-prometheus-generate
50 | /reference/minio-mc-admin/mc-admin-prometheus-metrics
51 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-tag.rst:
--------------------------------------------------------------------------------
1 | ==========
2 | ``mc tag``
3 | ==========
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc tag
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-tag-desc
18 |
19 | The :mc:`mc tag` command adds, removes, and lists tags associated to a bucket or object.
20 |
21 | .. end-mc-tag-desc
22 |
23 | MinIO supports adding up to 10 custom tags to an object.
24 |
25 | Subcommands
26 | -----------
27 |
28 | :mc:`mc tag` includes the following subcommands:
29 |
30 | .. list-table::
31 | :header-rows: 1
32 | :widths: 30 70
33 | :width: 100%
34 |
35 | * - Subcommand
36 | - Description
37 |
38 | * - :mc:`~mc tag list`
39 | - .. include:: /reference/minio-mc/mc-tag-list.rst
40 | :start-after: start-mc-tag-list-desc
41 | :end-before: end-mc-tag-list-desc
42 |
43 | * - :mc:`~mc tag remove`
44 | - .. include:: /reference/minio-mc/mc-tag-remove.rst
45 | :start-after: start-mc-tag-remove-desc
46 | :end-before: end-mc-tag-remove-desc
47 |
48 | * - :mc:`~mc tag set`
49 | - .. include:: /reference/minio-mc/mc-tag-set.rst
50 | :start-after: start-mc-tag-set-desc
51 | :end-before: end-mc-tag-set-desc
52 |
53 | .. toctree::
54 | :titlesonly:
55 | :hidden:
56 |
57 | /reference/minio-mc/mc-tag-set
58 | /reference/minio-mc/mc-tag-list
59 | /reference/minio-mc/mc-tag-remove
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-template.rst:
--------------------------------------------------------------------------------
1 | :orphan:
2 |
3 | ..
4 |
5 | Use this file as a template for adding new MinIO `mc` commands and
6 | subcommands.
7 |
8 | .. _minio-mc-COMMAND:
9 |
10 | ============================
11 | ``mc COMMAND``
12 | ============================
13 |
14 | .. default-domain:: minio
15 |
16 | .. contents:: Table of Contents
17 | :local:
18 | :depth: 2
19 |
20 | .. mc:: mc COMMAND
21 |
22 | Syntax
23 | ------
24 |
25 | .. start-mc-COMMAND-desc
26 |
27 | The :mc:`mc COMMAND` command DESCRIPTION
28 |
29 | .. end-mc-COMMAND-desc
30 |
31 | .. code-block:: shell
32 |
33 | mc [GLOBALFLAGS] COMMAND FLAGS [FLAGS] ARGUMENTS [ARGUMENTS]
34 |
35 | Parameters
36 | ~~~~~~~~~~
37 |
38 | ..
39 |
40 | Document all arguments here:
41 |
42 | .. mc-cmd:: ARGUMENT
43 |
44 | *Required|Optional* Describe the argument here
45 |
46 |
47 | ..
48 |
49 | Document all flags here
50 |
51 | .. mc-cmd:: FLAG
52 |
53 | *Required|Optional* Describe the flag here
54 |
55 | Global Flags
56 | ~~~~~~~~~~~~
57 |
58 | .. include:: /includes/common-minio-mc.rst
59 | :start-after: start-minio-mc-globals
60 | :end-before: end-minio-mc-globals
61 |
62 | Examples
63 | --------
64 |
65 | ..
66 |
67 | Document all examples here
68 |
69 | Use action-based titles:
70 |
71 | Enable | Configure | Modify | Deploy | Set
72 |
73 | Behavior
74 | --------
75 |
76 | ..
77 |
78 | Document all behaviors here
79 |
80 | Be descriptive to improve searchability / SEO
81 |
--------------------------------------------------------------------------------
/source/includes/code/keyrotate.yaml:
--------------------------------------------------------------------------------
1 | keyrotate:
2 | apiVersion: v1
3 | bucket: BUCKET
4 | prefix: PREFIX
5 | encryption:
6 | type: sse-s3 # valid values are sse-s3 and sse-kms
7 | key: # valid only for sse-kms
8 | context: # valid only for sse-kms
9 |
10 | # optional flags based filtering criteria
11 | # for all objects
12 | flags:
13 | filter:
14 | newerThan: "7d" # match objects newer than this value (e.g. 7d10h31s)
15 | olderThan: "7d" # match objects older than this value (e.g. 7d10h31s)
16 | createdAfter: "date" # match objects created after this date and time in RFC3339 format
17 | createdBefore: "date" # match objects created before this date and time in RFC3339 format
18 | tags:
19 | - key: "name"
20 | value: "pick*" # match objects with tag 'name', with all values starting with 'pick'
21 | metadata:
22 | - key: "content-type"
23 | value: "image/*" # match objects with 'content-type', with all values starting with 'image/'
24 | kmskey: "key-id" # match objects with KMS key-id (applicable only for sse-kms)
25 | notify:
26 | endpoint: "https://notify.endpoint" # notification endpoint to receive job status events
27 | token: "Bearer xxxxx" # optional authentication token for the notification endpoint
28 | retry:
29 | attempts: 10 # number of retries for the job before giving up
30 | delay: "500ms" # least amount of delay between each retry
31 |
--------------------------------------------------------------------------------
/source/includes/common-minio-mc.rst:
--------------------------------------------------------------------------------
1 | .. start-minio-mc-globals
2 |
3 | This command supports any of the :ref:`global flags `.
4 |
5 | .. end-minio-mc-globals
6 |
7 | .. start-minio-mc-json-globals
8 |
9 | .. mc-cmd:: --json
10 | :optional:
11 |
12 | Enables `JSON lines `_ formatted output to the
13 | console.
14 |
15 | For example:
16 |
17 | .. code-block:: shell
18 | :class: copyable
19 |
20 | mc --json COMMAND
21 |
22 | .. end-minio-mc-json-globals
23 |
24 | .. start-minio-mc-no-flags
25 |
26 | This command supports only global flags
27 |
28 | .. end-minio-mc-no-flags
29 |
30 | .. start-minio-mc-s3-compatibility
31 |
32 | The :program:`mc` commandline tool is built for compatibility with the AWS S3
33 | API and is tested with MinIO and AWS S3 for expected functionality and behavior.
34 |
35 | MinIO provides no guarantees for other S3-compatible services, as their S3 API
36 | implementation is unknown and therefore unsupported. While :program:`mc`
37 | commands *may* work as documented, any such usage is at your own risk.
38 |
39 | .. end-minio-mc-s3-compatibility
40 |
41 | .. start-minio-syntax
42 |
43 | - Brackets ``[]`` indicate optional parameters.
44 | - Parameters sharing a line are mutually dependent.
45 | - Parameters separated using the pipe ``|`` operator are mutually exclusive.
46 |
47 | Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.
48 |
49 | .. end-minio-syntax
50 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-share.rst:
--------------------------------------------------------------------------------
1 | ============
2 | ``mc share``
3 | ============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc share
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-share-desc
18 |
19 | Use the :mc:`mc share` commands to manage presigned URLs for downloading and uploading objects to a MinIO bucket.
20 |
21 | .. end-mc-share-desc
22 |
23 | Subcommands
24 | -----------
25 |
26 | :mc:`mc share` includes the following subcommands:
27 |
28 | .. list-table::
29 | :header-rows: 1
30 | :widths: 30 70
31 | :width: 100%
32 |
33 | * - Subcommand
34 | - Description
35 |
36 | * - :mc:`~mc share download`
37 | - .. include:: /reference/minio-mc/mc-share-download.rst
38 | :start-after: start-mc-share-download-desc
39 | :end-before: end-mc-share-download-desc
40 |
41 | * - :mc:`~mc share list`
42 | - .. include:: /reference/minio-mc/mc-share-list.rst
43 | :start-after: start-mc-share-list-desc
44 | :end-before: end-mc-share-list-desc
45 |
46 | * - :mc:`~mc share upload`
47 | - .. include:: /reference/minio-mc/mc-share-upload.rst
48 | :start-after: start-mc-share-upload-desc
49 | :end-before: end-mc-share-upload-desc
50 |
51 | .. toctree::
52 | :titlesonly:
53 | :hidden:
54 |
55 | /reference/minio-mc/mc-share-download
56 | /reference/minio-mc/mc-share-upload
57 | /reference/minio-mc/mc-share-list
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-update.rst:
--------------------------------------------------------------------------------
1 | =============
2 | ``mc update``
3 | =============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 1
10 |
11 | .. mc:: mc update
12 |
13 | Syntax
14 | ------
15 |
16 | .. start-mc-update-desc
17 |
18 | The :mc:`mc update` command automatically updates the :program:`mc` binary to
19 | the latest stable version.
20 |
21 | .. end-mc-update-desc
22 |
23 | Running this command is equivalent to manually downloading the latest
24 | stable binary and using it to replace the existing ``mc`` installation on the
25 | host machine.
26 |
27 | .. tab-set::
28 |
29 | .. tab-item:: EXAMPLE
30 |
31 | The following command updates the :program:`mc` binary on the local host:
32 |
33 | .. code-block:: shell
34 | :class: copyable
35 |
36 | mc update
37 |
38 | .. tab-item:: SYNTAX
39 |
40 | The command has the following syntax:
41 |
42 | .. code-block:: shell
43 | :class: copyable
44 |
45 | mc [GLOBALFLAGS] update
46 |
47 | .. include:: /includes/common-minio-mc.rst
48 | :start-after: start-minio-syntax
49 | :end-before: end-minio-syntax
50 |
51 | Use :mc:`mc update` after updating the :program:`minio` server binary to
52 | ensure consistent behavior and compatibility.
53 |
54 | Global Flags
55 | ~~~~~~~~~~~~
56 |
57 | .. include:: /includes/common-minio-mc.rst
58 | :start-after: start-minio-mc-json-globals
59 | :end-before: end-minio-mc-json-globals
60 |
--------------------------------------------------------------------------------
/source/_static/scss/includes/_font.scss:
--------------------------------------------------------------------------------
1 | @font-face {
2 | font-family: Geist;
3 | src: url(../fonts/geist/Geist-Bold.woff2) format("woff2");
4 | font-weight: 700;
5 | font-style: normal;
6 | font-display: swap;
7 | }
8 | @font-face {
9 | font-family: Geist;
10 | src: url(../fonts/geist/Geist-Regular.woff2) format("woff2");
11 | font-weight: 400;
12 | font-style: normal;
13 | font-display: swap;
14 | }
15 | @font-face {
16 | font-family: Geist;
17 | src: url(../fonts/geist/Geist-Medium.woff2) format("woff2");
18 | font-weight: 500;
19 | font-style: normal;
20 | font-display: swap;
21 | }
22 | @font-face {
23 | font-family: Geist Mono;
24 | src: url(../fonts/geist-mono/GeistMono-Regular.woff2) format("woff2");
25 | font-weight: 400;
26 | font-style: normal;
27 | font-display: swap;
28 | }
29 |
30 | @font-face {
31 | font-family: Satoshi;
32 | src: url(../fonts/satoshi/Satoshi-Bold.woff2) format("woff2");
33 | font-weight: 700;
34 | font-style: normal;
35 | font-display: swap;
36 | }
37 | @font-face {
38 | font-family: Satoshi;
39 | src: url(../fonts/satoshi/Satoshi-Regular.woff2) format("woff2");
40 | font-weight: 400;
41 | font-style: normal;
42 | font-display: swap;
43 | }
44 | @font-face {
45 | font-family: Satoshi;
46 | src: url(../fonts/satoshi/Satoshi-Medium.woff2) format("woff2");
47 | font-weight: 500;
48 | font-style: normal;
49 | font-display: swap;
50 | }
--------------------------------------------------------------------------------
/source/extra/examples/ReplicationRemoteUserPolicy.json:
--------------------------------------------------------------------------------
1 | {
2 | "Version": "2012-10-17",
3 | "Statement": [
4 | {
5 | "Effect": "Allow",
6 | "Action": [
7 | "s3:GetReplicationConfiguration",
8 | "s3:ListBucket",
9 | "s3:ListBucketMultipartUploads",
10 | "s3:GetBucketLocation",
11 | "s3:GetBucketVersioning",
12 | "s3:GetBucketObjectLockConfiguration",
13 | "s3:GetEncryptionConfiguration"
14 | ],
15 | "Resource": [
16 | "arn:aws:s3:::*"
17 | ],
18 | "Sid": "EnableReplicationOnBucket"
19 | },
20 | {
21 | "Effect": "Allow",
22 | "Action": [
23 | "s3:GetReplicationConfiguration",
24 | "s3:ReplicateTags",
25 | "s3:AbortMultipartUpload",
26 | "s3:GetObject",
27 | "s3:GetObjectVersion",
28 | "s3:GetObjectVersionTagging",
29 | "s3:PutObject",
30 | "s3:PutObjectRetention",
31 | "s3:PutBucketObjectLockConfiguration",
32 | "s3:PutObjectLegalHold",
33 | "s3:DeleteObject",
34 | "s3:ReplicateObject",
35 | "s3:ReplicateDelete"
36 | ],
37 | "Resource": [
38 | "arn:aws:s3:::*"
39 | ],
40 | "Sid": "EnableReplicatingDataIntoBucket"
41 | }
42 | ]
43 | }
--------------------------------------------------------------------------------
/source/reference/deprecated/mc-admin-top.rst:
--------------------------------------------------------------------------------
1 | ================
2 | ``mc admin top``
3 | ================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin top
12 |
13 | .. versionchanged:: RELEASE.2022-08-11T00-30-48Z
14 |
15 | ``mc admin top`` replaced by :mc-cmd:`mc support top`.
16 |
17 | Description
18 | -----------
19 |
20 | .. start-mc-admin-top-desc
21 |
22 | The :mc-cmd:`mc admin top` command returns statistics for distributed
23 | MinIO deployments, similar to the output of the ``top`` command.
24 |
25 | .. end-mc-admin-top-desc
26 |
27 | .. admonition:: Use ``mc admin`` on MinIO Deployments Only
28 | :class: note
29 |
30 | .. include:: /includes/facts-mc-admin.rst
31 | :start-after: start-minio-only
32 | :end-before: end-minio-only
33 |
34 | Syntax
35 | ------
36 |
37 | .. mc-cmd:: locks
38 | :fullpath:
39 |
40 | Returns the 10 oldest locks on the MinIO deployment.
41 |
42 | The command has the following syntax:
43 |
44 | .. code-block:: shell
45 | :class: copyable
46 |
47 | mc admin top locks TARGET
48 |
49 | The command supports the following arguments:
50 |
51 | .. mc-cmd:: TARGET
52 |
53 | The :mc-cmd:`alias ` of a configured MinIO deployment from which
54 | the command retrieves statistics.
55 |
56 | The alias *must* correspond to a distributed (multi-node) MinIO deployment.
57 | The command returns an error for :term:`single-node single-drive` deployments.
58 |
59 |
60 |
--------------------------------------------------------------------------------
/source/_static/scss/includes/_content.scss:
--------------------------------------------------------------------------------
1 | .section-next-steps {
2 | border: 1px solid var(--table-border-color);
3 | border-radius: $border-radius-lg;
4 | margin-top: 3rem;
5 | padding: 1.5rem;
6 |
7 | & > h2 {
8 | margin-top: 0;
9 | }
10 |
11 | & > ul {
12 | margin: 0 0 -0.5rem;
13 | list-style: none;
14 | padding: 0;
15 | counter-reset: list-number;
16 |
17 | & > li {
18 | display: flex;
19 | align-items: start;
20 |
21 | & > p {
22 | flex-grow: 1;
23 |
24 | & > a {
25 | display: block;
26 | padding: 0.65rem 0;
27 | }
28 | }
29 |
30 | &:not(:last-child) {
31 | & > p {
32 | & > a {
33 | border-bottom: 1px dashed var(--table-border-color);
34 | }
35 | }
36 | }
37 |
38 | &:before {
39 | counter-increment: list-number;
40 | content: counter(list-number);
41 | width: 1.5rem;
42 | height: 1.5rem;
43 | border-radius: 50%;
44 | border: 1px solid var(--table-border-color);
45 | margin: 0 1rem 0 -0.2rem;
46 | display: grid;
47 | place-content: center;
48 | font-size: $font-size-sm;
49 | flex-shrink: 0;
50 | margin-top: 0.6rem;
51 | }
52 | }
53 | }
54 | }
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-encrypt.rst:
--------------------------------------------------------------------------------
1 | ==============
2 | ``mc encrypt``
3 | ==============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc encrypt
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-encrypt-desc
18 |
19 | The :mc:`mc encrypt` commands set, update, or disable the default bucket Server-Side Encryption (SSE) mode.
20 | MinIO automatically encrypts objects using the specified SSE mode.
21 |
22 | .. end-mc-encrypt-desc
23 |
24 | Subcommands
25 | -----------
26 |
27 | :mc:`mc encrypt` includes the following subcommands:
28 |
29 | .. list-table::
30 | :header-rows: 1
31 | :widths: 30 70
32 | :width: 100%
33 |
34 | * - Subcommand
35 | - Description
36 |
37 | * - :mc:`~mc encrypt clear`
38 | - .. include:: /reference/minio-mc/mc-encrypt-clear.rst
39 | :start-after: start-mc-encrypt-clear-desc
40 | :end-before: end-mc-encrypt-clear-desc
41 |
42 | * - :mc:`~mc encrypt info`
43 | - .. include:: /reference/minio-mc/mc-encrypt-info.rst
44 | :start-after: start-mc-encrypt-info-desc
45 | :end-before: end-mc-encrypt-info-desc
46 |
47 | * - :mc:`~mc encrypt set`
48 | - .. include:: /reference/minio-mc/mc-encrypt-set.rst
49 | :start-after: start-mc-encrypt-set-desc
50 | :end-before: end-mc-encrypt-set-desc
51 |
52 | .. toctree::
53 | :titlesonly:
54 | :hidden:
55 |
56 | /reference/minio-mc/mc-encrypt-clear
57 | /reference/minio-mc/mc-encrypt-info
58 | /reference/minio-mc/mc-encrypt-set
59 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-legalhold.rst:
--------------------------------------------------------------------------------
1 | ================
2 | ``mc legalhold``
3 | ================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc legalhold
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-legalhold-desc
18 |
19 | The :mc:`mc legalhold` command sets, removes, or retrieves the :ref:`object legal hold (WORM) ` settings for object(s).
20 |
21 | .. end-mc-legalhold-desc
22 |
23 | Subcommands
24 | -----------
25 |
26 | :mc:`mc legalhold` includes the following subcommands:
27 |
28 | .. list-table::
29 | :header-rows: 1
30 | :widths: 30 70
31 | :width: 100%
32 |
33 | * - Subcommand
34 | - Description
35 |
36 | * - :mc:`~mc legalhold clear`
37 | - .. include:: /reference/minio-mc/mc-legalhold-clear.rst
38 | :start-after: start-mc-legalhold-clear-desc
39 | :end-before: end-mc-legalhold-clear-desc
40 |
41 | * - :mc:`~mc legalhold info`
42 | - .. include:: /reference/minio-mc/mc-legalhold-info.rst
43 | :start-after: start-mc-legalhold-info-desc
44 | :end-before: end-mc-legalhold-info-desc
45 |
46 | * - :mc:`~mc legalhold set`
47 | - .. include:: /reference/minio-mc/mc-legalhold-set.rst
48 | :start-after: start-mc-legalhold-set-desc
49 | :end-before: end-mc-legalhold-set-desc
50 |
51 | .. toctree::
52 | :titlesonly:
53 | :hidden:
54 |
55 | /reference/minio-mc/mc-legalhold-clear
56 | /reference/minio-mc/mc-legalhold-info
57 | /reference/minio-mc/mc-legalhold-set
58 |
--------------------------------------------------------------------------------
/source/includes/linux/minio-client.rst:
--------------------------------------------------------------------------------
1 | .. start-mc-limit-flags-desc
2 |
3 | .. mc-cmd:: --limit-download
4 | :optional:
5 |
6 | Limit client-side download rates to no more than a specified rate in KiB/s, MiB/s, or GiB/s.
7 | This affects only the download to the local device running the MinIO Client.
8 | Valid units include:
9 |
10 | - ``B`` for bytes
11 | - ``K`` for kilobytes
12 | - ``M`` for megabytes
13 | - ``G`` for gigabytes
14 | - ``T`` for terabytes
15 | - ``Ki`` for kibibytes
16 | - ``Mi`` for mibibytes
17 | - ``Gi`` for gibibytes
18 | - ``Ti`` for tebibytes
19 |
20 | For example, to limit download rates to no more than 1 GiB/s, use the following:
21 |
22 | .. code-block::
23 |
24 | --limit-download 1G
25 |
26 | If not specified, MinIO uses an unlimited download rate.
27 |
28 | .. mc-cmd:: --limit-upload
29 | :optional:
30 |
31 | Limit client-side upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s.
32 | This affects only the upload from the local device running the MinIO Client.
33 | Valid units include:
34 |
35 | - ``B`` for bytes
36 | - ``K`` for kilobytes
37 | - ``M`` for megabytes
38 | - ``G`` for gigabytes
39 | - ``T`` for terabytes
40 | - ``Ki`` for kibibytes
41 | - ``Mi`` for mibibytes
42 | - ``Gi`` for gibibytes
43 | - ``Ti`` for tebibytes
44 |
45 | For example, to limit upload rates to no more than 1 GiB/s, use the following:
46 |
47 | .. code-block::
48 |
49 | --limit-upload 1G
50 |
51 | If not specified, MinIO uses an unlimited upload rate.
52 |
53 | .. end-mc-limit-flags-desc
--------------------------------------------------------------------------------
/source/_static/scss/includes/_layout.scss:
--------------------------------------------------------------------------------
1 |
2 | :root {
3 | --content-padding: 1.75rem;
4 |
5 | @include breakpoint-max(breakpoints(lg)) {
6 | --content-padding: 1.25rem;
7 | }
8 |
9 | &.locked {
10 | &,
11 | body,
12 | .content {
13 | overflow: hidden;
14 | }
15 | }
16 | }
17 |
18 | .content {
19 | flex: 1;
20 |
21 | @include breakpoint-min(breakpoints(lg)) {
22 | & > .container {
23 | display: flex;
24 | }
25 | }
26 | }
27 |
28 | .content__main {
29 | flex: 1;
30 | min-width: 0;
31 | padding: var(--content-padding);
32 | }
33 |
34 | .container {
35 | margin: 0 auto;
36 | padding: 0 var(--content-padding);
37 | width: 100%;
38 | }
39 |
40 | :root {
41 | &:not(.read-mode) {
42 | .container {
43 | max-width: $container-width;
44 | }
45 | }
46 |
47 | &.read-mode {
48 | .content {
49 | @include breakpoint-min(breakpoints(lg)) {
50 | overflow: auto;
51 | scroll-padding: 2rem;
52 | }
53 |
54 | & > .container {
55 | padding-inline: 0;
56 | }
57 | }
58 | }
59 | }
60 |
61 | // Keep only the main content when the page is loaded inside an iframe.
62 | // Currently we load certain pages inside iframes for PathFactory analytics.
63 | .inside-iframe {
64 | .header,
65 | .sidebar {
66 | display: none;
67 | }
68 |
69 | .content {
70 | height: 100vh;
71 | }
72 |
73 | .content__main {
74 | padding-left: var(--content-padding);
75 | }
76 | }
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-license.rst:
--------------------------------------------------------------------------------
1 | ==============
2 | ``mc license``
3 | ==============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc license
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-license-desc
18 |
19 | The :mc:`mc license` commands work with cluster registration for |SUBNET|.
20 | Use the commands to register a deployment, display information about the cluster's current license, or update the license key for a cluster.
21 |
22 | .. end-mc-license-desc
23 |
24 | Subcommands
25 | -----------
26 |
27 | :mc:`mc license` includes the following subcommands:
28 |
29 | .. list-table::
30 | :header-rows: 1
31 | :widths: 30 70
32 | :width: 100%
33 |
34 | * - Subcommand
35 | - Description
36 |
37 | * - :mc:`~mc license info`
38 | - .. include:: /reference/minio-mc/mc-license-info.rst
39 | :start-after: start-mc-license-info-desc
40 | :end-before: end-mc-license-info-desc
41 |
42 | * - :mc:`~mc license register`
43 | - .. include:: /reference/minio-mc/mc-license-register.rst
44 | :start-after: start-mc-license-register-desc
45 | :end-before: end-mc-license-register-desc
46 |
47 | * - :mc:`~mc license update`
48 | - .. include:: /reference/minio-mc/mc-license-update.rst
49 | :start-after: start-mc-license-update-desc
50 | :end-before: end-mc-license-update-desc
51 |
52 | .. toctree::
53 | :titlesonly:
54 | :hidden:
55 |
56 | /reference/minio-mc/mc-license-info
57 | /reference/minio-mc/mc-license-register
58 | /reference/minio-mc/mc-license-update
59 |
--------------------------------------------------------------------------------
/source/extra/examples/minio-dev.yaml:
--------------------------------------------------------------------------------
1 | # Deploys a new Namespace for the MinIO Pod
2 | apiVersion: v1
3 | kind: Namespace
4 | metadata:
5 | name: minio-dev # Change this value if you want a different namespace name
6 | labels:
7 | name: minio-dev # Change this value to match metadata.name
8 | ---
9 | # Deploys a new MinIO Pod into the metadata.namespace Kubernetes namespace
10 | #
11 | # The `spec.containers[0].args` contains the command run on the pod
12 | # The `/data` directory corresponds to the `spec.containers[0].volumeMounts[0].mountPath`
13 | # That mount path corresponds to a Kubernetes HostPath which binds `/data` to a local drive or volume on the worker node where the pod runs
14 | #
15 | apiVersion: v1
16 | kind: Pod
17 | metadata:
18 | labels:
19 | app: minio
20 | name: minio
21 | namespace: minio-dev # Change this value to match the namespace metadata.name
22 | spec:
23 | containers:
24 | - name: minio
25 | image: quay.io/minio/minio:latest
26 | command:
27 | - /bin/bash
28 | - -c
29 | args:
30 | - minio server /data --console-address :9001
31 | volumeMounts:
32 | - mountPath: /data
33 | name: localvolume # Corresponds to the `spec.volumes` Persistent Volume
34 | nodeSelector:
35 | kubernetes.io/hostname: kubealpha.local # Specify a node label associated to the Worker Node on which you want to deploy the pod.
36 | volumes:
37 | - name: localvolume
38 | hostPath: # MinIO generally recommends using locally-attached volumes
39 | path: /mnt/disk1/data # Specify a path to a local drive or volume on the Kubernetes worker node
40 | type: DirectoryOrCreate # The path to the last directory must exist
41 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-support-top.rst:
--------------------------------------------------------------------------------
1 | ==================
2 | ``mc support top``
3 | ==================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc support top
12 |
13 | .. note::
14 |
15 | .. versionchanged:: RELEASE.2022-08-11T00-30-48Z
16 |
17 | ``mc support top`` replaces the ``mc admin top`` command.
18 |
19 | .. include:: /includes/common-mc-support.rst
20 | :start-after: start-minio-only
21 | :end-before: end-minio-only
22 |
23 | Description
24 | -----------
25 |
26 | .. start-mc-support-top-desc
27 |
28 | The :mc:`mc support top` command returns statistics for distributed
29 | MinIO deployments, similar to the output of the ``top`` command in a shell.
30 |
31 | .. end-mc-support-top-desc
32 |
33 | .. note::
34 |
35 | :mc:`mc support top` is not supported on single-node single-drive MinIO deployments.
36 |
37 | :mc-cmd:`mc support top` has the following subcommands:
38 |
39 | - :mc-cmd:`~mc support top api`
40 | - :mc-cmd:`~mc support top locks`
41 | - :mc-cmd:`~mc support top disk`
42 | - :mc-cmd:`~mc support top net`
43 | - :mc-cmd:`~mc support top rpc`
44 |
45 | Refer to the pages linked above for each subcommand for details.
46 |
47 | Syntax
48 | ------
49 |
50 | The command has the following syntax:
51 |
52 | .. code-block:: shell
53 |
54 | mc support top COMMAND [COMMAND FLAGS] [ARGUMENTS ...]
55 |
56 | .. toctree::
57 | :titlesonly:
58 | :hidden:
59 |
60 | /reference/minio-mc/mc-support-top-api
61 | /reference/minio-mc/mc-support-top-locks
62 | /reference/minio-mc/mc-support-top-disk
63 | /reference/minio-mc/mc-support-top-net
64 | /reference/minio-mc/mc-support-top-rpc
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-ilm.rst:
--------------------------------------------------------------------------------
1 | ==========
2 | ``mc ilm``
3 | ==========
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc ilm
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-ilm-desc
18 |
19 | The :mc:`mc ilm` commands manage :ref:`object lifecycle management rules ` and tiering on a MinIO deployment.
20 |
21 | .. end-mc-ilm-desc
22 |
23 | Use these command to
24 |
25 | - create tiers
26 | - create :ref:`tiering ` rules
27 | - manage :ref:`expiration ` rules for objects on a bucket
28 |
29 |
30 | Subcommands
31 | -----------
32 |
33 | :mc:`mc ilm` includes the following subcommands:
34 |
35 | .. list-table::
36 | :header-rows: 1
37 | :widths: 30 70
38 | :width: 100%
39 |
40 | * - Subcommand
41 | - Description
42 |
43 | * - :mc:`~mc ilm restore`
44 | - .. include:: /reference/minio-mc/mc-ilm-restore.rst
45 | :start-after: start-mc-ilm-restore-desc
46 | :end-before: end-mc-ilm-restore-desc
47 |
48 | * - :mc:`~mc ilm rule`
49 | - .. include:: /reference/minio-mc/mc-ilm-rule.rst
50 | :start-after: start-mc-ilm-rule-desc
51 | :end-before: end-mc-ilm-rule-desc
52 |
53 | * - :mc:`~mc ilm tier`
54 | - .. include:: /reference/minio-mc/mc-ilm-tier.rst
55 | :start-after: start-mc-ilm-tier-desc
56 | :end-before: end-mc-ilm-tier-desc
57 |
58 | .. toctree::
59 | :titlesonly:
60 | :hidden:
61 |
62 | /reference/minio-mc/mc-ilm-restore
63 | /reference/minio-mc/mc-ilm-rule
64 | /reference/minio-mc/mc-ilm-tier
65 |
--------------------------------------------------------------------------------
/source/reference/minio-server/settings.rst:
--------------------------------------------------------------------------------
1 | .. _minio-environment-variables:
2 | .. _minio-server-environment-variables:
3 | .. _minio-server-configuration-settings:
4 |
5 | =================
6 | Settings Overview
7 | =================
8 |
9 | .. default-domain:: minio
10 |
11 | .. contents:: Table of Contents
12 | :local:
13 | :depth: 2
14 |
15 | The :mc:`minio server` process stores its configuration in the storage backend :mc-cmd:`directory `.
16 |
17 | .. _minio-server-configuration-options:
18 |
19 | MinIO Settings
20 | --------------
21 |
22 | MinIO settings define runtime behavior of the MinIO :mc:`server ` process.
23 |
24 | .. include:: /includes/common-mc-admin-config.rst
25 | :start-after: start-minio-settings-defined
26 | :end-before: end-minio-settings-defined
27 |
28 | .. include:: /includes/common-mc-admin-config.rst
29 | :start-after: start-minio-settings-test-before-prod
30 | :end-before: end-minio-settings-test-before-prod
31 |
32 | Additional settings include those to customize:
33 |
34 | - :ref:`Core settings `
35 | - :ref:`Root credentials `
36 | - :ref:`Storage class `
37 | - :ref:`MinIO Console `
38 | - :ref:`Metrics and logging `
39 | - :ref:`Notification targets ` for use with :ref:`MinIO Bucket Notifications `
40 | - :ref:`Identity and access management solutions `
41 | - :ref:`Key Encryption Service (KES) `
42 | - :ref:`Object Lambda functions `
--------------------------------------------------------------------------------
/source/_static/scss/includes/_variables.scss:
--------------------------------------------------------------------------------
1 | // Colors
2 | $white: #ffffff;
3 | $black: #000000;
4 | $theme-red: #CF163E;
5 |
6 | // Gray shades light
7 | $light-100: #f3f4f6;
8 | $light-200: #e5e7eb;
9 | $light-300: #d1d5db;
10 | $light-400: #9ca3af;
11 | $light-500: #6b7280;
12 |
13 | // Gray shades dark
14 | $dark-0: #19202A;
15 | $dark-100: #212936;
16 | $dark-200: #273140;
17 | $dark-300: #2E394A;
18 | $dark-400: #59667A;
19 | $dark-500: #8A93A4;
20 |
21 | // Theme color palette
22 | $tertiary: #8C8C8C;
23 | $neutral-subtle: #D6DAE1;
24 | $border-subtle: #566176;
25 |
26 | // Breakpoints
27 | $breakpoints: (
28 | xs: 0,
29 | sm: 576px,
30 | md: 768px,
31 | lg: 992px,
32 | xl: 1280px
33 | );
34 |
35 | // z-index
36 | $z-index-header: 11;
37 |
38 | // Body
39 | $font-family-base: 'Geist', sans-serif;
40 | $font-family-heading: 'Satoshi', sans-serif;
41 | $font-family-mono: 'Geist Mono', sans-serif;
42 | $root-font-size: 1rem;
43 | $body-font-size: 1.125rem;
44 | $body-line-height: 1.6;
45 |
46 | // Text
47 | $text-dark-color: #A2ADC0;
48 | $headings-dark-color: #E3EEEF;
49 |
50 | // Font size
51 | $font-size-xs: 12px;
52 | $font-size-sm: 14px;
53 | $font-size-md: 16px;
54 | $font-size-lg: 20px;
55 |
56 | // Layout
57 | $container-width: 1300px;
58 |
59 | // Font weight
60 | $font-weight-normal: 400;
61 | $font-weight-medium: 500;
62 | $font-weight-bold: 700;
63 |
64 | // Header
65 | $header-light-bg: #031733;
66 |
67 | // Sidebar
68 | $sidebar-width: 19.75rem;
69 |
70 | // Border Radius
71 | $border-radius: 4px;
72 | $border-radius-md: 6px;
73 | $border-radius-lg: 8px;
74 | $border-radius-xl: 10px;
75 |
76 |
77 | // Nav - FIXME
78 | $nav-sub-hover-bg: #f8f8f8;
79 | $nav-mobile-bg: $white;
80 | $nav-mobile-width: 300px;
81 | $nav-active-z-index: 100;
--------------------------------------------------------------------------------
/source/includes/facts-versioning.rst:
--------------------------------------------------------------------------------
1 | .. start-rewind-desc
2 |
3 | Directs |command| to operate only on the object version(s) that
4 | existed at specified point-in-time.
5 |
6 | - To rewind to a specific date in the past, specify the date as an
7 | ISO8601-formatted timestamp. For example: ``--rewind "2020.03.24T10:00"``.
8 |
9 | - To rewind a duration in time, specify the duration as a string in
10 | ``#d#hh#mm#ss`` format. For example: ``--rewind "1d2hh3mm4ss"``.
11 |
12 | |rewind| requires that the specified |alias| be an S3-compatible service
13 | that supports :ref:`minio-bucket-versioning`. For MinIO deployments, use
14 | :mc:`mc version` to enable or disable bucket versioning.
15 |
16 | .. end-rewind-desc
17 |
18 | .. start-versions-desc
19 |
20 | Directs |command| to operate on all object versions that exist in the
21 | bucket.
22 |
23 | |versions| requires that the specified |alias| be an S3-compatible service
24 | that supports :ref:`minio-bucket-versioning`. For MinIO deployments, use
25 | :mc:`mc version` to enable or disable bucket versioning.
26 |
27 | .. end-versions-desc
28 |
29 | .. start-version-id-desc
30 |
31 | Directs |command| to operate only on the specified object version.
32 |
33 | |versionid| requires that the specified |alias| be an S3-compatible service
34 | that supports :ref:`minio-bucket-versioning`. For MinIO deployments, use
35 | :mc:`mc version` to enable or disable bucket versioning.
36 |
37 | .. end-version-id-desc
38 |
39 | .. start-versioning-admonition
40 |
41 | .. admonition:: Requires Versioning
42 | :class: note
43 |
44 | |command| requires :ref:`bucket versioning ` to
45 | use this feature. Use :mc:`mc version` to enable versioning on a bucket.
46 |
47 | .. end-versioning-admonition
48 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-event.rst:
--------------------------------------------------------------------------------
1 | ============
2 | ``mc event``
3 | ============
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc event
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-event-desc
18 |
19 | The :mc:`mc event` command supports adding, removing, and listing bucket event notifications.
20 |
21 | .. end-mc-event-desc
22 |
23 | MinIO automatically sends triggered events to the configured notification targets.
24 | MinIO supports notification targets like AMQP (RabbitMQ), Redis, ElasticSearch, NATS and PostgreSQL.
25 | See :ref:`MinIO Bucket Notifications ` for more information.
26 |
27 |
28 | Subcommands
29 | -----------
30 |
31 | :mc:`mc event` includes the following subcommands:
32 |
33 | .. list-table::
34 | :header-rows: 1
35 | :widths: 30 70
36 | :width: 100%
37 |
38 | * - Subcommand
39 | - Description
40 |
41 | * - :mc:`~mc event add`
42 | - .. include:: /reference/minio-mc/mc-event-add.rst
43 | :start-after: start-mc-event-add-desc
44 | :end-before: end-mc-event-add-desc
45 |
46 | * - :mc:`~mc event ls`
47 | - .. include:: /reference/minio-mc/mc-event-list.rst
48 | :start-after: start-mc-event-list-desc
49 | :end-before: end-mc-event-list-desc
50 |
51 | * - :mc:`~mc event rm`
52 | - .. include:: /reference/minio-mc/mc-event-remove.rst
53 | :start-after: start-mc-event-remove-desc
54 | :end-before: end-mc-event-remove-desc
55 |
56 | .. toctree::
57 | :titlesonly:
58 | :hidden:
59 |
60 | /reference/minio-mc/mc-event-add
61 | /reference/minio-mc/mc-event-list
62 | /reference/minio-mc/mc-event-remove
63 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-retention.rst:
--------------------------------------------------------------------------------
1 | ================
2 | ``mc retention``
3 | ================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc retention
12 |
13 |
14 | Description
15 | -----------
16 |
17 | .. start-mc-retention-desc
18 |
19 | The :mc:`mc retention` command configures the :ref:`Write-Once Read-Many (WORM) locking ` settings for an object or object(s) in a bucket.
20 | You can also set the default object lock settings for a bucket, where all objects without explicit object lock settings inherit the bucket default.
21 |
22 | .. end-mc-retention-desc
23 |
24 | Subcommands
25 | -----------
26 |
27 | :mc:`mc retention` includes the following subcommands:
28 |
29 | .. list-table::
30 | :header-rows: 1
31 | :widths: 30 70
32 | :width: 100%
33 |
34 | * - Subcommand
35 | - Description
36 |
37 | * - :mc:`~mc retention clear`
38 | - .. include:: /reference/minio-mc/mc-retention-clear.rst
39 | :start-after: start-mc-retention-clear-desc
40 | :end-before: end-mc-retention-clear-desc
41 |
42 | * - :mc:`~mc retention info`
43 | - .. include:: /reference/minio-mc/mc-retention-info.rst
44 | :start-after: start-mc-retention-info-desc
45 | :end-before: end-mc-retention-info-desc
46 |
47 | * - :mc:`~mc retention set`
48 | - .. include:: /reference/minio-mc/mc-retention-set.rst
49 | :start-after: start-mc-retention-set-desc
50 | :end-before: end-mc-retention-set-desc
51 |
52 | .. toctree::
53 | :titlesonly:
54 | :hidden:
55 |
56 | /reference/minio-mc/mc-retention-set
57 | /reference/minio-mc/mc-retention-info
58 | /reference/minio-mc/mc-retention-clear
--------------------------------------------------------------------------------
/source/developers/security-token-service.rst:
--------------------------------------------------------------------------------
1 | .. _minio-security-token-service:
2 |
3 | ============================
4 | Security Token Service (STS)
5 | ============================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | The MinIO Security Token Service (STS) APIs allow applications to generate temporary credentials for accessing the MinIO deployment.
14 |
15 | The STS API is *required* for MinIO deployments configured to use external identity managers, as the API allows conversion of the external IDP credentials into AWS Signature v4-compatible credentials.
16 |
17 | STS API Endpoints
18 | -----------------
19 |
20 | MinIO supports the following STS API endpoints:
21 |
22 | .. list-table::
23 | :header-rows: 1
24 | :widths: 30 30 40
25 |
26 | * - Endpoint
27 | - Supported IDP
28 | - Description
29 |
30 | * - :ref:`AssumeRoleWithWebIdentity `
31 | - OpenID Connect
32 | - Generates an access key and secret key using the JWT token returned by the OIDC provider
33 |
34 | * - :ref:`AssumeRoleWithLDAPIdentity `
35 | - Active Directory / LDAP
36 | - Generates an access key and secret key using the AD/LDAP credentials specified to the API endpoint.
37 |
38 | * - :ref:`AssumeRoleWithCustomToken `
39 | - MinIO Identity Plugin
40 | - Generates a token for use with an external identity provider and the :ref:`MinIO Identity Plugin `.
41 |
42 |
43 | .. toctree::
44 | :titlesonly:
45 | :hidden:
46 | :glob:
47 |
48 | /developers/security-token-service/*
49 | /developers/sts-for-operator
50 |
--------------------------------------------------------------------------------
/sync-minio-operator-crd.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -e
4 |
5 | function main() {
6 | OPERATOR=$(curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/operator/releases/latest | sed "s/https:\/\/github.com\/minio\/operator\/releases\/tag\///" | sed "s/v//");
7 |
8 | curl --retry 10 -Ls https://raw.githubusercontent.com/minio/operator/v${OPERATOR}/docs/tenant_crd.adoc | asciidoc -b docbook - | pandoc -f docbook -t markdown_strict - -o source/includes/k8s/ext-tenant-crd.md
9 |
10 | curl --retry 10 -Ls https://raw.githubusercontent.com/minio/operator/v${OPERATOR}/helm/operator/values.yaml -o source/includes/k8s/operator-values.yaml
11 | curl --retry 10 -Ls https://raw.githubusercontent.com/minio/operator/v${OPERATOR}/helm/tenant/values.yaml -o source/includes/k8s/tenant-values.yaml
12 |
13 | # To make the include nicer, this strips out the top H1 and reorders all headers thereafter
14 |
15 | KNAME=$(uname -s)
16 | case "${KNAME}" in
17 | "Darwin")
18 | sed -i '' 's%# API Reference%%g' source/includes/k8s/ext-tenant-crd.md
19 | sed -i '' 's%minio.min.io/v2%Operator CRD v2 Reference%g' source/includes/k8s/ext-tenant-crd.md
20 | sed -i '' 's%k8s-api-github-com-minio-operator-pkg-apis-minio-min-io-v2-%%g' source/includes/k8s/ext-tenant-crd.md
21 | sed -i '' 's%# % %g' source/includes/k8s/ext-tenant-crd.md;;
22 | *)
23 | sed -i 's%# API Reference%%g' source/includes/k8s/ext-tenant-crd.md
24 | sed -i 's%minio.min.io/v2%Operator CRD v2 Reference%g' source/includes/k8s/ext-tenant-crd.md
25 | sed -i 's%k8s-api-github-com-minio-operator-pkg-apis-minio-min-io-v2-%%g' source/includes/k8s/ext-tenant-crd.md
26 | sed -i 's%# % %g' source/includes/k8s/ext-tenant-crd.md;;
27 | esac
28 | }
29 |
30 | main
31 |
--------------------------------------------------------------------------------
/source/images/logos/docker.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-cluster-iam.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-admin-cluster-iam:
2 |
3 | ========================
4 | ``mc admin cluster iam``
5 | ========================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc admin cluster iam
14 |
15 | Description
16 | -----------
17 |
18 | .. versionadded:: RELEASE.2022-06-26T18-51-48Z
19 |
20 | .. start-mc-admin-cluster-iam-desc
21 |
22 | The :mc:`mc admin cluster iam` command and its subcommands provide tools for manually importing and exporting MinIO :ref:`identity and access management (IAM) ` metadata.
23 |
24 | .. end-mc-admin-cluster-iam-desc
25 |
26 | For automatic synchronization of all IAM configurations in a deployment to a remote site, use :ref:`site replication `.
27 |
28 | The :mc:`mc admin cluster iam` command has the following subcommands:
29 |
30 | .. list-table::
31 | :header-rows: 1
32 | :widths: 40 60
33 |
34 | * - Subcommand
35 | - Description
36 |
37 | * - :mc:`~mc admin cluster iam import`
38 | - .. include:: /reference/minio-mc-admin/mc-admin-cluster-iam-import.rst
39 | :start-after: start-mc-admin-cluster-iam-import-desc
40 | :end-before: end-mc-admin-cluster-iam-import-desc
41 |
42 | * - :mc:`~mc admin cluster iam export`
43 | - .. include:: /reference/minio-mc-admin/mc-admin-cluster-iam-export.rst
44 | :start-after: start-mc-admin-cluster-iam-export-desc
45 | :end-before: end-mc-admin-cluster-iam-export-desc
46 |
47 |
48 |
49 | .. toctree::
50 | :titlesonly:
51 | :hidden:
52 |
53 | /reference/minio-mc-admin/mc-admin-cluster-iam-import
54 | /reference/minio-mc-admin/mc-admin-cluster-iam-export
55 |
56 |
57 |
--------------------------------------------------------------------------------
/.github/workflows/pr-ci-cd.yml:
--------------------------------------------------------------------------------
1 | name: Staging
2 |
3 | on:
4 | pull_request:
5 | type: ["opened","synchronize"]
6 |
7 | jobs:
8 | build-and-stage:
9 |
10 | runs-on: ubuntu-latest
11 |
12 | steps:
13 | - name: checkout
14 | uses: actions/checkout@v4
15 |
16 | - name: install-python
17 | uses: actions/setup-python@v5
18 | with:
19 | python-version: '3.12'
20 |
21 | - name: pip-requirements
22 | run: pip install -r requirements.txt
23 |
24 | - name: npm-setup
25 | uses: actions/setup-node@v4
26 | with:
27 | node-version: 20
28 |
29 | - name: npm-install-setup
30 | uses: bahmutov/npm-install@v1
31 | with:
32 | working-directory: ./
33 |
34 | - name: build-docs
35 | run: ./build-docs-ci.sh
36 |
37 | - name: Staging
38 | uses: burnett01/rsync-deployments@7.0.2
39 | with:
40 | path: ./minio/
41 | switches: --mkpath -rv --delete
42 | remote_path: ${{ secrets.DEPLOY_PATH }}/${{ github.event.pull_request.head.ref }}
43 | remote_host: ${{ secrets.DEPLOY_HOST_STAGING }}
44 | remote_port: ${{ secrets.DEPLOY_PORT }}
45 | remote_user: ${{ secrets.DEPLOY_USER_STAGING }}
46 | remote_key: ${{ secrets.DEPLOY_KEY_STAGING }}
47 | remote_key_pass: ${{ secrets.DEPLOY_KEY_STAGING_PASS }}
48 |
49 | - name: comment
50 | uses: actions/github-script@v7
51 | with:
52 | github-token: ${{secrets.GITHUB_TOKEN}}
53 | script: |
54 | github.rest.issues.createComment({
55 | issue_number: context.issue.number,
56 | owner: context.repo.owner,
57 | repo: context.repo.repo,
58 | body: "Staged at ${{ secrets.STAGING_URL }}/${{ github.event.pull_request.head.ref }}"
59 | })
60 |
61 |
62 |
--------------------------------------------------------------------------------
/source/reference/deprecated/mc-admin-console.rst:
--------------------------------------------------------------------------------
1 | ====================
2 | ``mc admin console``
3 | ====================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin console
12 |
13 | .. important::
14 |
15 | This command has been replaced by :mc:`mc admin logs` in `mc RELEASE.2022-12-02T23-48-47Z `__.
16 |
17 | The command was previously replaced by ``mc support logs show`` in `mc RELEASE.2022-06-26T18-51-48Z `__.
18 |
19 | Description
20 | -----------
21 |
22 | The :mc:`mc admin console` command returns server log entries for each
23 | MinIO server in the deployment.
24 |
25 | .. admonition:: Use ``mc admin`` on MinIO Deployments Only
26 | :class: note
27 |
28 | .. include:: /includes/facts-mc-admin.rst
29 | :start-after: start-minio-only
30 | :end-before: end-minio-only
31 |
32 |
33 | Syntax
34 | ------
35 |
36 | :mc:`mc admin console` has the following syntax:
37 |
38 | .. code-block:: shell
39 | :class: copyable
40 |
41 | mc admin console [FLAGS] TARGET NODENAME
42 |
43 | :mc:`mc admin console` supports the following:
44 |
45 | .. mc-cmd:: TARGET
46 |
47 | The :mc:`alias ` of a configured MinIO deployment from which
48 | the command retrieves server logs.
49 |
50 | .. mc-cmd:: NODENAME
51 |
52 | The specific MinIO server node from which the command retrieves server logs.
53 |
54 | .. mc-cmd:: --limit, l
55 |
56 |
57 | The number of most recent log entries to show. Defaults to ``10``.
58 |
59 | .. mc-cmd:: --type, t
60 |
61 |
62 | The type of errog logs to return. Specify one or more of the following
63 | options as a comma-seperated ``,`` list:
64 |
65 | - ``minio``
66 | - ``application``
67 | - ``all`` (Default)
68 |
69 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/encryption.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-support-top-disk.rst:
--------------------------------------------------------------------------------
1 | =======================
2 | ``mc support top disk``
3 | =======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc support top disk
12 |
13 | .. include:: /includes/common-mc-support.rst
14 | :start-after: start-minio-only
15 | :end-before: end-minio-only
16 |
17 | Syntax
18 | ------
19 |
20 | .. start-mc-support-top-disk-desc
21 |
22 | The :mc:`mc support top disk` command displays current drive statistics.
23 |
24 | .. end-mc-support-top-disk-desc
25 |
26 | .. tab-set::
27 |
28 | .. tab-item:: EXAMPLE
29 |
30 | The following command displays the current in-progress S3 API calls on the :term:`alias` ``myminio``.
31 |
32 | .. code-block:: shell
33 | :class: copyable
34 |
35 | mc support top disk myminio/
36 |
37 | .. tab-item:: SYNTAX
38 |
39 | The command has the following syntax:
40 |
41 | .. code-block:: shell
42 | :class: copyable
43 |
44 | mc [GLOBALFLAGS] support top disk \
45 | [--count, -c "integer"] \
46 | TARGET
47 |
48 | .. include:: /includes/common-minio-mc.rst
49 | :start-after: start-minio-syntax
50 | :end-before: end-minio-syntax
51 |
52 | Parameters
53 | ~~~~~~~~~~
54 |
55 | .. mc-cmd:: TARGET
56 | :required:
57 |
58 | The full path to the :ref:`alias ` or :term:`prefix` where the command should run.
59 |
60 | .. mc-cmd:: --count, -c
61 | :optional:
62 |
63 | Display statistics for up to the entered number of drives.
64 |
65 | If no entry is made, the command returns statistics for up to 10 drives.
66 |
67 | Global Flags
68 | ~~~~~~~~~~~~
69 |
70 | .. include:: /includes/common-minio-mc.rst
71 | :start-after: start-minio-mc-globals
72 | :end-before: end-minio-mc-globals
73 |
74 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-policy-remove.rst:
--------------------------------------------------------------------------------
1 | ======================
2 | ``mc admin policy rm``
3 | ======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin policy remove
12 | .. mc:: mc admin policy rm
13 |
14 | Syntax
15 | ------
16 |
17 | .. start-mc-admin-policy-remove-desc
18 |
19 | Removes an IAM policy from the target MinIO deployment.
20 |
21 | .. end-mc-admin-policy-remove-desc
22 |
23 | The :mc:`mc admin policy remove` command has equivalent functionality to :mc:`mc admin policy rm`.
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following command removes the policy names ``writeonly`` from the ``myminio`` MinIO deployment:
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc admin policy rm myminio writeonly
35 |
36 | .. tab-item:: SYNTAX
37 |
38 | The command has the following syntax:
39 |
40 | .. code-block:: shell
41 | :class: copyable
42 |
43 | mc admin policy rm TARGET POLICYNAME
44 |
45 | .. include:: /includes/common-minio-mc.rst
46 | :start-after: start-minio-syntax
47 | :end-before: end-minio-syntax
48 |
49 |
50 | Parameters
51 | ~~~~~~~~~~
52 |
53 | The :mc-cmd:`mc admin policy rm` command accepts the following arguments:
54 |
55 | .. mc-cmd:: TARGET
56 |
57 | The :mc-cmd:`alias ` of a configured MinIO deployment from which to remove the policy.
58 |
59 | .. mc-cmd:: POLICYNAME
60 |
61 | The name of the policy to remove.
62 |
63 | Global Flags
64 | ~~~~~~~~~~~~
65 |
66 | .. include:: /includes/common-minio-mc.rst
67 | :start-after: start-minio-mc-globals
68 | :end-before: end-minio-mc-globals
69 |
70 | Examples
71 | --------
72 |
73 | Remove a policy called ``listbuckets``.
74 |
75 | .. code-block:: shell
76 | :class: copyable
77 |
78 | mc admin policy rm myminio listbuckets
--------------------------------------------------------------------------------
/source/reference/deprecated/mc-admin-speedtest.rst:
--------------------------------------------------------------------------------
1 | ======================
2 | ``mc admin speedtest``
3 | ======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin speedtest
12 |
13 | .. versionchanged:: RELEASE.2022-07-24T02-25-13Z
14 |
15 | ``mc admin speedtest`` replaced by :mc:`mc support perf`.
16 |
17 | Description
18 | -----------
19 |
20 | .. start-mc-admin-speedtest-desc
21 |
22 | The :mc-cmd:`mc admin speedtest` command tests throughputs per host with ``PUT``
23 | and ``GET`` operations.
24 |
25 | .. end-mc-admin-speedtest-desc
26 |
27 | :mc-cmd:`~mc admin speedtest` is available starting with ``mc``
28 | :mc-release:`RELEASE.2021-09-02T09-21-27Z` and supports distributed MinIO
29 | deployments running :minio-release:`RELEASE.2021-07-30T00-02-00Z` or later.
30 |
31 | :mc-cmd:`~mc admin speedtest` does not support standalone or MinIO Gateway
32 | deployments.
33 |
34 | .. admonition:: Use ``mc admin`` on MinIO Deployments Only
35 | :class: note
36 |
37 | .. include:: /includes/facts-mc-admin.rst
38 | :start-after: start-minio-only
39 | :end-before: end-minio-only
40 |
41 | Syntax
42 | ------
43 |
44 | :mc-cmd:`mc admin speedtest` has the following syntax:
45 |
46 | .. code-block:: shell
47 | :class: copyable
48 |
49 | mc admin speedtest [FLAGS] TARGET
50 |
51 | :mc-cmd:`mc admin speedtest` supports the following arguments:
52 |
53 | .. mc-cmd:: TARGET
54 |
55 | *Required*
56 |
57 | The :mc-cmd:`alias ` of a configured MinIO deployment to run the speedtest against.
58 |
59 | .. mc-cmd:: --duration
60 |
61 |
62 | The duration the entire speedtests are run. Defaults to ``10s``.
63 |
64 | .. mc-cmd:: --size
65 |
66 |
67 | The size of the objects used for uploads/downloads. Defaults to ``64MiB``.
68 |
69 | .. mc-cmd:: --concurrent
70 |
71 |
72 | The number of concurrent requests per server. Defaults to ``32``.
73 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-idp-ldap-policy.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-idp-ldap-policy:
2 |
3 | ======================
4 | ``mc idp ldap policy``
5 | ======================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc idp ldap policy
14 |
15 | .. versionadded:: RELEASE.2023-05-26T23-31-54Z
16 |
17 | :mc-cmd:`mc idp ldap policy` and its subcommands replace ``mc admin idp ldap policy``.
18 |
19 | Description
20 | -----------
21 |
22 | .. start-mc-idp-ldap-policy-desc
23 |
24 | The :mc-cmd:`mc idp ldap policy` commands show the mapping relationships between policies and the associated groups or users.
25 |
26 | .. end-mc-idp-ldap-policy-desc
27 |
28 | The :mc-cmd:`mc idp ldap policy` commands are only supported against MinIO deployments.
29 |
30 | The :mc-cmd:`mc idp ldap policy` command has the following subcommands:
31 |
32 | .. list-table::
33 | :header-rows: 1
34 | :widths: 40 60
35 |
36 | * - Subcommand
37 | - Description
38 |
39 | * - :mc-cmd:`mc idp ldap policy attach`
40 | - .. include:: /reference/minio-mc/mc-idp-ldap-policy-attach.rst
41 | :start-after: start-mc-idp-ldap-policy-attach-desc
42 | :end-before: end-mc-idp-ldap-policy-attach-desc
43 |
44 | * - :mc-cmd:`mc idp ldap policy detach`
45 | - .. include:: /reference/minio-mc/mc-idp-ldap-policy-detach.rst
46 | :start-after: start-mc-idp-ldap-policy-detach-desc
47 | :end-before: end-mc-idp-ldap-policy-detach-desc
48 |
49 | * - :mc-cmd:`mc idp ldap policy entities`
50 | - .. include:: /reference/minio-mc/mc-idp-ldap-policy-entities.rst
51 | :start-after: start-mc-idp-ldap-policy-entities-desc
52 | :end-before: end-mc-idp-ldap-policy-entities-desc
53 |
54 | .. toctree::
55 | :titlesonly:
56 | :hidden:
57 |
58 | /reference/minio-mc/mc-idp-ldap-policy-attach
59 | /reference/minio-mc/mc-idp-ldap-policy-detach
60 | /reference/minio-mc/mc-idp-ldap-policy-entities
61 |
--------------------------------------------------------------------------------
/source/administration/monitoring.rst:
--------------------------------------------------------------------------------
1 | ===================================
2 | Monitoring Bucket and Object Events
3 | ===================================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 1
10 |
11 | Bucket Notifications
12 | --------------------
13 |
14 | MinIO bucket notifications allow administrators to send notifications to supported external services on certain object or bucket events.
15 | MinIO supports bucket and object-level S3 events similar to the
16 | :s3-docs:`Amazon S3 Event Notifications `.
17 |
18 | MinIO supports publishing bucket or object events to the following supported
19 | targets on certain supported events.
20 |
21 | - :ref:`minio-bucket-notifications-publish-amqp`
22 | - :ref:`minio-bucket-notifications-publish-mqtt`
23 | - :ref:`minio-bucket-notifications-publish-nats`
24 | - :ref:`minio-bucket-notifications-publish-nsq`
25 | - :ref:`minio-bucket-notifications-publish-elasticsearch`
26 | - :ref:`minio-bucket-notifications-publish-kafka`
27 | - :ref:`minio-bucket-notifications-publish-mysql`
28 | - :ref:`minio-bucket-notifications-publish-postgresql`
29 | - :ref:`minio-bucket-notifications-publish-redis`
30 | - :ref:`minio-bucket-notifications-publish-webhook`
31 |
32 | See :ref:`minio-bucket-notifications`
33 | for more complete documentation on MinIO Bucket Notifications.
34 |
35 | Deployment Metrics
36 | ------------------
37 |
38 | MinIO provides a Prometheus-compatible endpoint for supporting time-series querying of metrics.
39 |
40 | Server Logs
41 | -----------
42 |
43 | MinIO provides the following interfaces for remotely reading server logs:
44 |
45 | - The :mc:`mc admin logs` command returns the specified server's console output.
46 | - MinIO supports pushing server logs to an HTTP webhook for further ingestion.
47 | See :ref:`minio-logging-publish-server-logs` for more information.
48 |
49 | .. toctree::
50 | :titlesonly:
51 | :hidden:
52 |
53 | /administration/monitoring/bucket-notifications
--------------------------------------------------------------------------------
/source/_static/img/icons/docker.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-accesskey-enable.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-admin-accesskey-enable:
2 |
3 | =============================
4 | ``mc admin accesskey enable``
5 | =============================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc admin accesskey enable
14 |
15 |
16 | Syntax
17 | ------
18 |
19 | .. start-mc-admin-accesskey-enable-desc
20 |
21 | The :mc-cmd:`mc admin accesskey enable` command enables an existing access key.
22 |
23 | .. end-mc-admin-accesskey-enable-desc
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following command enables the specified access key:
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc admin accesskey enable myminio myuserserviceaccount
35 |
36 | .. tab-item:: SYNTAX
37 |
38 | The command has the following syntax:
39 |
40 | .. code-block:: shell
41 | :class: copyable
42 |
43 | mc [GLOBALFLAGS] admin accesskey enable \
44 | ALIAS \
45 | SERVICEACCOUNT
46 |
47 | .. include:: /includes/common-minio-mc.rst
48 | :start-after: start-minio-syntax
49 | :end-before: end-minio-syntax
50 |
51 |
52 | Parameters
53 | ~~~~~~~~~~
54 |
55 | .. mc-cmd:: ALIAS
56 | :required:
57 |
58 | The :mc-cmd:`alias ` of the MinIO deployment.
59 |
60 | .. mc-cmd:: SERVICEACCOUNT
61 | :required:
62 |
63 | The access key to enable.
64 |
65 |
66 | Global Flags
67 | ~~~~~~~~~~~~
68 |
69 | .. include:: /includes/common-minio-mc.rst
70 | :start-after: start-minio-mc-globals
71 | :end-before: end-minio-mc-globals
72 |
73 |
74 | Behavior
75 | --------
76 |
77 | S3 Compatibility
78 | ~~~~~~~~~~~~~~~~
79 |
80 | .. include:: /includes/common-minio-mc.rst
81 | :start-after: start-minio-mc-s3-compatibility
82 | :end-before: end-minio-mc-s3-compatibility
83 |
--------------------------------------------------------------------------------
/source/administration/identity-access-management/minio-group-management.rst:
--------------------------------------------------------------------------------
1 | .. _minio-groups:
2 |
3 | ================
4 | Group Management
5 | ================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | Overview
14 | --------
15 |
16 | A *group* is a collection of :ref:`users `. Each group
17 | can have one or more assigned :ref:`policies `
18 | that explicitly list the actions and resources to which group members are
19 | allowed or denied access.
20 |
21 | For example, consider the following groups. Each group is assigned a
22 | :ref:`built-in policy ` or supported
23 | :ref:`policy action `. Each group also has one or
24 | more assigned users. Each user's total set of permissions consists of their
25 | explicitly assigned permission *and* the inherited permissions from each of
26 | their assigned groups. MinIO by default *denies* access to any resource or
27 | operation not explicitly allowed by a user's assigned or inherited policies.
28 |
29 | .. list-table::
30 | :header-rows: 1
31 | :widths: 20 40 40
32 | :width: 100%
33 |
34 | * - Group
35 | - Policy
36 | - Members
37 |
38 | * - ``Operations``
39 | - | :userpolicy:`readwrite` on ``finance`` bucket
40 | | :userpolicy:`readonly` on ``audit`` bucket
41 |
42 | - ``john.doe``, ``jane.doe``
43 |
44 | * - ``Auditing``
45 | - | :userpolicy:`readonly` on ``audit`` bucket
46 | - ``jen.doe``, ``joe.doe``
47 |
48 | * - ``Admin``
49 | - :policy-action:`admin:*`
50 | - ``greg.doe``, ``jen.doe``
51 |
52 | Groups provide a simplified method for managing shared permissions among
53 | users with common access patterns and workloads. Client's *cannot* authenticate
54 | to a MinIO deployment using a group as an identity.
55 |
56 |
57 | The :mc:`mc admin group` command supports the creation and management of
58 | groups on the MinIO deployment. See the command reference for examples of
59 | usage.
60 |
61 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-policy-list.rst:
--------------------------------------------------------------------------------
1 | ======================
2 | ``mc admin policy ls``
3 | ======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc admin policy ls
12 | .. mc:: mc admin policy list
13 |
14 | Syntax
15 | ------
16 |
17 | .. start-mc-admin-policy-list-desc
18 |
19 | Lists all policies on the target MinIO deployment.
20 |
21 | .. end-mc-admin-policy-list-desc
22 |
23 | The :mc:`mc admin policy list` command has equivalent functionality to :mc:`mc admin policy ls`.
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following command displays a list of the policies currently current on the :term:`alias` ``play``.
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc admin policy ls play
35 |
36 | .. tab-item:: SYNTAX
37 |
38 | The command has the following syntax:
39 |
40 | .. code-block:: shell
41 | :class: copyable
42 |
43 | mc admin policy ls TARGET
44 |
45 | .. include:: /includes/common-minio-mc.rst
46 | :start-after: start-minio-syntax
47 | :end-before: end-minio-syntax
48 |
49 |
50 | Parameters
51 | ~~~~~~~~~~
52 |
53 | The :mc-cmd:`mc admin policy ls` command accepts the following arguments:
54 |
55 | .. mc-cmd:: TARGET
56 |
57 | The :mc-cmd:`alias ` of a configured MinIO deployment from which the command lists the available policies.
58 |
59 | Global Flags
60 | ~~~~~~~~~~~~
61 |
62 | .. include:: /includes/common-minio-mc.rst
63 | :start-after: start-minio-mc-globals
64 | :end-before: end-minio-mc-globals
65 |
66 | Examples
67 | --------
68 |
69 | List the policies that exist on the deployment at alias ``myminio``.
70 |
71 | .. code-block:: shell
72 | :class: copyable
73 |
74 | mc admin policy ls myminio
75 |
76 | Output
77 | ~~~~~~
78 |
79 | The command returns output that resembles the following:
80 |
81 | .. code-block:: shell
82 |
83 | readwrite
84 | writeonly
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-support-top-net.rst:
--------------------------------------------------------------------------------
1 | =======================
2 | ``mc support top net``
3 | =======================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 2
10 |
11 | .. mc:: mc support top net
12 |
13 | .. include:: /includes/common-mc-support.rst
14 | :start-after: start-minio-only
15 | :end-before: end-minio-only
16 |
17 | Syntax
18 | ------
19 |
20 | .. start-mc-support-top-net-desc
21 |
22 | The :mc:`mc support top net` command displays realtime network metrics.
23 |
24 | .. end-mc-support-top-net-desc
25 |
26 | .. tab-set::
27 |
28 | .. tab-item:: EXAMPLE
29 |
30 | The following command displays the current realtime network metrics for the :term:`alias` ``myminio`` deployment.
31 |
32 | .. code-block:: shell
33 | :class: copyable
34 |
35 | mc support top net myminio/
36 |
37 | The output returns information such as the server URL, network interface, receive rate, transmit rate, and system messages.
38 |
39 | .. tab-item:: SYNTAX
40 |
41 | The command has the following syntax:
42 |
43 | .. code-block:: shell
44 | :class: copyable
45 |
46 | mc [GLOBALFLAGS] support top disk \
47 | [--interval value] \
48 | TARGET
49 |
50 | .. include:: /includes/common-minio-mc.rst
51 | :start-after: start-minio-syntax
52 | :end-before: end-minio-syntax
53 |
54 | Parameters
55 | ~~~~~~~~~~
56 |
57 | .. mc-cmd:: TARGET
58 | :required:
59 |
60 | The full path to the :ref:`alias ` or :term:`prefix` where the command should run.
61 |
62 | .. mc-cmd:: --interval
63 | :optional:
64 |
65 | The interval in seconds between metric requests.
66 |
67 | By default, the command requests metrics every second.
68 |
69 | Global Flags
70 | ~~~~~~~~~~~~
71 |
72 | .. include:: /includes/common-minio-mc.rst
73 | :start-after: start-minio-mc-globals
74 | :end-before: end-minio-mc-globals
75 |
76 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-accesskey-disable.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-admin-accesskey-disable:
2 |
3 | ==============================
4 | ``mc admin accesskey disable``
5 | ==============================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc admin accesskey disable
14 |
15 |
16 | Syntax
17 | ------
18 |
19 | .. start-mc-admin-accesskey-disable-desc
20 |
21 | The :mc-cmd:`mc admin accesskey disable` command disables an existing access key for a MinIO IDP user.
22 |
23 | .. end-mc-admin-accesskey-disable-desc
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following command disables the specified access key:
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc admin accesskey disable myminio myuserserviceaccount
35 |
36 | .. tab-item:: SYNTAX
37 |
38 | The command has the following syntax:
39 |
40 | .. code-block:: shell
41 | :class: copyable
42 |
43 | mc [GLOBALFLAGS] admin accesskey disable \
44 | ALIAS \
45 | SERVICEACCOUNT
46 |
47 | .. include:: /includes/common-minio-mc.rst
48 | :start-after: start-minio-syntax
49 | :end-before: end-minio-syntax
50 |
51 |
52 | Parameters
53 | ~~~~~~~~~~
54 |
55 | .. mc-cmd:: ALIAS
56 | :required:
57 |
58 | The :mc-cmd:`alias ` of the MinIO deployment.
59 |
60 | .. mc-cmd:: SERVICEACCOUNT
61 | :required:
62 |
63 | The access key to disable.
64 |
65 |
66 | Global Flags
67 | ~~~~~~~~~~~~
68 |
69 | .. include:: /includes/common-minio-mc.rst
70 | :start-after: start-minio-mc-globals
71 | :end-before: end-minio-mc-globals
72 |
73 |
74 | Behavior
75 | --------
76 |
77 | S3 Compatibility
78 | ~~~~~~~~~~~~~~~~
79 |
80 | .. include:: /includes/common-minio-mc.rst
81 | :start-after: start-minio-mc-s3-compatibility
82 | :end-before: end-minio-mc-s3-compatibility
83 |
--------------------------------------------------------------------------------
/source/_static/img/icons/docker-inactive.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/source/includes/k8s/steps-configure-minio-kes-hashicorp.rst:
--------------------------------------------------------------------------------
1 | #. Review the Tenant CRD
2 |
3 | Review the :ref:`Tenant CRD ` ``TenantSpec.kes`` object, the ``TenantSpec.configuration`` object, and the :minio-docs:`KES Configuration reference`.
4 |
5 | You must prepare all necessary configurations associated to your external Key Management Service of choice before proceeding.
6 |
7 | #. Create or Modify your Tenant YAML to set the values of ``KesConfig`` as necessary:
8 |
9 | You must modify your Tenant YAML or ``Kustomize`` templates to reflect the necessary KES configuration.
10 | The following example is taken from the :minio-git:`MinIO Operator Kustomize examples `
11 |
12 | .. code-block:: yaml
13 |
14 | kes:
15 | image: "" # minio/kes:2024-06-17T15-47-05Z
16 | env: [ ]
17 | replicas: 2
18 | kesSecret:
19 | name: kes-configuration
20 | imagePullPolicy: "IfNotPresent"
21 |
22 | The ``kes-configuration`` secret must reference a Kubernetes Opaque Secret which contains a ``stringData`` object with the full KES configuration as ``server-config.yaml``.
23 | The ``keystore`` field must contain the full configuration associated with your preferred Key Management System.
24 |
25 | Reference :minio-git:`the Kustomize example ` for additional guidance.
26 |
27 | #. Create or Modify your Tenant YAML to set the values of ``TenantSpec.configuration`` as necessary.
28 |
29 | TODO
30 |
31 | #. Generate a New Encryption Key
32 |
33 | .. include:: /includes/k8s/common-minio-kes.rst
34 | :start-after: start-kes-generate-key-desc
35 | :end-before: end-kes-generate-key-desc
36 |
37 | #. Enable SSE-KMS for a Bucket
38 |
39 | .. include:: /includes/k8s/common-minio-kes.rst
40 | :start-after: start-kes-enable-sse-kms-desc
41 | :end-before: end-kes-enable-sse-kms-desc
42 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-idp-ldap-enable.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-idp-ldap-enable:
2 |
3 | ======================
4 | ``mc idp ldap enable``
5 | ======================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc idp ldap enable
14 |
15 |
16 | Description
17 | -----------
18 |
19 | .. start-mc-idp-ldap-enable-desc
20 |
21 | The :mc:`mc idp ldap enable` command enables the currently configured AD/LDAP provider.
22 |
23 | .. end-mc-idp-ldap-enable-desc
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following example enables the AD/LDAP configurations on the ``myminio`` deployment.
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc idp ldap enable \
35 | myminio
36 |
37 | .. tab-item:: SYNTAX
38 |
39 | The command has the following syntax:
40 |
41 | .. code-block:: shell
42 | :class: copyable
43 |
44 | mc [GLOBALFLAGS] idp ldap enable \
45 | ALIAS
46 |
47 | - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to enable the AD/LDAP integration.
48 |
49 | .. include:: /includes/common-minio-mc.rst
50 | :start-after: start-minio-syntax
51 | :end-before: end-minio-syntax
52 |
53 | Parameters
54 | ~~~~~~~~~~
55 |
56 | .. mc-cmd:: ALIAS
57 | :required:
58 |
59 | The :ref:`alias ` of the MinIO deployment for which to enable the AD/LDAP integration.
60 |
61 | For example:
62 |
63 | .. code-block:: none
64 |
65 | mc idp ldap enable myminio
66 |
67 |
68 |
69 | Global Flags
70 | ~~~~~~~~~~~~
71 |
72 | .. include:: /includes/common-minio-mc.rst
73 | :start-after: start-minio-mc-globals
74 | :end-before: end-minio-mc-globals
75 |
76 |
77 | Behavior
78 | --------
79 |
80 | S3 Compatibility
81 | ~~~~~~~~~~~~~~~~
82 |
83 | .. include:: /includes/common-minio-mc.rst
84 | :start-after: start-minio-mc-s3-compatibility
85 | :end-before: end-minio-mc-s3-compatibility
86 |
--------------------------------------------------------------------------------
/source/reference/minio-mc-admin/mc-admin-info.rst:
--------------------------------------------------------------------------------
1 | =================
2 | ``mc admin info``
3 | =================
4 |
5 | .. default-domain:: minio
6 |
7 | .. contents:: Table of Contents
8 | :local:
9 | :depth: 1
10 |
11 | .. mc:: mc admin info
12 |
13 | Description
14 | -----------
15 |
16 | .. start-mc-admin-info-desc
17 |
18 | The :mc-cmd:`mc admin info` command displays information on a MinIO server.
19 | For distributed MinIO deployments, :mc-cmd:`mc admin info` displays information
20 | for each MinIO server in the deployment.
21 |
22 | .. end-mc-admin-info-desc
23 |
24 | .. versionadded:: mc RELEASE.2024-05-03T11-21-07Z
25 |
26 | The command output includes information about the :ref:`erasure code ` setting for the cluster.
27 | This displays in the output in the format ``EC:#``.
28 |
29 | The output of the command resembles the following:
30 |
31 | .. code-block::
32 |
33 | ● play.min.io
34 | Uptime: 2 hours
35 | Version: 2024-05-10T08:24:14Z
36 | Network: 1/1 OK
37 | Drives: 4/4 OK
38 | Pool: 1
39 |
40 | Pools:
41 | 1st, Erasure sets: 1, Drives per erasure set: 4
42 |
43 | 0 B Used, 3 Buckets, 0 Objects
44 | 4 drives online, 0 drives offline, EC:1
45 |
46 |
47 | Examples
48 | --------
49 |
50 | .. include:: /includes/play-alias-available.rst
51 | :start-after: play-alias-only
52 | :end-before: end-play-alias-only
53 |
54 | .. code-block:: shell
55 | :class: copyable
56 |
57 | mc admin info play
58 |
59 | Syntax
60 | ------
61 |
62 | :mc-cmd:`mc admin info` has the following syntax:
63 |
64 | .. code-block:: shell
65 | :class: copyable
66 |
67 | mc admin info TARGET \
68 | [--offline]
69 |
70 | Specify the :mc-cmd:`alias ` of a configured MinIO deployment as the ``TARGET``.
71 |
72 | Parameters
73 | ~~~~~~~~~~
74 |
75 | .. mc-cmd:: TARGET
76 | :required:
77 |
78 | The :ref:`alias ` about which you want to display information.
79 |
80 | .. mc-cmd:: --offline
81 | :optional:
82 |
83 | Show only offline drives or nodes.
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-idp-ldap-disable.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-idp-ldap-disable:
2 |
3 | =======================
4 | ``mc idp ldap disable``
5 | =======================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc idp ldap disable
14 |
15 |
16 | Description
17 | -----------
18 |
19 | .. start-mc-idp-ldap-disable-desc
20 |
21 | The :mc:`mc idp ldap disable` command disables the currently configured AD/LDAP provider.
22 |
23 | .. end-mc-idp-ldap-disable-desc
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following example disables the AD/LDAP configurations on the ``myminio`` deployment.
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc idp ldap disable \
35 | myminio
36 |
37 | .. tab-item:: SYNTAX
38 |
39 | The command has the following syntax:
40 |
41 | .. code-block:: shell
42 | :class: copyable
43 |
44 | mc [GLOBALFLAGS] idp ldap disable \
45 | ALIAS
46 |
47 | - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to disable the AD/LDAP integration.
48 |
49 | .. include:: /includes/common-minio-mc.rst
50 | :start-after: start-minio-syntax
51 | :end-before: end-minio-syntax
52 |
53 | Parameters
54 | ~~~~~~~~~~
55 |
56 | .. mc-cmd:: ALIAS
57 | :required:
58 |
59 | The :ref:`alias ` of the MinIO deployment for which to disable the AD/LDAP integration.
60 |
61 | For example:
62 |
63 | .. code-block:: none
64 |
65 | mc idp ldap disable myminio
66 |
67 |
68 |
69 | Global Flags
70 | ~~~~~~~~~~~~
71 |
72 | .. include:: /includes/common-minio-mc.rst
73 | :start-after: start-minio-mc-globals
74 | :end-before: end-minio-mc-globals
75 |
76 |
77 | Behavior
78 | --------
79 |
80 | S3 Compatibility
81 | ~~~~~~~~~~~~~~~~
82 |
83 | .. include:: /includes/common-minio-mc.rst
84 | :start-after: start-minio-mc-s3-compatibility
85 | :end-before: end-minio-mc-s3-compatibility
86 |
--------------------------------------------------------------------------------
/gulpfile.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | var gulp = require ('gulp');
4 | var cleanCSS = require('gulp-clean-css');
5 | var $ = require ('gulp-load-plugins') ();
6 | var connect = require('gulp-connect');
7 | var sass = require('gulp-sass')(require('sass'));
8 |
9 | var branchDir = 'master';
10 |
11 | var paths = {
12 | scss: {
13 | dir: 'source/_static/scss',
14 | main: 'source/_static/scss/main.scss',
15 | files: 'source/_static/scss/**/*.scss'
16 | },
17 | css: {
18 | dir: 'source/_static/css',
19 | main: 'source/_static/scss/main.css',
20 | files: 'source/_static/scss/**/*.css',
21 | dist: `build/${branchDir}/html/_static/css`
22 | },
23 | js: {
24 | dir: 'source/_static/js',
25 | main: 'source/_static/js/main.js',
26 | files: 'source/_static/js/**/*.js',
27 | dist: `build/${branchDir}/html/_static/js`,
28 | },
29 | dist: `build/${branchDir}/html`
30 | }
31 |
32 | // Compile SCSS
33 | gulp.task('handleStyle', function() {
34 | return gulp.src (paths.scss.main)
35 | .pipe(sass ())
36 | .pipe($.autoprefixer())
37 | .pipe(gulp.dest (paths.css.dir))
38 | .pipe(cleanCSS())
39 | .pipe($.rename({
40 | suffix: '.min'
41 | }))
42 | .pipe(gulp.dest (paths.css.dir))
43 | .pipe(gulp.dest (paths.css.dist))
44 | .pipe(connect.reload());
45 | });
46 |
47 | // Minify and move JS
48 | gulp.task('handleJs', function() {
49 | return gulp.src (paths.js.files)
50 | .pipe($.terser())
51 | .pipe(gulp.dest (paths.js.dist))
52 | .pipe(connect.reload());
53 | });
54 |
55 | // Live server
56 | gulp.task('connect', function() {
57 | connect.server({
58 | root: paths.dist,
59 | livereload: true
60 | });
61 | });
62 |
63 |
64 | // Watch
65 | gulp.task('watch', function () {
66 | gulp.watch(paths.scss.files, gulp.series('handleStyle'));
67 | gulp.watch(paths.js.files, gulp.series('handleJs'));
68 | });
69 |
70 | // Build
71 | gulp.task('default', gulp.series('handleStyle', 'handleJs'));
72 |
--------------------------------------------------------------------------------
/source/reference/minio-mc/mc-idp-ldap-info.rst:
--------------------------------------------------------------------------------
1 | .. _minio-mc-idp-ldap-info:
2 |
3 | ====================
4 | ``mc idp ldap info``
5 | ====================
6 |
7 | .. default-domain:: minio
8 |
9 | .. contents:: Table of Contents
10 | :local:
11 | :depth: 2
12 |
13 | .. mc:: mc idp ldap info
14 |
15 |
16 | Description
17 | -----------
18 |
19 | .. start-mc-idp-ldap-info-desc
20 |
21 | The :mc:`mc idp ldap info` command outputs the current configuration for an AD/LDAP provider on a specified MinIO deployment.
22 |
23 | .. end-mc-idp-ldap-info-desc
24 |
25 | .. tab-set::
26 |
27 | .. tab-item:: EXAMPLE
28 |
29 | The following example outputs the AD/LDAP configuration settings on the ``myminio`` deployment.
30 |
31 | .. code-block:: shell
32 | :class: copyable
33 |
34 | mc idp ldap info \
35 | myminio
36 |
37 | .. tab-item:: SYNTAX
38 |
39 | The command has the following syntax:
40 |
41 | .. code-block:: shell
42 | :class: copyable
43 |
44 | mc [GLOBALFLAGS] idp ldap info \
45 | ALIAS
46 |
47 | - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to retrieve info on the AD/LDAP integration.
48 |
49 | .. include:: /includes/common-minio-mc.rst
50 | :start-after: start-minio-syntax
51 | :end-before: end-minio-syntax
52 |
53 | Parameters
54 | ~~~~~~~~~~
55 |
56 | .. mc-cmd:: ALIAS
57 | :required:
58 |
59 | The :ref:`alias ` of the MinIO deployment for which to output the current AD/LDAP configuration.
60 |
61 | For example:
62 |
63 | .. code-block:: none
64 |
65 | mc idp ldap info myminio
66 |
67 |
68 |
69 | Global Flags
70 | ~~~~~~~~~~~~
71 |
72 | .. include:: /includes/common-minio-mc.rst
73 | :start-after: start-minio-mc-globals
74 | :end-before: end-minio-mc-globals
75 |
76 |
77 | Behavior
78 | --------
79 |
80 | S3 Compatibility
81 | ~~~~~~~~~~~~~~~~
82 |
83 | .. include:: /includes/common-minio-mc.rst
84 | :start-after: start-minio-mc-s3-compatibility
85 | :end-before: end-minio-mc-s3-compatibility
86 |
--------------------------------------------------------------------------------
/source/_templates/icons/sun.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/sync-docs.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -e
4 |
5 | function replace() {
6 | tmp_prefix=${RANDOM}
7 | old_IFS=$IFS
8 | IFS=$'\n'
9 | while read -r line
10 | do
11 | echo "${line/"${1}"/""${2}""}"
12 | done < source/conf.py > source/conf.py.${tmp_prefix}
13 | IFS=$old_IFS
14 | mv -f source/conf.py.${tmp_prefix} source/conf.py
15 | }
16 |
17 | function main() {
18 | if [ "$#" -eq 0 ]; then
19 | SDKS="dotnet go java js py hs rs"
20 | fi
21 |
22 | for sdk in ${SDKS}; do
23 | sdk_version=$(curl --retry 10 -Ls -o /dev/null -w "%{url_effective}" https://github.com/minio/minio-${sdk}/releases/latest | sed "s,https://github.com/minio/minio-${sdk}/releases/tag/,,g")
24 | echo "latest stable ${sdk} for ${sdk_version}"
25 | sdk_dir="docs"
26 | if [ "${sdk}" == "dotnet" ]; then
27 | sdk_dir="Docs"
28 | fi
29 | source_dir=${sdk}
30 | case ${sdk} in
31 | "js")
32 | source_dir="javascript"
33 | ;;
34 | "py")
35 | source_dir="python"
36 | ;;
37 | "hs")
38 | source_dir="haskell"
39 | ;;
40 | "rs")
41 | source_dir="rust" # no API.md yet
42 | ;;
43 | esac
44 | curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md
45 | curl --retry 10 -Ls -o source/developers/${source_dir}/quickstart.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/README.md
46 |
47 | case ${sdk} in
48 | "dotnet")
49 | replace DOTNETVERSION ${sdk_version}
50 | ;;
51 | "go")
52 | replace GOVERSION ${sdk_version}
53 | ;;
54 | "java")
55 | replace JAVAVERSION ${sdk_version}
56 | replace JAVAURL https://repo1.maven.org/maven2/io/minio/minio/${sdk_version}/
57 | ;;
58 | "js")
59 | replace JAVASCRIPTVERSION ${sdk_version}
60 | ;;
61 | "py")
62 | replace PYTHONVERSION ${sdk_version}
63 | ;;
64 | "hs")
65 | replace HASKELLVERSION ${sdk_version}
66 | ;;
67 | "rs")
68 | replace RUSTVERSION ${sdk_version}
69 | ;;
70 | esac
71 | done
72 | }
73 |
74 | main "$@"
75 |
--------------------------------------------------------------------------------
/source/_static/img/icons/nav/azure.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
7 |
8 |