[Backport] [2.x] [distribution/archives] [Linux] [x64] Provide the variant of the distributions bundled with JRE (#8195)

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Introduce new static cluster setting to control slice computation for concurrent segment search. ([#8847](https://github.com/opensearch-project/OpenSearch/pull/8884))
 - Add configuration for file cache size to max remote data ratio to prevent oversubscription of file cache ([#8606](https://github.com/opensearch-project/OpenSearch/pull/8606))
 - Disallow compression level to be set for default and best_compression index codecs ([#8737]()https://github.com/opensearch-project/OpenSearch/pull/8737)
+- [distribution/archives] [Linux] [x64] Provide the variant of the distributions bundled with JRE ([#8195]()https://github.com/opensearch-project/OpenSearch/pull/8195)
 
 ### Dependencies
 - Bump `org.apache.logging.log4j:log4j-core` from 2.17.1 to 2.20.0 ([#8307](https://github.com/opensearch-project/OpenSearch/pull/8307))

DEVELOPER_GUIDE.md

@@ -264,7 +264,10 @@ This repository is split into many top level directories. The most important one
 
 ### `distribution`
 
-Builds our tar and zip archives and our rpm and deb packages.
+Builds our tar and zip archives and our rpm and deb packages. There are several flavors of the distributions, with the classifier included in the name of the final deliverable (archive or package):
+ - default (no classifier), the distribution with bundled JDK
+ - `-no-jdk-` - the distribution without bundled JDK/JRE, assumes the JDK/JRE is going to be pre-installed on the target systems
+ - `-jre-` - the distribution bundled with JRE (smaller footprint), supported as experimental feature for some platforms
 
 ### `libs`
 

buildSrc/src/main/java/org/opensearch/gradle/JavaPackageType.java

@@ -0,0 +1,15 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.gradle;
+
+public enum JavaPackageType {
+ NONE,
+ JRE,
+ JDK
+}

buildSrc/src/main/java/org/opensearch/gradle/JavaVariant.java

@@ -0,0 +1,197 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.gradle;
+
+import org.gradle.api.Buildable;
+import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.model.ObjectFactory;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.TaskDependency;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+abstract class JavaVariant implements Buildable, Iterable<File> {
+
+ private static final List<String> ALLOWED_ARCHITECTURES = Collections.unmodifiableList(
+ Arrays.asList("aarch64", "x64", "s390x", "ppc64le")
+ );
+ private static final List<String> ALLOWED_VENDORS = Collections.unmodifiableList(Arrays.asList("adoptium", "adoptopenjdk", "openjdk"));
+ private static final List<String> ALLOWED_PLATFORMS = Collections.unmodifiableList(
+ Arrays.asList("darwin", "freebsd", "linux", "mac", "windows")
+ );
+ private static final Pattern VERSION_PATTERN = Pattern.compile("(\\d+)(\\.\\d+\\.\\d+)?\\+(\\d+(?:\\.\\d+)?)(@([a-f0-9]{32}))?");
+ private static final Pattern LEGACY_VERSION_PATTERN = Pattern.compile("(\\d)(u\\d+)(?:\\+|\\-)(b\\d+?)(@([a-f0-9]{32}))?");
+
+ private final String name;
+ private final Configuration configuration;
+
+ private final Property<String> vendor;
+ private final Property<String> version;
+ private final Property<String> platform;
+ private final Property<String> architecture;
+ private String baseVersion;
+ private String major;
+ private String build;
+ private String hash;
+
+ JavaVariant(String name, Configuration configuration, ObjectFactory objectFactory) {
+ this.name = name;
+ this.configuration = configuration;
+ this.vendor = objectFactory.property(String.class);
+ this.version = objectFactory.property(String.class);
+ this.platform = objectFactory.property(String.class);
+ this.architecture = objectFactory.property(String.class);
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public String getVendor() {
+ return vendor.get();
+ }
+
+ public void setVendor(final String vendor) {
+ if (ALLOWED_VENDORS.contains(vendor) == false) {
+ throw new IllegalArgumentException("unknown vendor [" + vendor + "] for jdk [" + name + "], must be one of " + ALLOWED_VENDORS);
+ }
+ this.vendor.set(vendor);
+ }
+
+ public String getVersion() {
+ return version.get();
+ }
+
+ public void setVersion(String version) {
+ if (VERSION_PATTERN.matcher(version).matches() == false && LEGACY_VERSION_PATTERN.matcher(version).matches() == false) {
+ throw new IllegalArgumentException("malformed version [" + version + "] for jdk [" + name + "]");
+ }
+ parseVersion(version);
+ this.version.set(version);
+ }
+
+ public String getPlatform() {
+ return platform.get();
+ }
+
+ public void setPlatform(String platform) {
+ if (ALLOWED_PLATFORMS.contains(platform) == false) {
+ throw new IllegalArgumentException(
+ "unknown platform [" + platform + "] for jdk [" + name + "], must be one of " + ALLOWED_PLATFORMS
+ );
+ }
+ this.platform.set(platform);
+ }
+
+ public String getArchitecture() {
+ return architecture.get();
+ }
+
+ public void setArchitecture(final String architecture) {
+ String jdkArchitecture = translateJdkArchitecture(architecture);
+ if (ALLOWED_ARCHITECTURES.contains(jdkArchitecture) == false) {
+ throw new IllegalArgumentException(
+ "unknown architecture [" + jdkArchitecture + "] for jdk [" + name + "], must be one of " + ALLOWED_ARCHITECTURES
+ );
+ }
+ this.architecture.set(jdkArchitecture);
+ }
+
+ public String getBaseVersion() {
+ return baseVersion;
+ }
+
+ public String getMajor() {
+ return major;
+ }
+
+ public String getBuild() {
+ return build;
+ }
+
+ public String getHash() {
+ return hash;
+ }
+
+ public String getPath() {
+ return configuration.getSingleFile().toString();
+ }
+
+ public String getConfigurationName() {
+ return configuration.getName();
+ }
+
+ @Override
+ public String toString() {
+ return getPath();
+ }
+
+ @Override
+ public TaskDependency getBuildDependencies() {
+ return configuration.getBuildDependencies();
+ }
+
+ // internal, make this jdks configuration unmodifiable
+ void finalizeValues() {
+ if (version.isPresent() == false) {
+ throw new IllegalArgumentException("version not specified for jdk [" + name + "]");
+ }
+ if (platform.isPresent() == false) {
+ throw new IllegalArgumentException("platform not specified for jdk [" + name + "]");
+ }
+ if (vendor.isPresent() == false) {
+ throw new IllegalArgumentException("vendor not specified for jdk [" + name + "]");
+ }
+ if (architecture.isPresent() == false) {
+ throw new IllegalArgumentException("architecture not specified for jdk [" + name + "]");
+ }
+ version.finalizeValue();
+ platform.finalizeValue();
+ vendor.finalizeValue();
+ architecture.finalizeValue();
+ }
+
+ @Override
+ public Iterator<File> iterator() {
+ return configuration.iterator();
+ }
+
+ private void parseVersion(String version) {
+ // decompose the bundled jdk version, broken into elements as: [feature, interim, update, build]
+ // Note the "patch" version is not yet handled here, as it has not yet been used by java.
+ Matcher jdkVersionMatcher = VERSION_PATTERN.matcher(version);
+ if (jdkVersionMatcher.matches() == false) {
+ // Try again with the pre-Java9 version format
+ jdkVersionMatcher = LEGACY_VERSION_PATTERN.matcher(version);
+
+ if (jdkVersionMatcher.matches() == false) {
+ throw new IllegalArgumentException("Malformed jdk version [" + version + "]");
+ }
+ }
+
+ baseVersion = jdkVersionMatcher.group(1) + (jdkVersionMatcher.group(2) != null ? (jdkVersionMatcher.group(2)) : "");
+ major = jdkVersionMatcher.group(1);
+ build = jdkVersionMatcher.group(3);
+ hash = jdkVersionMatcher.group(5);
+ }
+
+ private String translateJdkArchitecture(String architecture) {
+ /*
+ * Jdk uses aarch64 from ARM. Translating from arm64 to aarch64 which Jdk understands.
+ */
+ return "arm64".equals(architecture) ? "aarch64" : architecture;
+ }
+
+}