Skip to content

Commit a09e3f3

Browse files
committed
add basic README for :distribution
this is primarily to document the JDK & No JDK setup (to codify it for the future), however the README can be extended in the future to document more information which is currently hidden away only somewhere in the code. Signed-off-by: Ralph Ursprung <Ralph.Ursprung@avaloq.com>
1 parent 253588b commit a09e3f3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

distribution/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Distributions
2+
This subproject contains the necessary tooling to build the various distributions.
3+
Note that some of this can only be run on the specific architecture and does not support cross-compile.
4+
5+
The following distributions are being built:
6+
* Archives (`*.zip`, `*.tar`): these form the basis for all other OpenSearch distributions
7+
* Packages (`*.deb`, `*.rpm`): specific package formats for some Linux distributions
8+
* Docker images
9+
* Backwards compatibility tests: used internally for version compatibility testing, not for public consumption
10+
11+
## With or Without JDK?
12+
For each supported platform there should be both a target bundled with a JDK and a target without a bundled JDK.

0 commit comments

Comments
 (0)