Migrate plugin to be compatible with OpenSearch Dashboards (opensearch-project#1)

Author: ohltyler

.cypress/integration/ad/dashboard/ad_dashboard.spec.ts

@@ -31,16 +31,13 @@ context('AD Dashboard', () => {
     cy.contains('h2', 'You have no detectors');
   });
 
-  it('AD dashboard - single stopped detector', () => {
-    cy.mockGetDetectorOnAction('single_stopped_detector_response.json', () => {
+  it('AD dashboard - single running detector', () => {
+    cy.mockGetDetectorOnAction('single_running_detector_response.json', () => {
       cy.visit(buildAdAppUrl(DASHBOARD));
     });
 
     cy.contains('h3', 'Live anomalies');
-    cy.contains(
-      'p',
-      'All matching detectors are under initialization or stopped for the last 30 minutes. Please adjust filters or come back later.'
-    );
+    cy.contains('a', 'running-detector');
   });
 
   it('AD dashboard - redirect to create detector', () => {

.cypress/support/commands.ts

@@ -50,7 +50,7 @@ Cypress.Commands.add('mockGetDetectorOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(buildAdApiUrl(DETECTORS + '*'), {fixture: fixtureFileName}).as(
+  cy.route2(buildAdApiUrl(DETECTORS + '*'), { fixture: fixtureFileName }).as(
     'getDetectors'
   );
 
@@ -64,7 +64,7 @@ Cypress.Commands.add('mockCreateDetectorOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(buildAdApiUrl(DETECTORS + '*'), {fixture: fixtureFileName}).as(
+  cy.route2(buildAdApiUrl(DETECTORS + '*'), { fixture: fixtureFileName }).as(
     'createDetector'
   );
 
@@ -78,7 +78,7 @@ Cypress.Commands.add('mockSearchIndexOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(buildAdApiUrl(INDICES_PATH + '*'), {fixture: fixtureFileName}).as(
+  cy.route2(buildAdApiUrl(INDICES_PATH + '*'), { fixture: fixtureFileName }).as(
     'getIndices'
   );
 
@@ -92,24 +92,23 @@ Cypress.Commands.add('mockSearchOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(buildAdApiUrl(SEARCH_PATH), {fixture: fixtureFileName}).as(
-    'searchES'
+  cy.route2(buildAdApiUrl(SEARCH_PATH), { fixture: fixtureFileName }).as(
+    'searchOpenSearch'
   );
 
   funcMockedOn();
 
-  cy.wait('@searchES');
+  cy.wait('@searchOpenSearch');
 });
 
 Cypress.Commands.add('mockGetIndexMappingsOnAction', function (
   fixtureFileName: string,
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(
-    buildAdApiUrl(MAPPINGS_PATH + '*'),
-    {fixture: fixtureFileName}
-  ).as('getMappings');
+  cy.route2(buildAdApiUrl(MAPPINGS_PATH + '*'), {
+    fixture: fixtureFileName,
+  }).as('getMappings');
 
   funcMockedOn();
 
@@ -122,10 +121,9 @@ Cypress.Commands.add('mockStartDetectorOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(
-    buildAdApiUrl([DETECTORS, detectorId, START_PATH].join(SLASH)),
-    {fixture: fixtureFileName}
-  ).as('startDetector');
+  cy.route2(buildAdApiUrl([DETECTORS, detectorId, START_PATH].join(SLASH)), {
+    fixture: fixtureFileName,
+  }).as('startDetector');
 
   funcMockedOn();
 
@@ -138,10 +136,9 @@ Cypress.Commands.add('mockStopDetectorOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(
-    buildAdApiUrl([DETECTORS, detectorId, STOP_PATH].join(SLASH)),
-    {fixture: fixtureFileName}
-  ).as('stopDetector');
+  cy.route2(buildAdApiUrl([DETECTORS, detectorId, STOP_PATH].join(SLASH)), {
+    fixture: fixtureFileName,
+  }).as('stopDetector');
 
   funcMockedOn();
 
@@ -154,10 +151,9 @@ Cypress.Commands.add('mockDeleteDetectorOnAction', function (
   funcMockedOn: VoidFunction
 ) {
   cy.server();
-  cy.route2(
-    buildAdApiUrl([DETECTORS, detectorId].join(SLASH)),
-    {fixture: fixtureFileName}
-  ).as('deleteDetector');
+  cy.route2(buildAdApiUrl([DETECTORS, detectorId].join(SLASH)), {
+    fixture: fixtureFileName,
+  }).as('deleteDetector');
 
   funcMockedOn();
 

.cypress/utils/constants.ts

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-export const AD_URL = 'opendistro-anomaly-detection-kibana#';
+export const AD_URL = 'anomaly-detection-dashboards#';
 export const APP_URL_PREFIX = 'app';
 export const API_URL_PREFIX = 'api';
 export const AD_PATH = 'anomaly_detectors';

.eslintrc

@@ -4,4 +4,4 @@ extends: "@elastic/kibana"
 settings:
   import/resolver:
     '@elastic/eslint-import-resolver-kibana':
-      rootPackageName: 'opendistro-anomaly-detection-kibana'
+      rootPackageName: 'anomaly-detection-dashboards'

.github/configurations/docker-compose.yml

@@ -1,46 +1,46 @@
 version: '3'
 services:
-  odfe-node1:
-    image: odfe-ad:test
-    container_name: odfe-node1
+  opensearch-node1:
+    image: opensearch-ad:test
+    container_name: opensearch-node1
     environment:
-      - cluster.name=odfe-cluster
-      - node.name=odfe-node1
-      - discovery.seed_hosts=odfe-node1
-      - cluster.initial_master_nodes=odfe-node1
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-node1
+      - discovery.seed_hosts=opensearch-node1
+      - cluster.initial_master_nodes=opensearch-node1
       - bootstrap.memory_lock=true # along with the memlock settings below, disables swapping
       - 'ES_JAVA_OPTS=-Xms512m -Xmx512m' # minimum and maximum Java heap size, recommend setting both to 50% of system RAM
     ulimits:
       memlock:
         soft: -1
         hard: -1
       nofile:
-        soft: 65536 # maximum number of open files for the Elasticsearch user, set to at least 65536 on modern systems
+        soft: 65536 # maximum number of open files for the OpenSearch user, set to at least 65536 on modern systems
         hard: 65536
     volumes:
-      - odfe-data1:/usr/share/elasticsearch/data
+      - opensearch-data1:/usr/share/opensearch/data
     ports:
       - 9200:9200
       - 9600:9600 # required for Performance Analyzer
     expose:
       - '9200'
     networks:
-      - odfe-net
-  kibana:
-    image: odfe-ad-kibana:test
-    container_name: odfe-kibana
+      - opensearch-net
+  dashboards:
+    image: opensearch-ad-dashboards:test
+    container_name: opensearch-dashboards
     ports:
       - 5601:5601
     expose:
       - '5601'
     environment:
-      ELASTICSEARCH_URL: https://odfe-node1:9200
-      ELASTICSEARCH_HOSTS: https://odfe-node1:9200
+      OPENSEARCH_URL: https://opensearch-node1:9200
+      OPENSEARCH_HOSTS: https://opensearch-node1:9200
     networks:
-      - odfe-net
+      - opensearch-net
 
 volumes:
-  odfe-data1:
+  opensearch-data1:
 
 networks:
-  odfe-net:
+  opensearch-net:

.github/draft-release-notes-config.yml

@@ -1,6 +1,6 @@
 # The overall template of the release notes
 template: |
-  Compatible with Kibana (**set version here**).
+  Compatible with OpenSearch Dashboards (**set version here**).
   $CHANGES
 
 # Setting the formatting and sorting for the release notes body
@@ -12,7 +12,7 @@ replacers:
   - search: '##'
     replace: '###'
 
-# Organizing the tagged PRs into unified ODFE categories
+# Organizing the tagged PRs into unified OpenSearch categories
 categories:
   - title: 'Breaking changes'
     labels:
@@ -39,7 +39,7 @@ categories:
   - title: 'Maintenance'
     labels:
       - 'version upgrade'
-      - 'odfe release'
+      - 'opensearch release'
   - title: 'Refactoring'
     labels:
       - 'refactor'

.github/workflows/CD.yml

@@ -5,7 +5,7 @@ on:
       - v*
 
 env:
-  KIBANA_VERSION: 7.10.2
+  OPENSEARCH_DASHBOARDS_VERSION: 7.10.2
 jobs:
   Build-and-upload:
     name: Build and upload artifacts
@@ -18,50 +18,50 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_STAGING_SECRET_ACCESS_KEY }}
           aws-region: us-east-1
 
-      - name: Checkout Kibana
+      - name: Checkout OpenSearch Dashboards
         uses: actions/checkout@v2
         with:
-          repository: opendistro-for-elasticsearch/kibana-oss
-          ref: ${{ env.KIBANA_VERSION }}
-          token: ${{ secrets.KIBANA_OSS_ACCESS }}
-          path: kibana
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          token: ${{ secrets.OPENSEARCH_DASHBOARDS_OSS_ACCESS }}
+          path: opensearch-dashboards
 
       - name: Get node and yarn versions
         id: versions_step
         run: |
-          echo "::set-output name=node_version::$(node -p "(require('./kibana/package.json').engines.node).match(/[.0-9]+/)[0]")"
-          echo "::set-output name=yarn_version::$(node -p "(require('./kibana/package.json').engines.yarn).match(/[.0-9]+/)[0]")"
+          echo "::set-output name=node_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.node).match(/[.0-9]+/)[0]")"
+          echo "::set-output name=yarn_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")"
 
       - name: Setup node
         uses: actions/setup-node@v1
         with:
           node-version: ${{ steps.versions_step.outputs.node_version }}
           registry-url: 'https://registry.npmjs.org'
 
-      - name: Install correct yarn version for Kibana
+      - name: Install correct yarn version for OpenSearch Dashboards
         run: |
           npm uninstall -g yarn
           echo "Installing yarn ${{ steps.versions_step.outputs.yarn_version }}"
           npm i -g yarn@${{ steps.versions_step.outputs.yarn_version }}
 
-      - name: Checkout Anomaly Detection Kibana plugin
+      - name: Checkout Anomaly Detection OpenSearch Dashboards plugin
         uses: actions/checkout@v2
         with:
-          path: kibana/plugins/anomaly-detection-kibana-plugin
+          path: OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin
 
       - name: Bootstrap the plugin
         run: |
-          cd kibana/plugins/anomaly-detection-kibana-plugin
-          yarn kbn bootstrap
+          cd OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin
+          yarn osd bootstrap
 
       - name: Build the artifact
         run: |
-          cd kibana/plugins/anomaly-detection-kibana-plugin
+          cd OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin
           yarn build
 
       - name: Upload to S3
         run: |
-          cd kibana/plugins/anomaly-detection-kibana-plugin
+          cd OpenSearch-Dashboards/plugins/anomaly-detection-dashboards-plugin
           zip=`ls build/*.zip`
 
           # Inject the build number before the suffix