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

@@ -4,9 +4,170 @@ sidebar_label: Docker Compose
 
 # 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';
 
-- 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).
+This guide walks you through the process of building Apache Ozone from source and running it using Docker Compose. This approach is particularly useful for development, testing, and understanding Ozone's architecture.
+
+## Prerequisites
+
+Before you begin, ensure you have installed:
+
+- [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version
+- [Docker Compose](https://docs.docker.com/compose/install/) - Latest stable version
+
+## Building and Deploying Ozone
+
+### Step 1: Build from Source
+
+First, build Ozone from source following our [Build with Maven](/docs/08-developer-guide/01-build/01-maven.md) guide.
+
+### Step 2: Locate Docker Compose Files
+
+Navigate to the compose directory in your build output:
+
+```bash
+cd ./hadoop-ozone/dist/target/ozone-<VERSION>/compose/ozone
+```
+
+### Step 3: Configure Your Deployment (Optional)
+
+You can customize your Ozone deployment by modifying the configuration parameters in the `docker-compose.yaml` file:
+
+1. **Common Configurations**: Located under the `x-common-config` section
+2. **Service-Specific Settings**: Found under the `environment` section of individual services
+
+Example configuration modification:
+
+```yaml
+# Example configuration modifications
+x-common-config:
+  environment:
+    OZONE-SITE.XML_ozone.scm.container.size: 1GB
+    OZONE-SITE.XML_ozone.scm.block.size: 256MB
+```
+
+### Step 4: Launch the Cluster
+
+Start your Ozone cluster:
+
+```bash
+docker compose up -d --scale datanode=3
+```
+
+This command creates a fully functional Apache Ozone cluster using the `ozone-docker-runner` base image, which mounts your locally compiled Ozone binaries.
+
+## Container Diagram
+
+This image shows the containers that will be created by the `docker compose up -d` command when running the default Docker Compose configuration under `/compose/ozone` .
+
+<!-- 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 Components
+
+### Core Services
+
+Your Ozone cluster includes the following components:
+
+- **Storage Container Manager (SCM)**: Manages storage containers and block allocation
+- **Ozone Manager (OM)**: Handles namespace operations and metadata management
+- **S3 Gateway**: Provides S3-compatible API access
+- **Recon**: Monitoring and management service
+- **Datanodes**: Distributed storage nodes
+- **HttpFS**: HTTP-based filesystem interface
+
+## Cluster Management
+
+### Essential Commands
+
+Here are the key commands for managing your Ozone cluster:
+
+```bash
+# Start the cluster
+docker compose up -d
+
+# Stop and remove all containers
+docker compose down
+
+# Monitor service logs
+docker compose logs -f [service_name]
+
+# Scale the number of datanodes
+docker compose up -d --scale datanode=3
+
+# Check cluster status
+docker compose ps
+```
+
+### CLI Access
+
+Access the Ozone command-line interface from any Ozone container:
+
+```bash
+# Enter the Ozone Manager container or any other container
+docker compose exec om bash
+
+# Run Ozone commands
+ozone
+```
+
+## Advanced Configurations
+
+The compose directory includes several specialized configurations for different use cases:
+
+<!-- cspell:word  ozonesecure -->
+
+| Configuration  | Purpose                                 |
+|----------------|-----------------------------------------|
+| ozone-ha       | High availability deployment setup      |
+| ozonesecure    | Security features with SSL and Kerberos |
+| ozone-topology | Rack-aware deployment configuration     |
+| upgrade        | Non-rolling upgrade testing environment |
+
+To explore these configurations:
+
+```bash
+cd hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/
+```
+
+## Next Steps
+
+After setting up your development cluster:
+
+1. Explore the [Ozone CLI documentation](/docs/04-user-guide/02-clients/01-ozone.md)
+2. Experiment with the various compose configurations for specific use cases

docusaurus.config.js

@@ -86,6 +86,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.
@@ -171,6 +172,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,
@@ -18,6 +18,7 @@
     "@docusaurus/core": "3.7.0",
     "@docusaurus/plugin-pwa": "^3.7.0",
     "@docusaurus/preset-classic": "3.7.0",
+    "@docusaurus/theme-mermaid": "3.7.0",
     "@mdx-js/react": "^3.1.0",
     "ajv": "^8.17.1",
     "clsx": "^2.1.1",