[Build] Build ARM64 for deb and rpm

Build ARM64 for deb with the following commands: yarn build --deb-arm --skip-archives yarn build --deb-arm --skip-archives --release Build ARM64 for rpm with the following commands: yarn build --rpm-arm --skip-archives yarn build --rpm-arm --skip-archives --release Issue partially resolved: #1259 Signed-off-by: Kawika Avilla <[email protected]>
opensearch-project · Feb 24, 2022 · 734e527 · 734e527
1 parent 15b561e
commit 734e527
Show file tree

Hide file tree

Showing 6 changed files with 106 additions and 7 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -66,7 +66,7 @@ access it.
 
 ### Building the artifacts
 
-To build the artifacts for all supported platforms,  run the following:
+To build the artifacts for all supported platforms, run the following:
 
 ```
 yarn build --skip-os-packages
@@ -78,7 +78,36 @@ If you want to build a specific platform, pass the platform flag after `yarn bui
 yarn build-platform --darwin
 ```
 
-You could pass one or multiple flags. If you don't pass any flag, `yarn build-platform` will use your local environment. Currenly we only support `darwin` (darwin x64), `linux` (linux x64) and `linux-arm` (linux arm64).  
+You could pass one or multiple flags. If you don't pass any flag, `yarn build-platform` will build an artifact based on your local environment. 
+
+Currently, the supported flags for this script are:
+* `darwin` (builds Darwin x64)
+* `linux` (builds Linux x64)
+* `linux-arm` (builds Linux ARM64).  
+
+If you would like to build only a DEB x64 artifact, run the following:
+
+```
+yarn build --deb --skip-archives
+```
+
+If you would like to build only a DEB ARM64 artifact, run the following:
+
+```
+yarn build --deb-arm --skip-archives
+```
+
+If you would like to build only a RPM x64 artifact, run the following:
+
+```
+yarn build --rpm --skip-archives
+```
+
+If you would like to build only a RPM ARM64 artifact, run the following:
+
+```
+yarn build --rpm-arm --skip-archives
+```
 
 ### Building the Docker Image
 

diff --git a/src/dev/build/args.test.ts b/src/dev/build/args.test.ts
@@ -46,9 +46,11 @@ it('build dist for current platform, without packages, by default', () => {
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -72,9 +74,11 @@ it('build dist for linux x64 platform, without packages, if --linux is passed',
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -98,9 +102,11 @@ it('build dist for linux arm64 platform, without packages, if --linux-arm is pas
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -124,9 +130,11 @@ it('build dist for darwin x64 platform, without packages, if --darwin is passed'
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -150,9 +158,11 @@ it('builds packages if --all-platforms is passed', () => {
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": true,
         "createDebPackage": true,
         "createDockerPackage": true,
         "createDockerUbiPackage": true,
+        "createRpmArmPackage": true,
         "createRpmPackage": true,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -176,9 +186,11 @@ it('limits packages if --rpm passed with --all-platforms', () => {
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": true,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -202,9 +214,11 @@ it('limits packages if --deb passed with --all-platforms', () => {
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": true,
         "createDockerPackage": false,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -229,9 +243,11 @@ it('limits packages if --docker passed with --all-platforms', () => {
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": true,
         "createDockerUbiPackage": true,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,
@@ -256,9 +272,11 @@ it('limits packages if --docker passed with --skip-docker-ubi and --all-platform
     Object {
       "buildOptions": Object {
         "createArchives": true,
+        "createDebArmPackage": false,
         "createDebPackage": false,
         "createDockerPackage": true,
         "createDockerUbiPackage": false,
+        "createRpmArmPackage": false,
         "createRpmPackage": false,
         "downloadFreshNode": true,
         "isRelease": false,

diff --git a/src/dev/build/args.ts b/src/dev/build/args.ts
@@ -37,7 +37,9 @@ export function readCliArgs(argv: string[]) {
       'skip-archives',
       'skip-os-packages',
       'rpm',
+      'rpm-arm',
       'deb',
+      'deb-arm',
       'docker',
       'skip-docker-ubi',
       'release',
@@ -61,7 +63,9 @@ export function readCliArgs(argv: string[]) {
     default: {
       debug: true,
       rpm: null,
+      'rpm-arm': null,
       deb: null,
+      'deb-arm': null,
       docker: null,
       'version-qualifier': '',
     },
@@ -98,7 +102,13 @@ export function readCliArgs(argv: string[]) {
     }
 
     // build all if no flags specified
-    if (flags.rpm === null && flags.deb === null && flags.docker === null) {
+    if (
+      flags.rpm === null &&
+      flags['rpm-arm'] === null &&
+      flags.deb === null &&
+      flags['deb-arm'] === null &&
+      flags.docker === null
+    ) {
       return true;
     }
 
@@ -111,7 +121,9 @@ export function readCliArgs(argv: string[]) {
     downloadFreshNode: !Boolean(flags['skip-node-download']),
     createArchives: !Boolean(flags['skip-archives']),
     createRpmPackage: isOsPackageDesired('rpm'),
+    createRpmArmPackage: isOsPackageDesired('rpm-arm'),
     createDebPackage: isOsPackageDesired('deb'),
+    createDebArmPackage: isOsPackageDesired('deb-arm'),
     createDockerPackage: isOsPackageDesired('docker'),
     createDockerUbiPackage: isOsPackageDesired('docker') && !Boolean(flags['skip-docker-ubi']),
     targetPlatforms: {

diff --git a/src/dev/build/build_distributables.ts b/src/dev/build/build_distributables.ts
@@ -35,7 +35,9 @@ export interface BuildOptions {
   downloadFreshNode: boolean;
   createArchives: boolean;
   createRpmPackage: boolean;
+  createRpmArmPackage: boolean;
   createDebPackage: boolean;
+  createDebArmPackage: boolean;
   createDockerPackage: boolean;
   createDockerUbiPackage: boolean;
   versionQualifier: string | undefined;
@@ -107,10 +109,18 @@ export async function buildDistributables(log: ToolingLog, options: BuildOptions
     // control w/ --deb or --skip-os-packages
     await run(Tasks.CreateDebPackage);
   }
+  if (options.createDebArmPackage) {
+    // control w/ --deb-arm or --skip-os-packages
+    await run(Tasks.CreateDebArmPackage);
+  }
   if (options.createRpmPackage) {
     // control w/ --rpm or --skip-os-packages
     await run(Tasks.CreateRpmPackage);
   }
+  if (options.createRpmArmPackage) {
+    // control w/ --rpm-arm or --skip-os-packages
+    await run(Tasks.CreateRpmArmPackage);
+  }
   if (options.createDockerPackage) {
     // control w/ --docker or --skip-docker-ubi or --skip-os-packages
     await run(Tasks.CreateDockerPackage);

diff --git a/src/dev/build/tasks/os_packages/create_os_package_tasks.ts b/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
@@ -33,7 +33,7 @@ export const CreateDebPackage: Task = {
   description: 'Creating deb package',
 
   async run(config, log, build) {
-    await runFpm(config, log, build, 'deb', [
+    await runFpm(config, log, build, 'deb', 'x64', [
       '--architecture',
       'amd64',
       '--deb-priority',
@@ -42,11 +42,37 @@ export const CreateDebPackage: Task = {
   },
 };
 
+export const CreateDebArmPackage: Task = {
+  description: 'Creating deb-arm package',
+
+  async run(config, log, build) {
+    await runFpm(config, log, build, 'deb', 'arm64', [
+      '--architecture',
+      'arm64',
+      '--deb-priority',
+      'optional',
+    ]);
+  },
+};
+
 export const CreateRpmPackage: Task = {
   description: 'Creating rpm package',
 
   async run(config, log, build) {
-    await runFpm(config, log, build, 'rpm', ['--architecture', 'x64', '--rpm-os', 'linux']);
+    await runFpm(config, log, build, 'rpm', 'x64', ['--architecture', 'x64', '--rpm-os', 'linux']);
+  },
+};
+
+export const CreateRpmArmPackage: Task = {
+  description: 'Creating rpm-arm package',
+
+  async run(config, log, build) {
+    await runFpm(config, log, build, 'rpm', 'arm64', [
+      '--architecture',
+      'arm64',
+      '--rpm-os',
+      'linux',
+    ]);
   },
 };
 

diff --git a/src/dev/build/tasks/os_packages/run_fpm.ts b/src/dev/build/tasks/os_packages/run_fpm.ts
@@ -36,10 +36,14 @@ export async function runFpm(
   log: ToolingLog,
   build: Build,
   type: 'rpm' | 'deb',
+  arch: 'x64' | 'arm64',
   pkgSpecificFlags: string[]
 ) {
-  const linux = config.getPlatform('linux', 'x64');
+  const linux = config.getPlatform('linux', arch);
   const version = config.getBuildVersion();
+  const fileName = config.resolveFromTarget(
+    arch === 'arm64' ? `NAME-${version}-arm64.${type}` : `NAME-${version}-ARCH.TYPE`
+  );
 
   const resolveWithTrailingSlash = (...paths: string[]) => `${resolve(...paths)}/`;
 
@@ -61,7 +65,7 @@ export async function runFpm(
     // the filtered package version, which would have dashes replaced with
     // underscores
     '--package',
-    config.resolveFromTarget(`NAME-${version}-ARCH.TYPE`),
+    fileName,
 
     // input type
     '-s',