From 96cda9c385964566ce3fb3815c38c2773707a22a Mon Sep 17 00:00:00 2001 From: Ravind Kumar Date: Fri, 10 Feb 2023 14:21:42 -0500 Subject: [PATCH] DOCS-728: Dropping Windows cruft (#729) Closes #728 --- source/includes/common/installation.rst | 35 ++++++----- source/includes/windows/quickstart.rst | 17 +++-- ...-deploy-minio-single-node-single-drive.rst | 63 +++++++++++++++++++ source/index.rst | 24 ++++++- .../deploy-minio-single-node-single-drive.rst | 6 +- source/url-excludes.yaml | 10 +++ 6 files changed, 132 insertions(+), 23 deletions(-) diff --git a/source/includes/common/installation.rst b/source/includes/common/installation.rst index 121a0949..732d4397 100644 --- a/source/includes/common/installation.rst +++ b/source/includes/common/installation.rst @@ -46,6 +46,11 @@ You can deploy MinIO using one of the following topologies: Scalable for Petabyte+ workloads - both storage capacity and performance +.. cond:: macos + + Use MacOS-based MinIO deployments for early development and evaluation. + MinIO strongly recommends Linux (RHEL, Ubuntu) for long-term development and production environments. + Site Replication ---------------- @@ -72,12 +77,12 @@ Not everything replicates across sites. Platform Support ---------------- -MinIO provides builds of the MinIO server (:mc:`minio`) and the -MinIO :abbr:`CLI (Command Line Interface)` (:mc:`mc`) for the following -platforms. - .. cond:: linux + MinIO provides builds of the MinIO server (:mc:`minio`) and the + MinIO :abbr:`CLI (Command Line Interface)` (:mc:`mc`) for the following + platforms. + - Red Hat Enterprise Linux 8.5+ (including all binary-compatible RHEL alternatives) - Ubuntu 18.04+ @@ -92,12 +97,6 @@ platforms. MinIO recommends non-EOL macOS versions (10.14+). -.. cond:: windows - - MinIO recommends non-EOL Windows versions (Windows 10, Windows Server 2016+). - Support for running :ref:`distributed MinIO deployments ` is *experimental* on Windows OS. - - For unlisted platforms or architectures, please reach out to MinIO at hello@min.io for additional support and guidance. You can build MinIO from :minio-git:`source ` and @@ -106,11 +105,13 @@ hello@min.io for additional support and guidance. You can build MinIO from for your platform and architecture combo. MinIO generally does not recommend source-based installations in production environments. -.. toctree:: - :titlesonly: - :hidden: +.. cond:: linux or macos - /operations/install-deploy-manage/deploy-minio-single-node-single-drive - /operations/install-deploy-manage/deploy-minio-single-node-multi-drive - /operations/install-deploy-manage/deploy-minio-multi-node-multi-drive - /operations/install-deploy-manage/multi-site-replication + .. toctree:: + :titlesonly: + :hidden: + + /operations/install-deploy-manage/deploy-minio-single-node-single-drive + /operations/install-deploy-manage/deploy-minio-single-node-multi-drive + /operations/install-deploy-manage/deploy-minio-multi-node-multi-drive + /operations/install-deploy-manage/multi-site-replication diff --git a/source/includes/windows/quickstart.rst b/source/includes/windows/quickstart.rst index 4e5fe8b9..041d86c4 100644 --- a/source/includes/windows/quickstart.rst +++ b/source/includes/windows/quickstart.rst @@ -10,7 +10,17 @@ Quickstart for Windows This procedure deploys a :ref:`Single-Node Single-Drive ` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and its S3-compatible API layer. -For instructions on deploying to production environments, see :ref:`deploy-minio-distributed`. +.. note:: + + MinIO has limited support for multi-drive Windows deployments due to behaviors and limitations of the NTFS filesystem. + + This documentation only covers Single-Node Single-Drive deployment topologies on Windows. + Use :minio-docs:`Linux hosts ` for deploying Single-Node Multi-Drive or Multi-Node Multi-Drive MinIO topologies. + +Use Windows-based MinIO deployments for early development and evaluation. +MinIO strongly recommends Linux (RHEL, Ubuntu) systems for long-term development and production environments. + +MinIO supports non-EOL Windows versions (Windows 10, Windows Server 2016+). Prerequisites ------------- @@ -70,8 +80,8 @@ Procedure #. Connect your Browser to the MinIO Server - Access the :ref:`minio-console` by going to a browser (such as Microsoft Edge) and going to ``http://127.0.0.1:9000`` or one of the Console addresses specified in the :mc:`minio server` command's output. - For example, :guilabel:`Console: http://192.0.2.10:9090 http://127.0.0.1:9090` in the example output indicates two possible addresses to use for connecting to the Console. + Access the :ref:`minio-console` by going to a browser (such as Microsoft Edge) and going to ``http://127.0.0.1:9090`` or one of the Console addresses specified in the :mc:`minio server` command's output. + For example, ``Console: http://192.0.2.10:9090 http://127.0.0.1:9090`` in the example output indicates two possible addresses to use for connecting to the Console. While port ``9000`` is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console. @@ -132,4 +142,3 @@ Next Steps - :ref:`Connect your applications to MinIO ` - :ref:`Configure Object Retention ` - :ref:`Configure Security ` -- :ref:`Deploy MinIO for Production Environments ` diff --git a/source/includes/windows/steps-deploy-minio-single-node-single-drive.rst b/source/includes/windows/steps-deploy-minio-single-node-single-drive.rst index e69de29b..7eec1929 100644 --- a/source/includes/windows/steps-deploy-minio-single-node-single-drive.rst +++ b/source/includes/windows/steps-deploy-minio-single-node-single-drive.rst @@ -0,0 +1,63 @@ +1) Download the MinIO Server +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Download the MinIO executable from the following URL: + + .. code-block:: shell + :class: copyable + + https://dl.min.io/server/minio/release/windows-amd64/minio.exe + + The next step includes instructions for running the executable. + You cannot run the executable from the Explorer or by double clicking the file. + Instead, you call the executable to launch the server. + +2) Create the ``systemd`` Service File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/linux/common-installation.rst + :start-after: start-install-minio-systemd-desc + :end-before: end-install-minio-systemd-desc + +3) Create the Environment Variable File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/common/common-deploy.rst + :start-after: start-common-deploy-create-environment-file-single-drive + :end-before: end-common-deploy-create-environment-file-single-drive + +4) Start the MinIO Service +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Issue the following command on the local host to start the MinIO |SNSD| deployment as a service: + +.. include:: /includes/linux/common-installation.rst + :start-after: start-install-minio-start-service-desc + :end-before: end-install-minio-start-service-desc + +The ``journalctl`` output should resemble the following: + +.. code-block:: shell + + Status: 1 Online, 0 Offline. + API: http://192.168.2.100:9000 http://127.0.0.1:9000 + RootUser: myminioadmin + RootPass: minio-secret-key-change-me + Console: http://192.168.2.100:9090 http://127.0.0.1:9090 + RootUser: myminioadmin + RootPass: minio-secret-key-change-me + + Command-line: https://min.io/docs/minio/linux/reference/minio-mc.html + $ mc alias set myminio http://10.0.2.100:9000 myminioadmin minio-secret-key-change-me + + Documentation: https://min.io/docs/minio/linux/index.html + +The ``API`` block lists the network interfaces and port on which clients can access the MinIO S3 API. +The ``Console`` block lists the network interfaces and port on which clients can access the MinIO Web Console. + +5) Connect to the MinIO Service +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/common/common-deploy.rst + :start-after: start-common-deploy-connect-to-minio-deployment + :end-before: end-common-deploy-connect-to-minio-deployment diff --git a/source/index.rst b/source/index.rst index 7d00728d..5542a657 100644 --- a/source/index.rst +++ b/source/index.rst @@ -124,8 +124,30 @@ Any file uploaded to ``play`` should be considered public and non-protected. /administration/batch-framework /administration/concepts +.. cond:: windows -.. cond:: linux or macos or windows or container + .. toctree:: + :titlesonly: + :hidden: + + /operations/concepts + /operations/monitoring + /operations/external-iam + /operations/server-side-encryption + /operations/network-encryption + /operations/checklists + /operations/data-recovery + /operations/troubleshooting + /administration/minio-console + /administration/object-management + /administration/monitoring + /administration/identity-access-management + /administration/server-side-encryption + /administration/bucket-replication + /administration/batch-framework + /administration/concepts + +.. cond:: linux or macos or container .. toctree:: :titlesonly: diff --git a/source/operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst b/source/operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst index 45947bad..aadd85ce 100644 --- a/source/operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst +++ b/source/operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst @@ -95,4 +95,8 @@ The following procedure deploys MinIO consisting of a single MinIO server and a .. cond:: container - .. include:: /includes/container/steps-deploy-minio-single-node-single-drive.rst \ No newline at end of file + .. include:: /includes/container/steps-deploy-minio-single-node-single-drive.rst + +.. cond:: windows + + .. include:: /includes/windows/steps-deploy-minio-single-node-single-drive.rst \ No newline at end of file diff --git a/source/url-excludes.yaml b/source/url-excludes.yaml index 7ebe6848..4f82c1c9 100644 --- a/source/url-excludes.yaml +++ b/source/url-excludes.yaml @@ -41,6 +41,16 @@ excludes: --- tag: windows excludes: +- 'operations/installation.rst' +- 'operations/install-deploy-manage/expand-minio-deployment.rst' +- 'operations/install-deploy-manage/upgrade-minio-deployment.rst' +- 'operations/install-deploy-manage/decommission-server-pool.rst' +- 'operations/install-deploy-manage/migrate-fs-gateway.rst' +- 'operations/manage-existing-deployments.rst' +- 'operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst' +- 'operations/install-deploy-manage/deploy-minio-single-node-multi-drive.rst' +- 'operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.rst' +- 'operations/install-deploy-manage/multi-site-replication.rst' - 'operations/install-deploy-manage/deploy-minio-tenant.rst' - 'operations/install-deploy-manage/modify-minio-tenant.rst' - 'operations/install-deploy-manage/expand-minio-tenant.rst'