HDDS-11631. Add Run with Docker Compose guide

docs/06-troubleshooting/15-docker.md

@@ -0,0 +1,7 @@
+---
+sidebar_label: Docker
+---
+
+# Troubleshooting Ozone in Docker
+
+**TODO:** File a subtask under [HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this page or section.

docs/08-developer-guide/02-run/02-docker-compose.md

@@ -2,11 +2,163 @@
 sidebar_label: Docker Compose
 ---
 
+<!-- cspell:words xzf -->
+
 # Running Ozone From Docker Compose
 
-**TODO:** File a subtask under [HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this page or section.
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+This guide explains how to run Apache Ozone using Docker Compose, either with locally built sources or pre-built images.
+
+## Prerequisites
+
+- [Docker Engine](https://www.docker.com/products/docker-desktop/) 20.10.0 or higher
+- [Docker Compose](https://docs.docker.com/compose/install/) V2
+- Built Ozone distribution (if running from local build)
+
+## Running Ozone
+
+1. Obtain the Docker Compose configurations
+
+<Tabs groupId="source-based-instructions">
+  <TabItem value="Tarball" label="Tarball" default>
+    With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub.
+    <br/>Obtain the Ozone sources from the [download](/download) page.
+    <br/>Next, unpack the tarball
+    ```bash
+    tar xzf ozone-<version>-src.tar.gz
+    ```
+  </TabItem>
+  <TabItem value="Building from Source" label="Building from Source" default>
+  With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster.
+  <br/> Follow the steps listed in the [Build with Maven](/docs/08-developer-guide/01-build/02-maven.md) page to obtain the sources and compile them.
+  </TabItem>
+</Tabs>
+2. Navigate to the compose directory in your build output:
+<Tabs groupId="source-based-instructions">
+  <TabItem value="Tarball" label="Tarball" default>
+    ```bash
+    cd ozone-<version>-src/compose/ozone
+    ```
+  </TabItem>
+  <TabItem value="Building from Source" label="Building from Source" default>
+    ```bash
+    cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone
+    ```
+  </TabItem>
+</Tabs>
+3. Modify the configurations for Ozone (Optional)
+The configurations are stored in the `docker-config` file.
+<Tabs groupId="source-based-instructions">
+   <TabItem value="Tarball" label="Tarball" default>
+
+   ```bash
+   ozone-<version>-src/compose/ozone/docker-config
+   ```
+
+   </TabItem>
+   <TabItem value="Building from Source" label="Building from Source" default>
+
+   ```bash
+   ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config
+   ```
+
+</TabItem>
+</Tabs>
+4. Start the cluster:
+
+ ```bash
+ docker compose up -d
+ ```
+
+## Container Diagram
+
+This image shows the containers that will be created by the `docker compose up -d` command.
+
+<!-- cspell:word DN -->
+
+```mermaid
+graph TB
+    subgraph "Apache Ozone Containers"
+        scm["SCM<br/>Storage Container Manager<br/>(Port: 9876, 9860)"]
+        om["OM<br/>Ozone Manager<br/>(Port: 9874, 9862)"]
+        s3g["S3G<br/>S3 Gateway<br/>(Port: 9878)"]
+        recon["Recon<br/>Monitoring Service<br/>(Port: 9888)"]
+        httpfs["HttpFS<br/>HTTP FileSystem<br/>(Port: 14000)"]
+
+        subgraph "Data Nodes"
+            dn1["DataNode 1<br/>(Port: 19864, 9882)"]
+            dnN["DataNode N<br/>(Port: 19864, 9882)"]
+        end
+
+        %% Connections
+        scm --> dn1
+        scm --> dnN
+        om --> dn1
+        om --> dnN
+        s3g --> om
+        s3g --> scm
+        httpfs --> om
+        httpfs --> scm
+        recon --> scm
+        recon --> om
+    end
+
+    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px;
+    classDef datanode fill:#e1f5fe,stroke:#0288d1,stroke-width:2px;
+    classDef manager fill:#e8f5e9,stroke:#388e3c,stroke-width:2px;
+
+    class dn1,dnN datanode;
+    class scm,om manager;
+```
+
+## Cluster Configuration
+
+### Default Services
+
+The default Docker Compose configuration includes:
+
+- Storage Container Manager (SCM)
+- Ozone Manager (OM)
+- S3 Gateway
+- Recon (Monitoring Service)
+- Datanodes
+- HttpFS
+
+## Cluster Management
+
+Common Docker Compose commands:
+
+```bash
+# Start the cluster
+docker compose up -d
+
+# Stop the cluster
+docker compose down
+
+# View service logs
+docker compose logs -f [service_name]
+
+# Scale data nodes
+docker compose up -d --scale datanode=3
+
+# Check service status
+docker compose ps
+```
+
+# Next Steps
+
+This page explains the Docker Compose configuration for a basic Ozone cluster.
+You can next explore some of the other Docker Compose configurations that are available under the compose directory.
+
+```bash
+cd hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/
+```
 
-- Reference common clusters from acceptance tests that can be used.
-- Define the Ozone runner image at `ozone-docker-runner` and its purpose to wrap Ozone binaries.
-- How to define which image gets used in the cluster (runner or other pre-built image).
-- Changing configurations in Docker Compose (`docker-config` file, transformation.py, etc).
+| Docker Compose configuration | Description |
+|--------------|-------------|
+| ozone-ha     | Explore Ozone high availability with this configuration |
+| ozone-secure | Explore various SSL certificate and Kerberos configurations |
+| topology     | Explore the rack-aware configuration |
+| upgrade      | Explore the non-rolling upgrade configuration |

docusaurus.config.js

@@ -85,6 +85,7 @@ const config = {
   ],
 
   markdown: {
+    mermaid: true,
     /*
     Validate markdown frontmatter against a more restrictive schema than what Docusaurus allows.
     This ensures all pages are using a minimal set of consistent keys.
@@ -170,6 +171,7 @@ const config = {
     ]
   ],
 
+  themes: ['@docusaurus/theme-mermaid'],
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({

package.json

@@ -1,5 +1,5 @@
 {
-  "packageManager": "pnpm@8.7.1",
+  "packageManager": "pnpm@9.12.3",
   "name": "doc-site",
   "version": "0.1.0",
   "private": true,
@@ -16,22 +16,23 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.3.2",
-    "@docusaurus/preset-classic": "3.3.2",
     "@docusaurus/plugin-pwa": "3.3.2",
+    "@docusaurus/preset-classic": "3.3.2",
+    "@docusaurus/theme-mermaid": "3.3.2",
     "@mdx-js/react": "^3.0.0",
+    "ajv": "^8.12.0",
     "clsx": "^2.1.0",
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "ajv": "^8.12.0"
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.3.2",
-    "cspell": "^8.2.1",
     "@cspell/dict-docker": "^1.1.7",
     "@cspell/dict-java": "^5.0.6",
     "@cspell/dict-markdown": "^2.0.1",
     "@cspell/dict-shell": "^1.0.6",
+    "@docusaurus/module-type-aliases": "3.3.2",
+    "cspell": "^8.2.1",
     "markdownlint-cli": "^0.39.0"
   },
   "browserslist": {