Skip to content

Commit 5c44724

Browse files
authored
Updates the Install TOC (opensearch-project#3031)
* updates changes to install toc Signed-off-by: Heather Halter <[email protected]> * cleanup files Signed-off-by: Heather Halter <[email protected]> * capital letter Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]>
1 parent 9052c45 commit 5c44724

7 files changed

+34
-33
lines changed

_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ just_the_docs:
9999
# Define the collections used in the theme
100100
collections:
101101
install-and-configure:
102-
name: Install and configure
102+
name: Install and upgrade
103103
nav_fold: true
104104
upgrade-to:
105-
name: Upgrade to OpenSearch
105+
name: Migrate to OpenSearch
106106
# nav_exclude: true
107107
nav_fold: true
108108
# search_exclude: true

_upgrade-to/dashboards-upgrade-to.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
22
layout: default
3-
title: Upgrade from Kibana OSS to OpenSearch Dashboards
3+
title: Migrating from Kibana OSS to OpenSearch Dashboards
44
nav_order: 50
55
---
66

7-
# Upgrade from Kibana OSS to OpenSearch Dashboards
7+
# Migrating from Kibana OSS to OpenSearch Dashboards
88

9-
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.
9+
Kibana OSS stores its visualizations and dashboards in one or more indexes (`.kibana*`) on the Elasticsearch OSS cluster. As such, the most important step is to leave those indexes intact as you migrate from Elasticsearch OSS to OpenSearch.
1010

11-
Consider exporting all Kibana objects prior to starting the upgrade. In Kibana, choose **Stack Management**, **Saved Objects**, **Export objects**.
11+
Consider exporting all Kibana objects prior to starting the migration. In Kibana, choose **Stack Management**, **Saved Objects**, **Export objects**.
1212
{: .tip }
1313

14-
1. After you upgrade your Elasticsearch OSS cluster to OpenSearch, stop Kibana.
14+
1. After you migrate your Elasticsearch OSS cluster to OpenSearch, stop Kibana.
1515

1616
1. For safety, make a backup copy of `<kibana-dir>/config/kibana.yml`.
1717

1818
1. Extract the OpenSearch Dashboards tarball to a new directory.
1919

2020
1. Port your settings from `<kibana-dir>/config/kibana.yml` to `<dashboards-dir>/config/opensearch_dashboards.yml`.
2121

22-
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.
22+
In general, settings with `elasticsearch` in their names map to `opensearch` (for example, `elasticsearch.shardTimeout` and `opensearch.shardTimeout`) and settings with `kibana` in their names map to `opensearchDashboards` (for example, `kibana.defaultAppId` and `opensearchDashboards.defaultAppId`). Most other settings use the same names.
2323

24-
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'}.
24+
For a full list of OpenSearch Dashboards settings, see [opensearch_dashboards.yml](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/config/opensearch_dashboards.yml){:target='\_blank'}.
2525

