From 1ff3d4db2e10e8aa04810c690a962257ed945a41 Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Sun, 5 Jan 2025 20:44:22 -0800 Subject: [PATCH 01/17] HDDS-12024. Update try ozone with docker page --- .../01-installation/01-docker.md | 80 ++++++++++++++++++- 1 file changed, 79 insertions(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index e6a270472..98b773e9f 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -2,6 +2,84 @@ 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'; + +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 + + + + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. +
Obtain the Ozone sources from the [download](/download) page. +
Next, unpack the tarball + ```bash + tar xzf ozone--src.tar.gz + ``` + + + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. +
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. + + +2. Navigate to the compose directory in your build output: + + + ```bash + cd ozone--src/compose/ozone + ``` + + + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + + +3. Modify the configurations for Ozone (Optional) +The configurations are stored in the `docker-config` file. + + + + ```bash + ozone--src/compose/ozone/docker-config + ``` + + + + + ```bash + ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config + ``` + + + +4. Start the cluster: + + ```bash + docker compose up -d + ``` + +At this stage, a functional Apache Ozone cluster is available. + +## Next Steps + +You can enter the Ozone Manager container and try the [Ozone CLI](docs/04-user-guide/02-clients/01-ozone.md) commands + +```bash +docker compose exec om bash + +ozone +``` From 8440590258ed20c53407c64921a58332ab6cc22c Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:47:56 -0800 Subject: [PATCH 02/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 98b773e9f..4b60f09de 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -69,7 +69,7 @@ The configurations are stored in the `docker-config` file. 4. Start the cluster: ```bash - docker compose up -d + docker compose up -d --scale datanode=3 ``` At this stage, a functional Apache Ozone cluster is available. From 4caeb730c98d06bb6eb33e813dfa1c79ca98a7e1 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:48:07 -0800 Subject: [PATCH 03/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 4b60f09de..5f8cca616 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -15,7 +15,6 @@ This guide explains how to run Apache Ozone using Docker Compose, either with lo - [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 From 6df61b2a211411906992c62c6e3df936904501be Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Thu, 9 Jan 2025 23:09:17 -0800 Subject: [PATCH 04/17] HDDS-12024. Fix review comments --- .markdownlint.yaml | 2 - .../01-installation/01-docker.md | 141 ++++++++++-------- 2 files changed, 78 insertions(+), 65 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index b70e56b88..a7f1ef399 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -29,8 +29,6 @@ ul-style: line-length: # No line length requirement for general text. line_length: -1 - # For code, match Ozone's line length. - code_block_line_length: 120 # Use shorter headings to keep the minimap on the right legible. heading_block_line_length: 80 diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 5f8cca616..9dc57a76d 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -2,83 +2,98 @@ sidebar_label: Docker --- - - # Try Ozone With Docker 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. +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 either pre-built Docker images or locally built sources. ## Prerequisites -- [Docker Engine](https://www.docker.com/products/docker-desktop/) 20.10.0 or higher -- [Docker Compose](https://docs.docker.com/compose/install/) V2 - -## Running Ozone - -1. Obtain the Docker Compose configurations - - - - With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. -
Obtain the Ozone sources from the [download](/download) page. -
Next, unpack the tarball - ```bash - tar xzf ozone--src.tar.gz - ``` - - - With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. -
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. - - -2. Navigate to the compose directory in your build output: - - - ```bash - cd ozone--src/compose/ozone - ``` - - - ```bash - cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone - ``` - - -3. Modify the configurations for Ozone (Optional) -The configurations are stored in the `docker-config` file. - - - - ```bash - ozone--src/compose/ozone/docker-config - ``` - - - - - ```bash - ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config - ``` - - - -4. Start the cluster: - - ```bash - docker compose up -d --scale datanode=3 - ``` - -At this stage, a functional Apache Ozone cluster is available. +- [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version +- [Docker Compose V2](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 +``` ## Next Steps -You can enter the Ozone Manager container and try the [Ozone CLI](docs/04-user-guide/02-clients/01-ozone.md) commands +Now that your Ozone cluster is up and running, you can enter any container and try the Ozone CLI. ```bash docker compose exec om bash ozone ``` + +Next, learn how to [read and write data](/docs/quick-start/reading-writing-data) into Ozone. From 4334fd2d9b2668ed32a05f2eef920c533bdf3891 Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Thu, 9 Jan 2025 23:18:39 -0800 Subject: [PATCH 05/17] HDDS-12024. Fix review comments --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 9dc57a76d..a2d143a7a 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -12,7 +12,7 @@ Apache Ozone can be quickly deployed using Docker Compose, making it ideal for d ## Prerequisites - [Docker Engine](https://docs.docker.com/engine/install/) - Latest stable version -- [Docker Compose V2](https://docs.docker.com/compose/install/) - Latest stable version +- [Docker Compose](https://docs.docker.com/compose/install/) - Latest stable version ## Quick Start Guide From fd2116e13169b11136b96a83434cd227265f25d5 Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Thu, 9 Jan 2025 23:25:04 -0800 Subject: [PATCH 06/17] HDDS-12024. Fix review comments --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index a2d143a7a..0b05fbd47 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -7,7 +7,7 @@ sidebar_label: Docker 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 either pre-built Docker images or locally built sources. +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 From 4eca76c558ad05ca0eb97eca09b5da048e533532 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:30:03 -0800 Subject: [PATCH 07/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 0b05fbd47..eb5392a6f 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -4,9 +4,6 @@ sidebar_label: Docker # Try Ozone With Docker -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 From aa657275545c05a60c2cddecde15927704d1268f Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Fri, 10 Jan 2025 10:47:30 -0800 Subject: [PATCH 08/17] HDDS-12024. Fix review comments --- .../01-installation/01-docker.md | 35 +++++++++---------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index eb5392a6f..720296c50 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -4,6 +4,9 @@ sidebar_label: Docker # Try Ozone With Docker +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 @@ -47,23 +50,19 @@ 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 +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 web interface, which provides monitoring and management capabilities: - -- Open your web browser -- Navigate to the [Recon server home page](http://localhost:9888) +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 @@ -75,22 +74,20 @@ You can customize your Ozone deployment by modifying the configuration parameter 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: - environment: - OZONE-SITE.XML_ozone.scm.container.size: 1GB - OZONE-SITE.XML_ozone.scm.block.size: 256MB + OZONE-SITE.XML_ozone.scm.container.size: 1GB + OZONE-SITE.XML_ozone.scm.block.size: 256MB ``` ## Next Steps -Now that your Ozone cluster is up and running, you can enter any container and try the Ozone CLI. +Now that your Ozone cluster is up and running, you can enter any container and explore the environment. ```bash docker compose exec om bash - -ozone ``` Next, learn how to [read and write data](/docs/quick-start/reading-writing-data) into Ozone. From 106f647944bf22ac2ad275bf244426352748f7b2 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Fri, 10 Jan 2025 11:29:33 -0800 Subject: [PATCH 09/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 720296c50..2e0b2236f 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -4,9 +4,6 @@ sidebar_label: Docker # Try Ozone With Docker -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 From 15d37fc2f99f524180e963d3ebf0cc1e2b3a34a3 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:56:07 -0800 Subject: [PATCH 10/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 2e0b2236f..2485c7516 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -15,7 +15,7 @@ Apache Ozone can be quickly deployed using Docker Compose, making it ideal for d ### Step 1: Set Up Docker Compose Configuration -First, obtain the official Ozone Docker Compose configuration: +First, obtain Ozone's sample Docker Compose configuration: ```bash # Download the latest Docker Compose configuration file From 642dd2798fa98710aa886a09daaae6942e260eed Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:56:27 -0800 Subject: [PATCH 11/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 2485c7516..539db3ec1 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -32,7 +32,7 @@ docker compose up -d --scale datanode=3 This command will: -- Automatically pull the required Ozone images from Docker Hub +- Automatically pull required images from Docker Hub - Create a multi-node cluster with the core Ozone services - Start all components in detached mode From de1872d000fcb18b7426d5551b08ba15275f8cf3 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:56:59 -0800 Subject: [PATCH 12/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 539db3ec1..94a00724f 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -75,6 +75,7 @@ As an example, to modify the Storage Container Manager's container and block siz ```yaml x-common-config: + ... OZONE-SITE.XML_ozone.scm.container.size: 1GB OZONE-SITE.XML_ozone.scm.block.size: 256MB ``` From dc255b9ed13f2069876d5f3ebab27763b063b7a4 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:58:18 -0800 Subject: [PATCH 13/17] Update docs/02-quick-start/01-installation/01-docker.md Co-authored-by: Doroszlai, Attila <6454655+adoroszlai@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 94a00724f..0a542688d 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -70,7 +70,6 @@ You can customize your Ozone deployment by modifying the configuration parameter 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 From 2a318f091a691c6469811795added9c674a02d71 Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Tue, 14 Jan 2025 00:26:38 -0800 Subject: [PATCH 14/17] HDDS-12024. Fix review comments --- .../01-installation/01-docker.md | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 0a542688d..a59fb9723 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -11,9 +11,9 @@ Apache Ozone can be quickly deployed using Docker Compose, making it ideal for d - [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 +## Running Ozone -### Step 1: Set Up Docker Compose Configuration +### Obtain the Docker Compose Configuration First, obtain Ozone's sample Docker Compose configuration: @@ -22,7 +22,7 @@ First, obtain Ozone's sample Docker Compose configuration: curl -O https://raw.githubusercontent.com/apache/ozone-docker/refs/heads/latest/docker-compose.yaml ``` -### Step 2: Launch the Cluster +### Start the Cluster Start your Ozone cluster with three Datanodes using the following command: @@ -36,7 +36,7 @@ This command will: - Create a multi-node cluster with the core Ozone services - Start all components in detached mode -### Step 3: Verify Deployment +### Verify the Deployment Check the status of your Ozone cluster components: @@ -57,28 +57,30 @@ docker-s3g-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" s3g 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 - +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) -## Advanced Configuration - -### Customizing Ozone Settings +## 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 modify the Storage Container Manager's container and block sizes, you can add the following additional properties to the `x-common-config` section +As an example, to update the port on which Recon listens to, append the following configuration: ```yaml x-common-config: ... - OZONE-SITE.XML_ozone.scm.container.size: 1GB - OZONE-SITE.XML_ozone.scm.block.size: 256MB + 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 + ## Next Steps Now that your Ozone cluster is up and running, you can enter any container and explore the environment. From abe3c897de0e0ec9dccd70a39b3779973d77b280 Mon Sep 17 00:00:00 2001 From: Rishabh Patel Date: Tue, 14 Jan 2025 08:43:07 -0800 Subject: [PATCH 15/17] HDDS-12024. Fix markdownlint issue --- docs/02-quick-start/01-installation/01-docker.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index a59fb9723..9fbe87431 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -58,10 +58,12 @@ docker-scm-1 apache/ozone:1.4.1-rocky "/usr/local/bin/dumb…" scm ``` 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 From be9101b08d716473ecee30aa6d90a204e60f063d Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 20 Jan 2025 13:52:14 -0800 Subject: [PATCH 16/17] Update 01-docker.md Co-authored-by: Ethan Rose <33912936+errose28@users.noreply.github.com> --- .../01-installation/01-docker.md | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 9fbe87431..55e0f3114 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -38,33 +38,33 @@ This command will: ### Verify the Deployment -Check the status of your Ozone cluster components: +1. Check the status of your Ozone cluster components: -```bash -docker compose ps -``` + ```bash + docker compose ps + ``` -You should see output similar to this: + 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 -``` + ```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 +2. Check the Ozone version -```bash -docker compose exec om bash -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) +3. Access the Ozone Recon server, which provides monitoring and management capabilities by navigating to the [Recon server home page](http://localhost:9888). ## Configuration From ae13c84e3b5199816211c071099afc944500b045 Mon Sep 17 00:00:00 2001 From: Rishabh Patel <1607531+ptlrs@users.noreply.github.com> Date: Mon, 20 Jan 2025 13:52:20 -0800 Subject: [PATCH 17/17] Update 01-docker.md Co-authored-by: Ethan Rose <33912936+errose28@users.noreply.github.com> --- docs/02-quick-start/01-installation/01-docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-quick-start/01-installation/01-docker.md b/docs/02-quick-start/01-installation/01-docker.md index 55e0f3114..030e04058 100644 --- a/docs/02-quick-start/01-installation/01-docker.md +++ b/docs/02-quick-start/01-installation/01-docker.md @@ -81,7 +81,7 @@ 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 +Refer to the [Configuring Ozone For Production](/docs/quick-start/installation/docker) page for more configuration guidelines. ## Next Steps