HDDS-15026. Introduce DevContainer to improve contributor experience

[henrybear327]

What changes were proposed in this pull request?

With devcontainer, the development environment can be setup quickly, locally and also on Github Codespace, which reduces friction for contributors to onboard.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-15026

How was this patch tested?

• Locally on M-series Mac
• Creating a new Github Codespace

[henrybear327]

cc: @peterxcli @adoroszlai

[adoroszlai]

Thanks @henrybear327 for the patch. Please link to relevant docs that describe devcontainers.

How was this patch tested?

• Locally on M-series Mac
• Creating a new Github Codespace

Can you please provide steps?

[henrybear327]

Thanks @henrybear327 for the patch. Please link to relevant docs that describe devcontainers.

How was this patch tested?

• Locally on M-series Mac
• Creating a new Github Codespace

Can you please provide steps?

Sorry for being too brief on this PR. I will make sure I include more context next time.

---

The official website is https://containers.dev/ - "A development container (or dev container for short) allows you to use a container as a full-featured development environment. It can be used to run an application, to separate tools, libraries, or runtimes needed for working with a codebase, and to aid in continuous integration and testing."

The main benefits are that developers can quickly spin up a Github Codespace and start working on the project, or, locally, a devcontainer, such that all toolchains required for developments are setup already.

It's also used in a lot of Apache projects.

---

Locally, I followed the devcontainer CLI guide here to install and spin up a devcontainer instance.

On github, I created a codespace against this branch, as shown in the following image:

For both environments, as docker-in-docker is enabled, I followed the README and ran cd hadoop-ozone/dist/target/ozone-*/compose/ozone; docker compose up -d --scale datanode=3 to see if I can spin up a cluster.

---

Hope this helps.

[adoroszlai]

Thanks @henrybear327 for the detailed description.

We should also add the new .devcontainer dir to the source tarball like:

ozone/hadoop-ozone/dist/src/main/assemblies/ozone-src.xml

Lines 70 to 76 in ea50306

	<fileSet>
	<directory>.run</directory>
	<includes>
	<include>**/*</include>
	</includes>
	<useDefaultExcludes>true</useDefaultExcludes>
	</fileSet>

[henrybear327]

Thanks @henrybear327 for the detailed description.

We should also add the new .devcontainer dir to the source tarball like:

ozone/hadoop-ozone/dist/src/main/assemblies/ozone-src.xml

Lines 70 to 76 in ea50306

	<fileSet>
	<directory>.run</directory>
	<includes>
	<include>**/*</include>
	</includes>
	<useDefaultExcludes>true</useDefaultExcludes>
	</fileSet>

Done! :) Thanks!

[henrybear327]

Gentle ping @peterxcli @adoroszlai for a final review :)

Thank you!

[adoroszlai]

@henrybear327 LGTM, I'm waiting for @peterxcli to take a look

[peterxcli]

other LGTM! can merge after comment is resolved.

[peterxcli]

Really appreciate and look forward to this change, as I’m a VS Code/Cursor user too.

[henrybear327]

Really appreciate and look forward to this change, as I’m a VS Code/Cursor user too.

Glad it helped :)

Please resolve the comment if you think the reply makes sense! Otherwise, I am happy to keep answering question until we are aligned! :)

[peterxcli]

Thanks for the update! will merge after CI pass

[peterxcli]

Thanks @henrybear327 for the patch, @adoroszlai for the review!

[henrybear327]

Thanks @henrybear327 for the patch, @adoroszlai for the review!

Thanks @peterxcli and @adoroszlai for the review and discussion! :)