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.

  1. After you upgrade your Elasticsearch OSS cluster to OpenSearch, stop Kibana.

  2. For safety, make a backup copy of <kibana-dir>/config/kibana.yml.

  3. Extract the OpenSearch Dashboards tarball to a new directory.

  4. Port your settings from <kibana-dir>/config/kibana.yml to <dashboards-dir>/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.

  5. 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.

  6. Start OpenSearch Dashboards:

    1. ./bin/opensearch-dashboards

  7. Log in, and verify that your saved searches, visualizations, and dashboards are present.