Skip to content

Commit

Permalink
HDDS-11631. Fix linter errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ptlrs committed Oct 31, 2024
1 parent c31c52f commit 8554c03
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 26 deletions.
1 change: 1 addition & 0 deletions cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ words:
- ratis
- OM
- SCM
- DN
- datanode
- datanodes
- ofs
Expand Down
1 change: 0 additions & 1 deletion docs/06-troubleshooting/15-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ sidebar_label: Docker
# Troubleshooting Docker

**TODO:** File a subtask under [HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this page or section.

54 changes: 29 additions & 25 deletions docs/08-developer-guide/02-run/02-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: Docker Compose
---

# Running Ozone From Docker Compose

**TODO:** File a subtask under [HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this page or section.

Expand All @@ -10,8 +11,6 @@ sidebar_label: Docker Compose
- How to define which image gets used in the cluster (runner or other pre-built image).
- Changing configurations in Docker Compose (`docker-config` file, transformation.py, etc).

# Running Ozone From Docker Compose

This guide explains how to run Apache Ozone using Docker Compose, either with locally built sources or pre-built images.

## Prerequisites
Expand All @@ -29,14 +28,16 @@ You can run Ozone either using your locally built version or using official pre-
If you've built Ozone from source, follow these steps:

1. Navigate to the compose directory in your build output:
```bash
cd hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone
```

```bash
cd hadoop-ozone/dist/target/ozone-*-SNAPSHOT/compose/ozone
```

2. Start the cluster:
```bash
docker-compose up -d
```

```bash
docker-compose up -d
```

The local build uses the `ozone-docker-runner` image, which is automatically created during the build process to wrap your compiled Ozone binaries.

Expand All @@ -45,19 +46,24 @@ The local build uses the `ozone-docker-runner` image, which is automatically cre
If you haven't built Ozone locally, you can quickly start a cluster using official pre-built images from Docker Hub:
1. Create a directory for your Ozone deployment:
```bash
mkdir ozone && cd ozone
```
2. Download the example composefile:
```bash
curl https://raw.githubusercontent.com/apache/ozone/master/hadoop-ozone/dist/src/main/compose/ozone/docker-compose.yaml -o docker-compose.yaml
```
```bash
mkdir ozone && cd ozone
```
2. Download the example compose file:
```bash
curl \
https://raw.githubusercontent.com/apache/ozone/master/hadoop-ozone/dist/src/main/compose/ozone/docker-compose.yaml \
-o docker-compose.yaml
```
3. Start the cluster:
```bash
docker-compose up -d
```
```bash
docker-compose up -d
```
This will pull the official Apache Ozone images from Docker Hub.
Expand All @@ -72,7 +78,7 @@ graph TB
om["OM<br/>Ozone Manager<br/>(Port: 9874, 9862)"]
s3g["S3G<br/>S3 Gateway<br/>(Port: 9878)"]
recon["Recon<br/>Monitoring Service<br/>(Port: 9888)"]
httpfs["HTTPFS<br/>HTTP FileSystem<br/>(Port: 14000)"]
httpfs["HttpFS<br/>HTTP FileSystem<br/>(Port: 14000)"]
subgraph "Data Nodes"
dn1["DataNode 1<br/>(Port: 19864, 9882)"]
Expand Down Expand Up @@ -100,7 +106,6 @@ graph TB
class scm,om manager;
```

## Cluster Configuration
### Default Services
Expand All @@ -111,9 +116,8 @@ The default Docker Compose configuration includes:
- Ozone Manager (OM)
- S3 Gateway
- Recon (Monitoring Service)
- DataNodes
- HTTPFS

- Datanodes
- HttpFS
### Port Mappings
Expand All @@ -123,8 +127,8 @@ The default setup exposes the following ports:
- OM: 9874 (RPC), 9862 (Client)
- S3 Gateway: 9878
- Recon: 9888
- HTTPFS: 14000
- DataNodes: 19864 (Container), 9882 (Client)
- HttpFS: 14000
- Datanodes: 19864 (Container), 9882 (Client)
## Cluster Management
Expand Down

0 comments on commit 8554c03

Please sign in to comment.