Update deb/rpm autorestart service after upgrade documentation (#6720)

* Update deb/rpm autorestart service after upgrade documentation Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-dashboards/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Remove link Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> --------- Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
opensearch-project · Mar 21, 2024 · 7fe9b1f · 7fe9b1f
1 parent ad013f7
commit 7fe9b1f
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 4 deletions.
diff --git a/_install-and-configure/install-dashboards/debian.md b/_install-and-configure/install-dashboards/debian.md
@@ -131,3 +131,44 @@ By default, OpenSearch Dashboards, like OpenSearch, binds to `localhost` when yo
 1. From a web browser, navigate to OpenSearch Dashboards. The default port is 5601.
 1. Log in with the default username `admin` and the default password `admin`. (For OpenSearch 2.12 and later, the password should be the custom admin password)
 1. Visit [Getting started with OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/index/) to learn more.
+
+
+## Upgrade to a newer version
+
+OpenSearch Dashboards instances installed using `dpkg` or `apt-get` can be easily upgraded to a newer version.
+
+### Manual upgrade with DPKG
+
+Download the Debian package for the desired upgrade version directly from the [OpenSearch Project downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
+
+Navigate to the directory containing the distribution and run the following command:
+
+```bash
+sudo dpkg -i opensearch-dashboards-{{site.opensearch_version}}-linux-x64.deb
+```
+{% include copy.html %}
+
+### APT-GET
+
+To upgrade to the latest version of OpenSearch Dashboards using `apt-get`, run the following command:
+
+```bash
+sudo apt-get upgrade opensearch-dashboards
+```
+{% include copy.html %}
+
+You can also upgrade to a specific OpenSearch Dashboards version by providing the version number:
+
+```bash
+sudo apt-get upgrade opensearch-dashboards=<version>
+```
+{% include copy.html %}
+
+### Automatically restart the service after a package upgrade (2.13.0+)
+
+To automatically restart OpenSearch Dashboards after a package upgrade, enable the `opensearch-dashboards.service` through `systemd`:
+
+```bash
+sudo systemctl enable opensearch-dashboards.service
+```
+{% include copy.html %}
diff --git a/_install-and-configure/install-dashboards/rpm.md b/_install-and-configure/install-dashboards/rpm.md
@@ -89,4 +89,41 @@ YUM, the primary package management tool for Red Hat-based operating systems, al
 1. Once complete, you can run OpenSearch Dashboards.
     ```bash
     sudo systemctl start opensearch-dashboards
-    ```
+    ```
+
+## Upgrade to a newer version
+
+OpenSearch Dashboards instances installed using RPM or YUM can be easily upgraded to a newer version. We recommend using YUM, but you can also choose RPM.
+
+
+### Manual upgrade with RPM
+
+Download the RPM package for the desired upgrade version directly from the [OpenSearch Project downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
+
+Navigate to the directory containing the distribution and run the following command:
+
+```bash
+rpm -Uvh opensearch-dashboards-{{site.opensearch_version}}-linux-x64.rpm
+```
+{% include copy.html %}
+
+### YUM
+
+To upgrade to the latest version of OpenSearch Dashboards using YUM, run the following command:
+
+```bash
+sudo yum update opensearch-dashboards
+```
+{% include copy.html %}
+
+You can also upgrade to a specific OpenSearch Dashboards version by providing the version number:
+
+ ```bash
+ sudo yum update opensearch-dashboards-<version-number>
+ ```
+ {% include copy.html %}
+
+### Automatically restart the service after a package upgrade
+
+The OpenSearch Dashboards RPM package does not currently support automatically restarting the service after a package upgrade.
+
diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md
@@ -528,7 +528,7 @@ OpenSearch instances installed using `dpkg` or `apt-get` can be easily upgraded
 
 ### Manual upgrade with DPKG 
 
-Download the Debian package for the desired upgrade version directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
+Download the Debian package for the desired upgrade version directly from the [OpenSearch Project downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
 
 Navigate to the directory containing the distribution and run the following command:
 ```bash
@@ -550,6 +550,15 @@ sudo apt-get upgrade opensearch=<version>
 ```
 {% include copy.html %}
 
+### Automatically restart the service after a package upgrade (2.13.0+)
+
+To automatically restart OpenSearch after a package upgrade, enable the `opensearch.service` through `systemd`:
+
+```bash
+sudo systemctl enable opensearch.service
+```
+{% include copy.html %}
+
 ## Related links
 
 - [OpenSearch configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/)

diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md
@@ -500,7 +500,7 @@ OpenSearch instances installed using RPM or YUM can be easily upgraded to a newe
 
 ### Manual upgrade with RPM 
 
-Download the RPM package for the desired upgrade version directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
+Download the RPM package for the desired upgrade version directly from the [OpenSearch Project downloads page](https://opensearch.org/downloads.html){:target='\_blank'}.
 
 Navigate to the directory containing the distribution and run the following command:
 ```bash
@@ -512,7 +512,7 @@ rpm -Uvh opensearch-{{site.opensearch_version}}-linux-x64.rpm
 
 To upgrade to the latest version of OpenSearch using YUM:
 ```bash
-sudo yum update
+sudo yum update opensearch
 ```
 {% include copy.html %}
 
@@ -522,6 +522,10 @@ sudo yum update
  ```
  {% include copy.html %}
 
+### Automatically restart the service after a package upgrade
+
+The OpenSearch RPM package does not currently support automatically restarting the service after a package upgrade.
+
 ## Related links
 
 - [OpenSearch configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/)