Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deb/rpm autorestart service after upgrade documentation #6720

Merged
merged 22 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
f0d8b7a
Update deb/rpm autorestart service after upgrade documentation
peterzhuamazon Mar 19, 2024
9fa9d36
Merge remote-tracking branch 'upstream/main' into deb-rpm-2.13
peterzhuamazon Mar 19, 2024
7262bd5
Update _install-and-configure/install-dashboards/debian.md
peterzhuamazon Mar 19, 2024
214b9ad
Update _install-and-configure/install-dashboards/debian.md
peterzhuamazon Mar 19, 2024
a0e5802
Update _install-and-configure/install-dashboards/debian.md
peterzhuamazon Mar 19, 2024
91fe393
Update _install-and-configure/install-dashboards/debian.md
peterzhuamazon Mar 19, 2024
f75f58f
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 19, 2024
b38a6be
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 19, 2024
88e95d3
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 19, 2024
f836e67
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 19, 2024
6750f6b
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 19, 2024
7aa4024
Update _install-and-configure/install-opensearch/debian.md
peterzhuamazon Mar 19, 2024
c011daf
Update _install-and-configure/install-opensearch/rpm.md
peterzhuamazon Mar 19, 2024
6bb56f0
Update _install-and-configure/install-dashboards/debian.md
peterzhuamazon Mar 20, 2024
22301d0
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 20, 2024
2a3457a
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 20, 2024
845a3fb
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 20, 2024
2547e09
Update _install-and-configure/install-dashboards/rpm.md
peterzhuamazon Mar 20, 2024
2d9e075
Update _install-and-configure/install-opensearch/debian.md
peterzhuamazon Mar 20, 2024
5f05c8d
Update _install-and-configure/install-opensearch/rpm.md
peterzhuamazon Mar 20, 2024
966b30f
Update _install-and-configure/install-opensearch/rpm.md
peterzhuamazon Mar 20, 2024
9944ced
Remove link
peterzhuamazon Mar 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions _install-and-configure/install-dashboards/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,40 @@
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`:
```bash
sudo apt-get upgrade opensearch-dashboards
```
{% include copy.html %}

You can also upgrade to a specific OpenSearch Dashboards version:
```bash
sudo apt-get upgrade opensearch-dashboards=<version>
```
{% include copy.html %}

### Auto restart service after package upgrade ([2.13.0 or later](https://github.com/opensearch-project/opensearch-build/pull/4530))

To automatically restart OpenSearch Dashboards after a package upgrade, enable the `opensearch-dashboards.service` through systemd:

Check failure on line 166 in _install-and-configure/install-dashboards/debian.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/install-dashboards/debian.md", "range": {"start": {"line": 166, "column": 124}}}, "severity": "ERROR"}
```bash
sudo systemctl enable opensearch-dashboards.service
```
{% include copy.html %}
36 changes: 35 additions & 1 deletion _install-and-configure/install-dashboards/rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,38 @@ 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 updating with YUM, but you can also upgrade using 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:
```bash
sudo yum update opensearch-dashboards
```
{% include copy.html %}

You can also upgrade to a specific OpenSearch Dashboards version:
```bash
sudo yum update opensearch-dashboards-<version-number>
```
{% include copy.html %}

### Auto restart service after package upgrade

At the moment, OpenSearch Dashboards RPM package does not support automatically restart service after a package upgrade.

10 changes: 9 additions & 1 deletion _install-and-configure/install-opensearch/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@

### 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
Expand All @@ -550,6 +550,14 @@
```
{% include copy.html %}

### Auto restart service after package upgrade ([2.13.0 or later](https://github.com/opensearch-project/opensearch-build/pull/4530))

To automatically restart OpenSearch after a package upgrade, enable the `opensearch.service` through systemd:

Check failure on line 555 in _install-and-configure/install-opensearch/debian.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: systemd. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/install-opensearch/debian.md", "range": {"start": {"line": 555, "column": 102}}}, "severity": "ERROR"}
```bash
sudo systemctl enable opensearch.service
```
{% include copy.html %}

## Related links

- [OpenSearch configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/)
Expand Down
8 changes: 6 additions & 2 deletions _install-and-configure/install-opensearch/rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 %}

Expand All @@ -522,6 +522,10 @@ sudo yum update
```
{% include copy.html %}

### Auto restart service after package upgrade

At the moment, OpenSearch RPM package does not support automatically restart service after a package upgrade.

## Related links

- [OpenSearch configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/)
Expand Down
Loading