De-Couple Dashboards linux building process (#795) (#2345) (#2347)

* De-Couple Dashboards linux building process When running yarn build --skip-os-packages it will build 4 tarballs for Dashboards (2x linux, 1x macOS, 1x windows) and takes 10+min to do so. In this PR, we break the building process to allow single linux to build. If run `yarn build-platform --linux-x64` only linux x64 tarball is created. Same for linux arm64 and darwin x64. You could run `yarn build-platform --linux-arm64` and `yarn build-platform darwin-x64`. partially solved: #473 Signed-off-by: Anan Zhuang <[email protected]> * support multiple CLI options and fix comments Signed-off-by: AnanZ <[email protected]> * fix wording to artifacts Signed-off-by: AnanZ <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Anan <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Kawika Avilla <[email protected]> Co-authored-by: Anan <[email protected]> Co-authored-by: Ubuntu <[email protected]>
opensearch-project · Sep 13, 2022 · 319f741 · 319f741
1 parent b7d21f6
commit 319f741
Show file tree

Hide file tree

Showing 17 changed files with 411 additions and 20 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -16,6 +16,79 @@ to all development within the OpenSearch Dashboards project. Please make sure to
 - [Accessibility developer guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/accessibility)
 - [SASS developer guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/sass)
 
+## Getting Started
+
+If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html).
+
+#### Prerequisites
+
+You need to have an OpenSearch server up and running to be able to run OpenSearch
+Dashboards. The easiest way to do it is [using Docker](https://opensearch.org/docs/opensearch/install/docker).
+
+We recommend using [Node Version Manager](https://github.com/nvm-sh/nvm) to install
+the node version we need.
+
+### Bootstrap OpenSearch Dashboards
+
+While OpenSearch is starting, you can already bootstrap OpenSearch Dashboards:
+```bash
+$ git clone https://github.com/opensearch-project/OpenSearch-Dashboards.git
+$ cd OpenSearch-Dashboards
+$ nvm use
+$ npm i -g yarn
+$ yarn osd bootstrap # This command will also install npm dependencies
+```
+
+### Configure OpenSearch Dashboards
+
+*This step is only mandatory if you have https/authentication enabled, or if you use the OpenSearch Docker image in its default configuration.*
+
+Once the bootstrap of OpenSearch Dashboards is finished, you need to apply some
+changes to `opensearch_dashboards.yml` in order to connect to OpenSearch.
+
+```yml
+opensearch.hosts: ["https://localhost:9200"]
+opensearch.username: "admin" # Default username on the docker image
+opensearch.password: "admin" # Default password on the docker image
+opensearch.ssl.verificationMode: none
+```
+
+### Run OpenSearch Dashboards
+
+After you've installed OpenSearch Dashboards and configured it, you can start
+the development server:
+```bash
+$ yarn start
+```
+
+When the server is up and ready, click on the link displayed in your terminal to
+access it.
+
+### Building the artifacts
+
+To build the archives for each platform,  run the following:
+
+```
+yarn build --skip-os-packages
+```
+
+If you want to build a specific platform, pass the platform flag after `yarn build-platform`. For example, to build darwin x64, run the following:
+
+```
+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).  
+
+### Building the Docker Image
+
+To build the Docker image, run the following:
+
+```
+yarn osd bootstrap
+yarn build --docker
+```
+
 ## General
 
 ### Filenames

diff --git a/package.json b/package.json
@@ -50,6 +50,7 @@
     "test:ftr:runner": "node scripts/functional_test_runner",
     "test:coverage": "grunt test:coverage",
     "checkLicenses": "node scripts/check_licenses --dev",
+    "build-platform": "node scripts/build",
     "build": "node scripts/build --all-platforms",
     "start": "node scripts/opensearch_dashboards --dev",
     "debug": "node --nolazy --inspect scripts/opensearch_dashboards --dev",

diff --git a/src/dev/build/args.test.ts b/src/dev/build/args.test.ts
@@ -53,6 +53,89 @@ it('build dist for current platform, without packages, by default', () => {
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": false,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
+        "versionQualifier": "",
+      },
+      "log": <ToolingLog>,
+      "showHelp": false,
+      "unknownFlags": Array [],
+    }
+  `);
+});
+
+it('build dist for linux x64 platform, without packages, if --linux-x64 is passed', () => {
+  expect(readCliArgs(['node', 'scripts/build-platform'])).toMatchInlineSnapshot(`
+    Object {
+      "buildOptions": Object {
+        "createArchives": true,
+        "createDebPackage": false,
+        "createDockerPackage": false,
+        "createDockerUbiPackage": false,
+        "createRpmPackage": false,
+        "downloadFreshNode": true,
+        "isRelease": false,
+        "targetAllPlatforms": false,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
+        "versionQualifier": "",
+      },
+      "log": <ToolingLog>,
+      "showHelp": false,
+      "unknownFlags": Array [],
+    }
+  `);
+});
+
+it('build dist for linux x64 platform, without packages, if --linux-arm64 is passed', () => {
+  expect(readCliArgs(['node', 'scripts/build-platform'])).toMatchInlineSnapshot(`
+    Object {
+      "buildOptions": Object {
+        "createArchives": true,
+        "createDebPackage": false,
+        "createDockerPackage": false,
+        "createDockerUbiPackage": false,
+        "createRpmPackage": false,
+        "downloadFreshNode": true,
+        "isRelease": false,
+        "targetAllPlatforms": false,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
+        "versionQualifier": "",
+      },
+      "log": <ToolingLog>,
+      "showHelp": false,
+      "unknownFlags": Array [],
+    }
+  `);
+});
+
+it('build dist for linux x64 platform, without packages, if --darwin-x64 is passed', () => {
+  expect(readCliArgs(['node', 'scripts/build-platform'])).toMatchInlineSnapshot(`
+    Object {
+      "buildOptions": Object {
+        "createArchives": true,
+        "createDebPackage": false,
+        "createDockerPackage": false,
+        "createDockerUbiPackage": false,
+        "createRpmPackage": false,
+        "downloadFreshNode": true,
+        "isRelease": false,
+        "targetAllPlatforms": false,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,
@@ -74,6 +157,11 @@ it('builds packages if --all-platforms is passed', () => {
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": true,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,
@@ -95,6 +183,11 @@ it('limits packages if --rpm passed with --all-platforms', () => {
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": true,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,
@@ -116,6 +209,11 @@ it('limits packages if --deb passed with --all-platforms', () => {
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": true,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,
@@ -138,6 +236,11 @@ it('limits packages if --docker passed with --all-platforms', () => {
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": true,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,
@@ -160,6 +263,11 @@ it('limits packages if --docker passed with --skip-docker-ubi and --all-platform
         "downloadFreshNode": true,
         "isRelease": false,
         "targetAllPlatforms": true,
+        "targetPlatforms": Object {
+          "darwin": false,
+          "linux": false,
+          "linuxArm": false,
+        },
         "versionQualifier": "",
       },
       "log": <ToolingLog>,

diff --git a/src/dev/build/args.ts b/src/dev/build/args.ts
@@ -45,6 +45,9 @@ export function readCliArgs(argv: string[]) {
       'verbose',
       'debug',
       'all-platforms',
+      'darwin',
+      'linux',
+      'linux-arm',
       'verbose',
       'quiet',
       'silent',
@@ -111,6 +114,11 @@ export function readCliArgs(argv: string[]) {
     createDebPackage: isOsPackageDesired('deb'),
     createDockerPackage: isOsPackageDesired('docker'),
     createDockerUbiPackage: isOsPackageDesired('docker') && !Boolean(flags['skip-docker-ubi']),
+    targetPlatforms: {
+      darwin: Boolean(flags.darwin),
+      linux: Boolean(flags.linux),
+      linuxArm: Boolean(flags['linux-arm']),
+    },
     targetAllPlatforms: Boolean(flags['all-platforms']),
   };
 

diff --git a/src/dev/build/build_distributables.ts b/src/dev/build/build_distributables.ts
@@ -27,7 +27,7 @@
 
 import { ToolingLog } from '@osd/dev-utils';
 
-import { Config, createRunner } from './lib';
+import { Config, createRunner, TargetPlatforms } from './lib';
 import * as Tasks from './tasks';
 
 export interface BuildOptions {
@@ -40,6 +40,7 @@ export interface BuildOptions {
   createDockerUbiPackage: boolean;
   versionQualifier: string | undefined;
   targetAllPlatforms: boolean;
+  targetPlatforms: TargetPlatforms;
 }
 
 export async function buildDistributables(log: ToolingLog, options: BuildOptions) {

diff --git a/src/dev/build/cli.ts b/src/dev/build/cli.ts
@@ -55,6 +55,9 @@ if (showHelp) {
         --skip-archives         {dim Don't produce tar/zip archives}
         --skip-os-packages      {dim Don't produce rpm/deb/docker packages}
         --all-platforms         {dim Produce archives for all platforms, not just this one}
+        --linux-x64             {dim Produce archives for only linux x64 platform}
+        --linux-arm64           {dim Produce archives for only linux arm64 platform}
+        --darwin-x64            {dim Produce archives for only darwin x64 platform}
         --rpm                   {dim Only build the rpm package}
         --deb                   {dim Only build the deb package}
         --docker                {dim Only build the docker image}

diff --git a/src/dev/build/lib/build.test.ts b/src/dev/build/lib/build.test.ts
@@ -36,7 +36,12 @@ expect.addSnapshotSerializer(createAbsolutePathSerializer());
 const config = new Config(
   true,
   {
-    version: '8.0.0',
+    darwin: false,
+    linux: false,
+    linuxArm: false,
+  },
+  {
+    version: '1.0.0',
     engines: {
       node: '*',
     },
@@ -49,7 +54,7 @@ const config = new Config(
   {
     buildNumber: 1234,
     buildSha: 'abcd1234',
-    buildVersion: '8.0.0',
+    buildVersion: '1.0.0',
   },
   true
 );
@@ -93,21 +98,21 @@ describe('#resolvePath()', () => {
 describe('#resolvePathForPlatform()', () => {
   it('uses config.resolveFromRepo(), config.getBuildVersion(), and platform.getBuildName() to create path', () => {
     expect(build.resolvePathForPlatform(linuxPlatform, 'foo', 'bar')).toMatchInlineSnapshot(
-      `<absolute path>/build/opensearch-dashboards-8.0.0-linux-x64/foo/bar`
+      `<absolute path>/build/opensearch-dashboards-1.0.0-linux-x64/foo/bar`
     );
   });
 });
 
 describe('#getPlatformArchivePath()', () => {
   it('creates correct path for different platforms', () => {
     expect(build.getPlatformArchivePath(linuxPlatform)).toMatchInlineSnapshot(
-      `<absolute path>/target/opensearch-dashboards-8.0.0-linux-x64.tar.gz`
+      `<absolute path>/target/opensearch-dashboards-1.0.0-linux-x64.tar.gz`
     );
     expect(build.getPlatformArchivePath(linuxArmPlatform)).toMatchInlineSnapshot(
-      `<absolute path>/target/opensearch-dashboards-8.0.0-linux-arm64.tar.gz`
+      `<absolute path>/target/opensearch-dashboards-1.0.0-linux-arm64.tar.gz`
     );
     expect(build.getPlatformArchivePath(windowsPlatform)).toMatchInlineSnapshot(
-      `<absolute path>/target/opensearch-dashboards-8.0.0-windows-x64.zip`
+      `<absolute path>/target/opensearch-dashboards-1.0.0-windows-x64.zip`
     );
   });
 });