adoroszlai commented on code in PR #122: URL: https://github.com/apache/ozone-site/pull/122#discussion_r1909933347
########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,96 @@ sidebar_label: Docker # Try Ozone With Docker -**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Review Comment: I don't think this is still needed: ```suggestion ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,96 @@ sidebar_label: Docker # Try Ozone With Docker -**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Apache Ozone can be quickly deployed using Docker Compose, making it ideal for development, testing, and evaluation purposes. This guide walks you through setting up a multi-node Ozone cluster using pre-built Docker images. + +## Prerequisites + +- [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version +- [Docker Compose](https://docs.docker.com/compose/install/) - Latest stable version + +## Quick Start Guide + +### Step 1: Set Up Docker Compose Configuration + +First, obtain the official Ozone Docker Compose configuration: + +```bash +# Download the latest Docker Compose configuration file +curl -O https://raw.githubusercontent.com/apache/ozone-docker/refs/heads/latest/docker-compose.yaml +``` + +### Step 2: Launch the Cluster + +Start your Ozone cluster with three Datanodes using the following command: + +```bash +docker compose up -d --scale datanode=3 +``` + +This command will: + +- Automatically pull the required Ozone images from Docker Hub +- Create a multi-node cluster with the core Ozone services +- Start all components in detached mode + +### Step 3: Verify Deployment + +Check the status of your Ozone cluster components: + +```bash +docker compose ps +``` + +You should see output similar to this: + +```bash +NAME IMAGE COMMAND SERVICE STATUS PORTS +ozone-datanode-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61896->9882/tcp, 0.0.0.0:61897->19864/tcp +ozone-datanode-2 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61895->9882/tcp, 0.0.0.0:61894->19864/tcp +ozone-datanode-3 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61892->9882/tcp, 0.0.0.0:61893->19864/tcp +ozone-httpfs-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" httpfs Up 0.0.0.0:14000->14000/tcp +ozone-om-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" om Up 0.0.0.0:9862->9862/tcp, 0.0.0.0:9874->9874/tcp +ozone-recon-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" recon Up 0.0.0.0:9888->9888/tcp +ozone-s3g-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" s3g Up 0.0.0.0:9878->9878/tcp +ozone-scm-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" scm Up 0.0.0.0:9860->9860/tcp, 0.0.0.0:9876->9876/tcp Review Comment: This references the `ozone-runner` image, but it should be using `ozone`. I guess that's because the PR in `ozone-docker` is not yet committed, so the URL from step 1 does not yet work. However, you can [fetch](https://raw.githubusercontent.com/apache/ozone-docker/5233fb7dc170f26980747d62294e0a5706779fa6/docker-compose.yaml) the file from the PR, and use it for testing the steps / getting sample output. ``` docker compose ps NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS docker-datanode-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" datanode 14 seconds ago Up 13 seconds 0.0.0.0:32958->9864/tcp, :::32958->9864/tcp docker-datanode-2 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" datanode 14 seconds ago Up 13 seconds 0.0.0.0:32957->9864/tcp, :::32957->9864/tcp docker-datanode-3 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" datanode 14 seconds ago Up 12 seconds 0.0.0.0:32959->9864/tcp, :::32959->9864/tcp docker-om-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" om 14 seconds ago Up 13 seconds 0.0.0.0:9874->9874/tcp, :::9874->9874/tcp docker-recon-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" recon 14 seconds ago Up 13 seconds 0.0.0.0:9888->9888/tcp, :::9888->9888/tcp docker-s3g-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" s3g 14 seconds ago Up 13 seconds 0.0.0.0:9878->9878/tcp, :::9878->9878/tcp docker-scm-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" scm 14 seconds ago Up 13 seconds 0.0.0.0:9876->9876/tcp, :::9876->9876/tcp ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,96 @@ sidebar_label: Docker # Try Ozone With Docker -**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Apache Ozone can be quickly deployed using Docker Compose, making it ideal for development, testing, and evaluation purposes. This guide walks you through setting up a multi-node Ozone cluster using pre-built Docker images. + +## Prerequisites + +- [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version +- [Docker Compose](https://docs.docker.com/compose/install/) - Latest stable version + +## Quick Start Guide + +### Step 1: Set Up Docker Compose Configuration + +First, obtain the official Ozone Docker Compose configuration: + +```bash +# Download the latest Docker Compose configuration file +curl -O https://raw.githubusercontent.com/apache/ozone-docker/refs/heads/latest/docker-compose.yaml +``` + +### Step 2: Launch the Cluster + +Start your Ozone cluster with three Datanodes using the following command: + +```bash +docker compose up -d --scale datanode=3 +``` + +This command will: + +- Automatically pull the required Ozone images from Docker Hub +- Create a multi-node cluster with the core Ozone services +- Start all components in detached mode + +### Step 3: Verify Deployment + +Check the status of your Ozone cluster components: + +```bash +docker compose ps +``` + +You should see output similar to this: + +```bash +NAME IMAGE COMMAND SERVICE STATUS PORTS +ozone-datanode-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61896->9882/tcp, 0.0.0.0:61897->19864/tcp +ozone-datanode-2 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61895->9882/tcp, 0.0.0.0:61894->19864/tcp +ozone-datanode-3 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61892->9882/tcp, 0.0.0.0:61893->19864/tcp +ozone-httpfs-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" httpfs Up 0.0.0.0:14000->14000/tcp +ozone-om-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" om Up 0.0.0.0:9862->9862/tcp, 0.0.0.0:9874->9874/tcp +ozone-recon-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" recon Up 0.0.0.0:9888->9888/tcp +ozone-s3g-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" s3g Up 0.0.0.0:9878->9878/tcp +ozone-scm-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" scm Up 0.0.0.0:9860->9860/tcp, 0.0.0.0:9876->9876/tcp +``` + +### Step 4: Access the Management Console + +Once your cluster is running, you can access the Ozone Recon web interface, which provides monitoring and management capabilities: + +- Open your web browser +- Navigate to the [Recon server home page](http://localhost:9888) + +## Advanced Configuration + +### Customizing Ozone Settings + +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 +x-common-config: + environment: + OZONE-SITE.XML_ozone.scm.container.size: 1GB + OZONE-SITE.XML_ozone.scm.block.size: 256MB Review Comment: `x-common-config` defines config properties, but not the `environment` map, to allow services to add other properties. Otherwise `environment` of the service would overwrite the `environment` map from the common config (or vice versa, depending on the order). ```suggestion OZONE-SITE.XML_ozone.scm.container.size: 1GB OZONE-SITE.XML_ozone.scm.block.size: 256MB ``` And somehow we should indicate that these two properties are additional ones, not intended to replace `x-common-config` entirely. ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,96 @@ sidebar_label: Docker # Try Ozone With Docker -**TODO:** File a subtask under [HDDS-9856](https://issues.apache.org/jira/browse/HDDS-9856) and complete this page or section. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Apache Ozone can be quickly deployed using Docker Compose, making it ideal for development, testing, and evaluation purposes. This guide walks you through setting up a multi-node Ozone cluster using pre-built Docker images. + +## Prerequisites + +- [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version +- [Docker Compose](https://docs.docker.com/compose/install/) - Latest stable version + +## Quick Start Guide + +### Step 1: Set Up Docker Compose Configuration + +First, obtain the official Ozone Docker Compose configuration: + +```bash +# Download the latest Docker Compose configuration file +curl -O https://raw.githubusercontent.com/apache/ozone-docker/refs/heads/latest/docker-compose.yaml +``` + +### Step 2: Launch the Cluster + +Start your Ozone cluster with three Datanodes using the following command: + +```bash +docker compose up -d --scale datanode=3 +``` + +This command will: + +- Automatically pull the required Ozone images from Docker Hub +- Create a multi-node cluster with the core Ozone services +- Start all components in detached mode + +### Step 3: Verify Deployment + +Check the status of your Ozone cluster components: + +```bash +docker compose ps +``` + +You should see output similar to this: + +```bash +NAME IMAGE COMMAND SERVICE STATUS PORTS +ozone-datanode-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61896->9882/tcp, 0.0.0.0:61897->19864/tcp +ozone-datanode-2 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61895->9882/tcp, 0.0.0.0:61894->19864/tcp +ozone-datanode-3 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" datanode Up 0.0.0.0:61892->9882/tcp, 0.0.0.0:61893->19864/tcp +ozone-httpfs-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" httpfs Up 0.0.0.0:14000->14000/tcp +ozone-om-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" om Up 0.0.0.0:9862->9862/tcp, 0.0.0.0:9874->9874/tcp +ozone-recon-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" recon Up 0.0.0.0:9888->9888/tcp +ozone-s3g-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" s3g Up 0.0.0.0:9878->9878/tcp +ozone-scm-1 apache/ozone-runner:20241216-1-jdk21 "/usr/local/bin/dumb…" scm Up 0.0.0.0:9860->9860/tcp, 0.0.0.0:9876->9876/tcp +``` + +### Step 4: Access the Management Console + +Once your cluster is running, you can access the Ozone Recon web interface, which provides monitoring and management capabilities: + +- Open your web browser Review Comment: I guess if they are reading this doc, browser is already open. ;) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
