adoroszlai commented on code in PR #122: URL: https://github.com/apache/ozone-site/pull/122#discussion_r1904176789
########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> Review Comment: - Compose file from tarball and from repo is the same, they both use `ozone-runner`. - Using Ozone sources without build (in `Tarball` scenario) will fail. - Building Ozone from sources belongs to the developer guide (HDDS-11631). So I think we should stick to using pre-built images in this quick start. We have a working `docker-compose.yaml` file in the `ozone-docker` repo. I suggest providing a download link for that. Currently it requires separate `docker-config` and `.env` files, but https://github.com/apache/ozone-docker/pull/38 will combine them, partly to simplify the steps here. Once the `ozone-docker` PR is merged, obtaining compose steps can be simplified to: > Download [Compose file](https://github.com/apache/ozone-docker/raw/refs/heads/latest/docker-compose.yaml) ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 Review Comment: This links to Docker Desktop, which bundles Docker Engine, Docker Compose and other tools. I think we should link to https://docs.docker.com/engine/install/ instead. What is the source of the requirement "20.10.0 or higher"? ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> +2. Navigate to the compose directory in your build output: +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + ```bash + cd ozone-<version>-src/compose/ozone + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + </TabItem> +</Tabs> +3. Modify the configurations for Ozone (Optional) +The configurations are stored in the `docker-config` file. +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + + ```bash + ozone-<version>-src/compose/ozone/docker-config + ``` + + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + + ```bash + ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config + ``` + +</TabItem> +</Tabs> +4. Start the cluster: + + ```bash + docker compose up -d Review Comment: ```suggestion docker compose up -d --scale datanode=3 ``` (or even 5, to allow using EC) ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> +2. Navigate to the compose directory in your build output: +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + ```bash + cd ozone-<version>-src/compose/ozone + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + </TabItem> +</Tabs> Review Comment: This can be removed with standalone compose file. ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> +2. Navigate to the compose directory in your build output: +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + ```bash + cd ozone-<version>-src/compose/ozone + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + </TabItem> +</Tabs> +3. Modify the configurations for Ozone (Optional) +The configurations are stored in the `docker-config` file. +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + + ```bash + ozone-<version>-src/compose/ozone/docker-config + ``` + + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + + ```bash + ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config + ``` + +</TabItem> +</Tabs> +4. Start the cluster: + + ```bash + docker compose up -d + ``` + +At this stage, a functional Apache Ozone cluster is available. Review Comment: Let's add few basic steps to verify this: 1. `docker compose ps` with sample output 2. mention web UI available on localhost ports ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> +2. Navigate to the compose directory in your build output: +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + ```bash + cd ozone-<version>-src/compose/ozone + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + </TabItem> +</Tabs> +3. Modify the configurations for Ozone (Optional) +The configurations are stored in the `docker-config` file. +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + + ```bash + ozone-<version>-src/compose/ozone/docker-config + ``` + + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + + ```bash + ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config + ``` + +</TabItem> +</Tabs> +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 +``` Review Comment: I think: - Ozone CLI page will be a more in-depth description - usage help from plain `ozone` command would be overwhelming (commands to start server-side components, many other obscure subcommands) - Referring to "Quick Start > Reading and Writing Data" page would be more appropriate here. - We should mention that they can interact with Ozone by executing commands in any of the Docker containers started with Compose, not just Ozone Manager. ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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) Review Comment: ```suggestion ``` ########## docs/02-quick-start/01-installation/01-docker.md: ########## @@ -2,6 +2,84 @@ sidebar_label: Docker --- +<!-- cspell:words xzf --> + # 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 + +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + With this option, the Docker Compose cluster will automatically fetch the required images from Docker Hub. + <br/>Obtain the Ozone sources from the [download](/download) page. + <br/>Next, unpack the tarball + ```bash + tar xzf ozone-<version>-src.tar.gz + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + With this option, the `ozone-docker-runner` image will use the compiled Ozone binaries to run the Docker Compose cluster. + <br/> 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. + </TabItem> +</Tabs> +2. Navigate to the compose directory in your build output: +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + ```bash + cd ozone-<version>-src/compose/ozone + ``` + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + ```bash + cd ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone + ``` + </TabItem> +</Tabs> +3. Modify the configurations for Ozone (Optional) +The configurations are stored in the `docker-config` file. +<Tabs groupId="source-based-instructions"> + <TabItem value="Tarball" label="Tarball" default> + + ```bash + ozone-<version>-src/compose/ozone/docker-config + ``` + + </TabItem> + <TabItem value="Building from Source" label="Building from Source" default> + + ```bash + ./hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone/docker-config + ``` Review Comment: I suggest moving the info on how to modify configuration to an "advanced" section at the end of this page. -- 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]
