errose28 commented on code in PR #122: URL: https://github.com/apache/ozone-site/pull/122#discussion_r1919296437
########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,91 @@ 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 + +## Running Ozone + +### Obtain the Docker Compose Configuration + +First, obtain Ozone's sample 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 +``` + +### Start 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 required images from Docker Hub +- Create a multi-node cluster with the core Ozone services +- Start all components in detached mode + +### Verify the 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 +``` + +Find the Ozone version + +```bash +docker compose exec om bash +ozone version +``` + +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) + +## Configuration + +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 + +As an example, to update the port on which Recon listens to, append the following configuration: + +```yaml +x-common-config: + ... + OZONE-SITE.XML_ozone.recon.http-address: 0.0.0.0:9090 +``` + +Refer to the [Configuring Ozone For Production](/docs/quick-start/installation/docker) page for more configuration guidelines Review Comment: ```suggestion Refer to the [Configuring Ozone For Production](/docs/quick-start/installation/docker) page for more configuration guidelines. ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -4,4 +4,91 @@ 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 + +## Running Ozone + +### Obtain the Docker Compose Configuration + +First, obtain Ozone's sample 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 +``` + +### Start 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 required images from Docker Hub +- Create a multi-node cluster with the core Ozone services +- Start all components in detached mode + +### Verify the 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 +``` + +Find the Ozone version + +```bash +docker compose exec om bash +ozone version +``` + +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) Review Comment: Let's make this na ordered list so it's easier to follow ```suggestion 1. 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 ``` 2. Check the Ozone version ```bash docker compose exec om bash ozone version ``` 3. Access the Ozone Recon server, which provides monitoring and management capabilities by navigating to the [Recon server home page](http://localhost:9888). ``` -- 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]