2626
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`.
2727

_upgrade-to/docker-upgrade-to.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: Upgrade Docker clusters to OpenSearch
3+
title: Migrating Docker clusters to OpenSearch
44
nav_order: 25
55
---
66

7-
# Upgrade Docker clusters to OpenSearch
7+
# Migrating Docker clusters to OpenSearch
88

9-
If you use a container orchestration system like Kubernetes (or manage your containers manually) and want to avoid downtime, think of the process not as an upgrade of each node, but as a decommissioning and replacement of each node. One by one, add OpenSearch nodes to the cluster and remove Elasticsearch OSS nodes, pointing to existing data volumes as necessary and allowing time for all indices to return to a green status prior to proceeding.
9+
If you use a container orchestration system like Kubernetes (or manage your containers manually) and want to avoid downtime, think of the process not as an upgrade of each node, but as a decommissioning and replacement of each node. One by one, add OpenSearch nodes to the cluster and remove Elasticsearch OSS nodes, pointing to existing data volumes as necessary and allowing time for all indexes to return to a green status prior to proceeding.
1010

1111
If you use Docker Compose, we highly recommend that you perform what amounts to a [cluster restart upgrade]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/). Update your cluster configuration with new images, new settings, and new environment variables, and test it. Then stop and start the cluster. This process requires downtime, but takes very few steps and lets you continue to treat the cluster as a single entity that you can reliably deploy and redeploy.
1212

_upgrade-to/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: default
3-
title: About the process
3+
title: About the migration process
44
nav_order: 1
55
redirect_from:
66
- /upgrade-to/
77
---
88

9-
# About the process
9+
# About the migration process
1010

11-
The process of upgrading from Elasticsearch OSS to OpenSearch varies depending on your current version of Elasticsearch OSS, installation type, tolerance for downtime, and cost-sensitivity. Rather than concrete steps to cover every situation, we have general guidance for the process.
11+
The process of migrating from Elasticsearch OSS to OpenSearch varies depending on your current version of Elasticsearch OSS, installation type, tolerance for downtime, and cost-sensitivity. Rather than concrete steps to cover every situation, we have general guidance for the process.
1212

1313
Three approaches exist:
1414

_upgrade-to/snapshot-migrate.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: default
3-
title: Use snapshots to migrate data
3+
title: Using snapshots to migrate data
44
nav_order: 5
55
---
66

7-
# Use snapshots to migrate data
7+
# Using snapshots to migrate data
88

99
One popular approach is to take a [snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore) of your Elasticsearch OSS 6.x or 7.x indexes, [create an OpenSearch cluster]({{site.url}}{{site.baseurl}}/opensearch/install/), restore the snapshot on the new cluster, and point your clients to the new host.
1010

_upgrade-to/upgrade-to.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
---
22
layout: default
3-
title: Upgrade from Elasticsearch OSS to OpenSearch
3+
title: Migrating from Elasticsearch OSS to OpenSearch
44
nav_order: 15
55
---
66

7-
# Upgrade from Elasticsearch OSS to OpenSearch
7+
# Migrating from Elasticsearch OSS to OpenSearch
88

9-
If you want to upgrade from an existing Elasticsearch OSS cluster to OpenSearch and find the [snapshot approach]({{site.url}}{{site.baseurl}}/upgrade-to/snapshot-migrate/) unappealing, you can upgrade your existing nodes from Elasticsearch OSS to OpenSearch.
9+
If you want to migrate from an existing Elasticsearch OSS cluster to OpenSearch and find the [snapshot approach]({{site.url}}{{site.baseurl}}/upgrade-to/snapshot-migrate/) unappealing, you can migrate your existing nodes from Elasticsearch OSS to OpenSearch.
1010

1111
If your existing cluster runs an older version of Elasticsearch OSS, the first step is to upgrade to version 6.x or 7.x. Elasticsearch OSS supports two types of upgrades: rolling and cluster restart.
1212

1313
- Rolling upgrades let you shut down one node at a time for minimal disruption of service.
1414

15-
Rolling upgrades work between minor versions (e.g. 6.5 to 6.8) and also support a single path to the next major version (e.g. 6.8 to 7.10.2). Performing these upgrades might require intermediate upgrades to arrive at your desired version and can affect cluster performance as nodes leave and rejoin, but the cluster remains available throughout the process.
15+
Rolling upgrades work between minor versions (for example, 6.5 to 6.8) and also support a single path to the next major version (for example, 6.8 to 7.10.2). Performing these upgrades might require intermediate upgrades to arrive at your desired version and can affect cluster performance as nodes leave and rejoin, but the cluster remains available throughout the process.
1616

1717
- Cluster restart upgrades require you to shut down all nodes, perform the upgrade, and restart the cluster.
1818

19-
Cluster restart upgrades work between minor versions (e.g. 6.5 to 6.8) and the next major version (for example, 6.x to 7.10.2). Cluster restart upgrades are faster to perform and require fewer intermediate upgrades, but require downtime.
19+
Cluster restart upgrades work between minor versions (for example, 6.5 to 6.8) and the next major version (for example, 6.x to 7.10.2). Cluster restart upgrades are faster to perform and require fewer intermediate upgrades, but require downtime.
2020

2121

22-
## Upgrade paths
22+
## Migration paths
2323

2424
Elasticsearch OSS version | Rolling upgrade path | Cluster restart upgrade path
2525
:--- | :--- | :---
26-
5.x | Upgrade to 5.6, upgrade to 6.8, reindex all 5.x indices, upgrade to 7.10.2, and upgrade to OpenSearch. | Upgrade to 6.8, reindex all 5.x indices, and upgrade to OpenSearch.
27-
6.x | Upgrade to 6.8, upgrade to 7.10.2, and upgrade to OpenSearch. | Upgrade to OpenSearch.
28-
7.x | Upgrade to OpenSearch. | Upgrade to OpenSearch.
26+
5.x | Upgrade to 5.6, upgrade to 6.8, reindex all 5.x indexes, upgrade to 7.10.2, and migrate to OpenSearch. | Upgrade to 6.8, reindex all 5.x indexes, and migrate to OpenSearch.
27+
6.x | Upgrade to 6.8, upgrade to 7.10.2, and migrate to OpenSearch. | Migrate to OpenSearch.
28+
7.x | Migrate to OpenSearch. | Migrate to OpenSearch.
2929

30-
If you are upgrading an Open Distro for Elasticsearch cluster, we recommend first upgrading to ODFE 1.13 and then upgrading to OpenSearch.
30+
If you are migrating an Open Distro for Elasticsearch cluster, we recommend first upgrading to ODFE 1.13 and then migrating to OpenSearch.
3131
{: .note }
3232

3333

@@ -62,7 +62,7 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
6262
sudo yum install elasticsearch-oss-7.10.2 --enablerepo=elasticsearch
6363
```
6464

