adoroszlai commented on code in PR #122: URL: https://github.com/apache/ozone-site/pull/122#discussion_r1913511980
########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,87 @@ 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. +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 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 +``` + +### Step 4: Access the Management Console + +Once your cluster is running, you can access the Ozone Recon server, which provides monitoring and management capabilities by navigating 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: +As an example, to modify the Storage Container Manager's container and block sizes, you can add the following additional properties to the `x-common-config` section + +```yaml +x-common-config: + OZONE-SITE.XML_ozone.scm.container.size: 1GB + OZONE-SITE.XML_ozone.scm.block.size: 256MB Review Comment: Let's add ... to indicate these properties are in addition to the original list, not replacement. ```suggestion x-common-config: ... OZONE-SITE.XML_ozone.scm.container.size: 1GB OZONE-SITE.XML_ozone.scm.block.size: 256MB ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,87 @@ 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. +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 Review Comment: Only one Ozone image will be pulled. We may add other kinds of images later, e.g. to support secure setup. ```suggestion - Automatically pull required images from Docker Hub ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,87 @@ 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. +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 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 +``` + +### Step 4: Access the Management Console + +Once your cluster is running, you can access the Ozone Recon server, which provides monitoring and management capabilities by navigating 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: +As an example, to modify the Storage Container Manager's container and block sizes, you can add the following additional properties to the `x-common-config` section Review Comment: Having both `Example configuration modification` and `As an example` seems to be a repetition to me. ```suggestion As an example, to modify the Storage Container Manager's container and block sizes, you can add the following additional properties to the `x-common-config` section ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,87 @@ 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. +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: Review Comment: It's not really "official", just a quick-start example. ```suggestion First, obtain Ozone's sample Docker Compose configuration: ``` -- 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]
