Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
abbaa24
HDDS-11630. Added Building Ozone With Maven guide
ptlrs Oct 31, 2024
8423cf1
HDDS-11630. Updated spelling list
ptlrs Oct 31, 2024
9d4d3f8
HDDS-11630. Fix markdown linter errors
ptlrs Oct 31, 2024
2145ef7
HDDS-11630. Fix review comments
ptlrs Nov 13, 2024
f8459bc
HDDS-11630. Fix review comments
ptlrs Nov 13, 2024
a5d0551
HDDS-11630. Update maven options
ptlrs Nov 13, 2024
ca27d88
HDDS-11630. Fix review comments
ptlrs Nov 14, 2024
7591004
HDDS-11630. Fix review comments
ptlrs Nov 14, 2024
a3499f8
Update docs/08-developer-guide/01-build/01-maven.md
jojochuang Dec 12, 2024
abec6df
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
956f1f3
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
dbb9d0b
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
69cd6be
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
4167650
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
ec98f47
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
a863aa3
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 6, 2025
fb636d0
Merge remote-tracking branch 'upstream/HDDS-9225-website-v2' into HDD…
ptlrs Jan 6, 2025
6ec8baa
HDDS-11630. Fix review comments
ptlrs Jan 6, 2025
38ce41e
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 10, 2025
5de3cf2
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 10, 2025
1eb64c4
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 10, 2025
8face23
HDDS-11630. Fix review comments
ptlrs Jan 10, 2025
30fd649
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 13, 2025
5bfcf48
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 13, 2025
77cfc83
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 13, 2025
ad9fa21
Remove TODO
ptlrs Jan 13, 2025
cef3440
Remove extra lines
ptlrs Jan 13, 2025
e028b18
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 14, 2025
a009dca
Update docs/08-developer-guide/01-build/01-maven.md
ptlrs Jan 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 129 additions & 0 deletions docs/08-developer-guide/01-build/01-maven.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
sidebar_label: Maven
---

<!-- cspell:words xzf Dskip Pdist installnpm installnpx installyarn -->

# Building Ozone With Maven

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

- Cover basic Maven commands to build and run tests.
- Document all the Ozone specific Maven flags we use to speed up or skip parts of the build, and when they are useful.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide explains how to build Apache Ozone from source using Maven and prepare it for deployment.

## Prerequisites

**TODO** : [HDDS-11625](https://issues.apache.org/jira/browse/HDDS-11625) Finalize the version numbers of prerequisite packages

Before you begin, ensure you have the following installed on your build machine:

- Java 1.8 or higher
- Apache Maven 3.6.3 or higher
- Git (if building from source repository)

## Obtain the Source Code

You can build Apache Ozone either by cloning the source code from Git or by downloading the official source tarball.

Choose one of the following methods to get the source code:

<Tabs>
<TabItem value="Git" label="Git" default>
Use this option to build any release, tag or commit of Ozone.
```bash
git clone https://github.com/apache/ozone.git
cd ozone
```
</TabItem>
<TabItem value="Tarball" label="Tarball">
Use this option if you only want the released version of Ozone.
<br/>Obtain the Ozone sources from the [download](/download) page.
<br/>Next, unpack the tarball
```bash
tar xzf ozone-<version>-src.tar.gz
cd ozone-<version>-src
```
</TabItem>
</Tabs>

## Build the Project

Apache Ozone uses Maven as its build system. The build process compiles the source code, runs tests, and creates deployable artifacts. The project supports various build configurations to accommodate different development and deployment needs.

### Build Options

The build system offers several options to customize the build process according to your requirements:

#### Basic Build

For a basic build that skips tests:

```bash
mvn clean install -DskipTests=true
```

This command will:

- Clean previous build artifacts
- Compile the source code
- Package the compiled code into JAR files
- Create a distribution in `hadoop-ozone/dist/target/ozone-<version>`

#### Build with Tests

To run unit tests during the build:

```bash
mvn clean install
```

#### Create Distribution Tarball

To create a distribution tarball for deployment:

```bash
mvn clean install -DskipTests=true -Pdist
```

This creates a tarball in `hadoop-ozone/dist/target` that contains all necessary files for deployment.

#### Maven Build Options

Several Maven options are available to customize the build process:

Here's the conversion to a markdown table:

| Command | Description |
|---------|-------------|
| `-DskipTests=true` | Skip all tests |
| `-Dskip.installnpm -Dskip.installnpx -Dskip.installyarn -Dskip.npm -Dskip.npx -Dskip.yarn` | Skip building the Javascript frontend for Recon |
| `-Pdist` | Enable the distribution profile to create deployment tarballs |
| `-T 4` | Use 4 threads for parallel building (adjust number based on your CPU) |
| `-T 2C` | Use 2 threads per core for parallel building (adjust number based on your CPU) |
| `-am -pl module-name` | Build a specific module and its dependencies |
| `-DskipShade` | Skip shading. This saves a ton of time by e.g. skipping the ozone-filesystem-hadoop3 fat jar build |
| `-Dmaven.artifact.threads=30` | Allow maven to download 30 artifacts at once. The default value is 5. This could speed up the build process by a lot when the maven cache was not previously populated. |
| `-Pnative` | Build native module(s). So far it only affects `hdds-rocks-native` |

### Build Output

You can test the result of the compilation process by running a simple Ozone command which will display the Ozone version

```bash
./hadoop-ozone/dist/target/ozone-<version>-SNAPSHOT/bin/ozone version
```

The build process creates several important artifacts:

- **Distribution Tarball**: `hadoop-ozone/dist/target/ozone-<version>.tar.gz` (when using `-Pdist`)
- **Distribution Directory**: `hadoop-ozone/dist/target/ozone-<version>/`
- **Individual Module JARs**: `hadoop-ozone/dist/target/ozone-<version>-SNAPSHOT/share/ozone/lib`

## Next Steps

Run the build by deploying the binary on either a [machine](../../05-administrator-guide/01-installation/03-installing-binaries.md) or on a [Docker cluster](../../08-developer-guide/02-run/02-docker-compose.md)
12 changes: 0 additions & 12 deletions docs/08-developer-guide/01-build/01-prerequisites.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/08-developer-guide/01-build/02-maven.md

This file was deleted.

Loading