-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,57 @@ | ||
| ## Upgrading Plugins to OpenSearch/OpenSearch Dashboards | ||
| ## Upgrading Plugins to OpenSearch and OpenSearch Dashboards | ||
|
|
||
| These are all the steps to upgrade plugins to work with OpenSearch and OpenSearch Dashboards, including building, and passing all tests. | ||
| These are all the steps to upgrade plugins to work with OpenSearch and OpenSearch Dashboards 1.0.0, including building, and passing all tests. | ||
|
|
||
| ### Upgrading | ||
| We will upgrade the plugins to use OpenSearch/Dashboards 1.0.0. | ||
| ### OpenSearch Plugins | ||
|
|
||
| #### OpenSearch Plugins | ||
| #### Building | ||
|
|
||
| 1. Consume artifacts from OpenSearch by publishing them locally. Please see [Readme](./README.md#building-with-opensearch). | ||
| 1. Consume artifacts from your dependencies, including OpenSearch, see [BUILDING](BUILDING.md). | ||
| 2. Change the namespaces from `org.elasticsearch` to `org.opensearch`. Use the naming convention below. | ||
| 3. Consuming dependencies with OpenSearch/Dashboards 1.0.0. | ||
| * For dependencies `securemock`, `mocksocket` and `jna-build` please continue to use `org.elasticsearch` namespace. | ||
| 4. Build and test your plugin. | ||
| 5. Report all runtime failures of OpenSearch to [OpenSearch Issues](http://github.com/opensearch-project/opensearch/issues) and | ||
| runtime failures of plugins in [OpenSearch plugin Issues](https://github.com/opensearch-project/opensearch-plugins/issues). | ||
| 3. Consume dependencies with OpenSearch/Dashboards 1.0.0. Continue using `org.elasticsearch` dependencies for `securemock`, `mocksocket` and `jna-build`. | ||
| 4. Ensure CI works end-to-end, build and test your plugin. | ||
| 5. Report all runtime failures of OpenSearch to [OpenSearch Issues](http://github.com/opensearch-project/opensearch/issues) and runtime failures of plugins in plugin repositories. | ||
|
|
||
| Here is an example for the changes which were done for OpenSearch plugin. | ||
| https://github.com/opensearch-project/anomaly-detection/pull/1 | ||
| See [anomaly-detection#1](https://github.com/opensearch-project/anomaly-detection/pull/1) for an example. | ||
|
|
||
| ##### Naming Convention | ||
| #### Naming Conventions | ||
|
|
||
| Naming convention followed: | ||
| The following naming convention has been adopted for Elasticsearch. | ||
|
|
||
| * `Elasticsearch` -> `OpenSearch` | ||
| * `elasticsearch` -> `opensearch` | ||
| * `es` -> `opensearch` | ||
| * `Es` -> `OpenSearch` | ||
| * `ES` -> `OpenSearch` | ||
| * `ELASTICSEARCH` -> `OPENSEARCH` | ||
| * Anything with Kibana follow the naming convention below. | ||
| | Before | After | | ||
| |-----------------|--------------| | ||
| | `Elasticsearch` | `OpenSearch` | | ||
| | `elasticsearch` | `opensearch` | | ||
| | `es` | `opensearch` | | ||
| | `Es` | `OpenSearch` | | ||
| | `ES` | `OpenSearch` | | ||
| | `ELASTICSEARCH` | `OPENSEARCH` | | ||
|
|
||
| #### OpenSearch Dashboard plugins | ||
| See below for Kibana-related naming conventions. | ||
|
|
||
| ### OpenSearch Dashboard Plugins | ||
|
|
||
| #### Building | ||
|
|
||
| 1. Change the namespaces from `Kibana` to `OpenSearch-Dashboards`. Use the naming convention below. | ||
| 2. Download and install OpenSearch-Dashboards. Make sure the version specific in `package.json` matches the OpenSearch version. | ||
| 3. Create plugins directory in the root of the project, if plugins directory doesn't exist already. | ||
| 3. Create a `plugins` directory in the root of the project, if it doesn't exist. | ||
| 4. Run `yarn osd bootstrap` inside `opensearch-dashboards/plugins/opensearch-dashboards-plugin`. | ||
| 5. Build and test your plugin. | ||
| 6. Report all runtime failures of OpenSearch to [OpenSearch Dashboards Issues](http://github.com/opensearch-project/opensearch-dashboards/issues) and | ||
| runtime failures of plugins in [OpenSearch plugin Issues](https://github.com/opensearch-project/opensearch-plugins/issues). | ||
|
|
||
|
|
||
| ##### Naming Convention | ||
|
|
||
| * `kibana` -> `opensearchDashboards` | ||
| * `Kibana` -> `OpenSearchDashboards` | ||
| * `KIBANA` -> `OPENSEARCH_DASHBOARDS` | ||
| * `kbn` -> `osd` | ||
| * `Kbn` -> `Osd` | ||
| * `KBN` -> `OSD` | ||
| * `kib` -> `osd` | ||
| * `Kib` -> `Osd` | ||
| * `KIB` -> `OSD` | ||
|
|
||
| Here is an example for the changes which were done for OpenSearch Dashboard plugin. | ||
| https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/pull/1 | ||
| 6. Report all runtime failures of OpenSearch Dashboards to [OpenSearch Dashboards Issues](http://github.com/opensearch-project/opensearch-dashboards/issues) and runtime failures of plugins in plugin repositories. | ||
|
|
||
| #### Naming Conventions | ||
|
|
||
| | Before | After | | ||
| |----------|-------------------------| | ||
| | `kibana` | `opensearchDashboards` | | ||
| | `Kibana` | `OpenSearchDashboards` | | ||
| | `KIBANA` | `OPENSEARCH_DASHBOARDS` | | ||
| | `kbn` | `osd` | | ||
| | `Kbn` | `Osd` | | ||
| | `KBN` | `OSD` | | ||
| | `kib` | `osd` | | ||
| | `Kib` | `Osd` | | ||
| | `KIB` | `OSD` | | ||
|
|
||
| See [anomaly-detection-dashboards-plugin#1](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin/pull/1) for an example. |