diff --git a/_upgrade-to/dashboards-upgrade-to.md b/_upgrade-to/dashboards-upgrade-to.md new file mode 100644 index 00000000..260d6fd5 --- /dev/null +++ b/_upgrade-to/dashboards-upgrade-to.md @@ -0,0 +1,36 @@ +--- +layout: default +title: Upgrade from Kibana OSS to OpenSearch Dashboards +nav_order: 50 +redirect_from: + - /migrate/dashboards/ +--- + +# Upgrade from Kibana OSS to OpenSearch Dashboards + +Kibana OSS stores its visualizations and dashboards in one or more indices (`.kibana*`) on the Elasticsearch OSS cluster. As such, the most important step is to leave those indices intact as you upgrade from Elasticsearch OSS to OpenSearch. + +Consider exporting all Kibana objects prior to starting the upgrade. In Kibana, choose **Stack Management**, **Saved Objects**, **Export objects**. +{: .tip } + +1. After you upgrade your Elasticsearch OSS cluster to OpenSearch, stop Kibana. + +1. Extract the OpenSearch Dashboards tarball to a new directory. + +1. Port your settings from `/config/kibana.yml` to `/config/opensearch_dashboards.yml`. + + In general, settings with `elasticsearch` in their names map to `opensearch` (e.g. `elasticsearch.shardTimeout` and `opensearch.shardTimeout`) and settings with `kibana` in their names map to `opensearchDashboards` (e.g. `kibana.defaultAppId` and `opensearchDashboards.defaultAppId`). Most other settings use the same names. + + For a full list of OpenSearch Dashboards settings, see [here](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/config/opensearch_dashboards.yml){:target='\_blank'}. + +1. If your OpenSearch cluster uses the security plugin, preserve and modify the default settings in `opensearch_dashboards.yml`, particularly `opensearch.username` and `opensearch.password`. + + If you disabled the security plugin on your OpenSearch cluster, remove or comment out all `opensearch_security` settings. Then run `rm -rf plugins/security-dashboards/` to remove the security plugin. + +1. Start OpenSearch Dashboards: + + ``` + ./bin/opensearch-dashboards + ``` + +1. Log in, and verify that your saved searches, visualizations, and dashboards are present.