Non-AWS S3 documentation (#456)

* Non-AWS S3 Documentation

* Spelling

* Shorten tab name

* Address feedback

Author: fernandol-nvidia

docs/deployment_guide/getting_started/configure_data.rst

@@ -1,5 +1,5 @@
 ..
-  SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+  SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -32,30 +32,26 @@ Workflow Logs
 Run the following commands to configure the workflow spec and log storage location in OSMO. Make sure to replace the placeholders with the actual values.
 
 .. code-block:: bash
-  :emphasize-lines: 2, 4, 5, 8
-
-  # URI of your s3 bucket e.g. s3://my_bucket
-  $ export BACKEND_URI=...
-
-  $ export ACCESS_KEY_ID=...
-  $ export ACCESS_KEY=...
-
-  # Bucket Region
-  $ export REGION=...
 
   $ cat << EOF > /tmp/workflow_log_config.json
   {
     "workflow_log": {
         "credential": {
-            "endpoint": "'$BACKEND_URI'",
-            "access_key_id": "'$ACCESS_KEY_ID'",
-            "access_key": "'$ACCESS_KEY'",
-            "region": "'$REGION'"
+            "endpoint": "s3://my_bucket/workflows",
+            "access_key_id": "EXAMPLE_ACCESS_KEY_ID",
+            "access_key": "EXAMPLE_ACCESS_KEY",
+            "region": "us-east-1",
+            "override_url": "http://minio:9000" # Optional: HTTP endpoint for non-AWS S3
         }
     }
   }
   EOF
 
+.. note::
+
+   ``override_url`` is optional. Set it only when using non-AWS S3-compatible services
+   (MinIO, Ceph, LocalStack). Leave it empty or omit it for standard AWS S3.
+
 Then, update the workflow configuration using the OSMO CLI. Please make sure you're logged in to your OSMO instance before running the following command.
 
 .. code-block:: bash
@@ -69,30 +65,26 @@ Workflow Data
 Configure the storage location for intermediate data that OSMO uses to pass outputs between workflow tasks. Replace the placeholders with your actual values.
 
 .. code-block:: bash
-  :emphasize-lines: 2, 4, 5, 8
-
-  # URI of your s3 bucket e.g. s3://my_bucket
-  $ export BACKEND_URI=...
-
-  $ export ACCESS_KEY_ID=...
-  $ export ACCESS_KEY=...
-
-  # Bucket Region
-  $ export REGION=...
 
   $ cat << EOF > /tmp/workflow_data_config.json
   {
     "workflow_data": {
         "credential": {
-            "endpoint": "'$BACKEND_URI'",
-            "access_key_id": "'$ACCESS_KEY_ID'",
-            "access_key": "'$ACCESS_KEY'",
-            "region": "'$REGION'"
+            "endpoint": "s3://my_bucket/workflows",
+            "access_key_id": "EXAMPLE_ACCESS_KEY_ID",
+            "access_key": "EXAMPLE_ACCESS_KEY",
+            "region": "us-east-1",
+            "override_url": "http://minio:9000" # Optional: HTTP endpoint for non-AWS S3
         }
     }
   }
   EOF
 
+.. note::
+
+   ``override_url`` is optional. Set it only when using non-AWS S3-compatible services
+   (MinIO, Ceph, LocalStack). Leave it empty or omit it for standard AWS S3.
+
 Then, update the workflow data configuration using the OSMO CLI. Please make sure you're logged in to your OSMO instance before running the following command.
 
 .. code-block:: bash

docs/deployment_guide/getting_started/create_storage/s3/index.rst

@@ -127,3 +127,12 @@ URIs are constructed as follows with examples for bucket name ``my_bucket``:
   s3://my_bucket
 
 Follow :ref:`configure_data` to add the bucket to OSMO.
+
+S3-Compatible Services
+======================
+
+OSMO supports MinIO, Ceph, LocalStack, and S3 API-compatible services. Storage URIs will still use
+the same S3 URI format (``s3://<bucket>``). To connect OSMO to an S3-compatible service,
+set the ``override_url`` credential field to the service's HTTP endpoint (e.g., ``http://minio:9000``).
+
+Follow :ref:`configure_data` for full credential setup instructions.

docs/spelling_wordlist.txt

@@ -35,6 +35,7 @@ benchtop
 Bitnami
 boto
 botocore
+Ceph
 checkpointing
 Checkpointing
 cli

docs/user_guide/getting_started/credentials.rst

@@ -152,19 +152,26 @@ To access your data storage within workflows, you'll need to set the appropriate
 
     .. auto-include:: data_credentials_examples.in.rst
 
-    .. tab-item:: AWS S3
+    .. tab-item:: S3 / S3-Compatible
 
-        To set a credential for S3, run the following command:
+        To set a credential for S3 or S3-compatible storage, run the following command:
 
         .. code-block:: bash
 
             $ osmo credential set my-s3-cred \
                 --type DATA \
                 --payload \
                 endpoint=s3://<bucket> \
-                region=us-east-1 \
+                region=<region> \
                 access_key_id=<access_key_id> \
                 access_key=<access_key> \
+                override_url=<http_endpoint>  # Optional: required for non-AWS S3
+
+        .. note::
+
+            ``override_url`` is only required for non-AWS S3-compatible services such as MinIO, Ceph,
+            and LocalStack. It specifies the HTTP endpoint of the service (e.g., ``http://minio:9000``).
+            Omit it for standard AWS S3.
 
         .. seealso::
 

docs/user_guide/getting_started/supported_storage.in.rst

@@ -16,7 +16,7 @@
   SPDX-License-Identifier: Apache-2.0
 ..
 
-* `AWS S3 <https://aws.amazon.com/s3>`_
+* `S3-Compatible Storage <https://aws.amazon.com/s3>`_ (AWS S3, MinIO, LocalStack, and any S3 API-compatible services)
 * `GCP Google Storage <https://cloud.google.com/storage/docs/buckets>`_
 * `Azure Blob Storage <https://azure.microsoft.com/en-us/products/storage/blobs>`_
 * `Torch Object Storage <https://docs.byteplus.com/en/docs/tos>`_