65-
For tarball installations, extract to a new directory to ensure you **do not overwrite** your `config`, `data`, and `logs` directories. Ideally, these directories should have their own, independent paths and *not* be colocated with the Elasticsearch application directory. Then set the `ES_PATH_CONF` environment variable to the directory that contains `elasticsearch.yml` (e.g. `/etc/elasticesarch/`). In `elasticsearch.yml`, set `path.data` and `path.logs` to your `data` and `logs` directories (e.g. `/var/lib/elasticsearch` and `/var/log/opensearch`).
65+
For tarball installations, extract to a new directory to ensure you **do not overwrite** your `config`, `data`, and `logs` directories. Ideally, these directories should have their own, independent paths and *not* be colocated with the Elasticsearch application directory. Then set the `ES_PATH_CONF` environment variable to the directory that contains `elasticsearch.yml` (for example, `/etc/elasticesarch/`). In `elasticsearch.yml`, set `path.data` and `path.logs` to your `data` and `logs` directories (for example, `/var/lib/elasticsearch` and `/var/log/opensearch`).
6666

6767
1. Restart Elasticsearch OSS on the node (rolling) or all nodes (cluster restart).
6868

@@ -83,7 +83,7 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
8383
curl -XGET 'https://localhost:9200/_nodes/_all?pretty=true' -u 'admin:admin' -k
8484
```
8585

86-
Specifically, check the `nodes.<node-id>.version` portion of the response. Also check `_cat/indices?v` for a green status on all indices.
86+
Specifically, check the `nodes.<node-id>.version` portion of the response. Also check `_cat/indices?v` for a green status on all indexes.
8787

8888
1. (Rolling) Repeat steps 2--5 until all nodes are using the new version.
8989

@@ -98,12 +98,12 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
9898
}
9999
```
100100

101-
1. If you upgraded from 5.x to 6.x, [reindex]({{site.url}}{{site.baseurl}}/opensearch/reindex-data/) all indices.
101+
1. If you upgraded from 5.x to 6.x, [reindex]({{site.url}}{{site.baseurl}}/opensearch/reindex-data/) all indexes.
102102

103103
1. Repeat all steps as necessary until you arrive at your desired Elasticsearch OSS version.
104104

105105

106-
## Upgrade to OpenSearch
106+
## Migrate to OpenSearch
107107

108108
1. Disable shard allocation to prevent Elasticsearch OSS from replicating shards as you shut down nodes:
109109

@@ -132,7 +132,7 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
132132

133133
1. (Optional) Copy or move your Elasticsearch OSS `data` and `logs` directories to new paths. For example, you might move `/var/lib/elasticsearch` to `/var/lib/opensearch`.
134134

135-
1. Set the `OPENSEARCH_PATH_CONF` environment variable to the directory that contains `opensearch.yml` (e.g. `/etc/opensearch`).
135+
1. Set the `OPENSEARCH_PATH_CONF` environment variable to the directory that contains `opensearch.yml` (for example, `/etc/opensearch`).
136136

137137
1. In `opensearch.yml`, set `path.data` and `path.logs`. You might also want to disable the security plugin for now. `opensearch.yml` might look something like this:
138138

@@ -165,7 +165,7 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
165165
curl -XGET -k -u 'admin:admin' 'https://localhost:9200/_nodes/_all?pretty=true'
166166
```
167167

168-
Specifically, check the `nodes.<node-id>.version` portion of the response. Also check `_cat/indices?v` for a green status on all indices.
168+
Specifically, check the `nodes.<node-id>.version` portion of the response. Also check `_cat/indices?v` for a green status on all indexes.
169169

170170
1. (Rolling) Repeat steps 2--5 until all nodes are using OpenSearch.
171171

documentation-website

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 1e274173d0bffb82ddd20549a502e4d76a3cdcc4

0 commit comments

Comments
 (0)