Updates the supported operating system section of install guide #4218

hdhalter · 2023-06-01T22:02:46Z

Description

Puts the operating system versions we support in a table for better readability.

Issues Resolved

Resolves #4217

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Heather Halter <[email protected]>

hdhalter · 2023-06-01T22:04:29Z

@peterzhuamazon and @nateynateynate - please review for accuracy. Thanks!

peterzhuamazon

Hi @hdhalter , have some comments, thanks.

_install-and-configure/install-opensearch/index.md

peterzhuamazon · 2023-06-01T22:25:35Z

_install-and-configure/install-opensearch/index.md

-We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, or Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019.
+OpenSearch is compatible with Red Hat Enterprise Linux (RHEL) and Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). While OpenSearch should work on most Linux distributions, we only test a subset. 
+
+The following table lists the operating system versions that we support. 


that we support to that we currently support?

@peterzhuamazon - do you think we should backport this change all the way back to 1.3? Also, do you think I should link from the RPM page to this section/table?

There are a few issues here:

This does not only apply to RPM related OS, but apply to all OS that does not support sha1 key by default, so I think the download page would be a better idea.

The download page yum/apt download link is not correctly link to rpm/deb page.

DEB page is missing in the 1.3 section of documentation website installation pages.

And yes I think we should also backport to 1.3, due to eventually 1.3 and 2.x lines might have either different or same OS compatibilities that we dont know, and such a chart would help for sure.

Thanks, Peter. Updates to the following:

I added a link from the RPM page to the operating system compatibility table

I added redirects to the RPM and Debian pages so the "install" link on the Downloads page takes the user directly to those pages

Fanit is going to fix the issue with the parent link on the 1.3 version so we'll be able to backport easily to 1.3. Once she fixes that, I'll backport all installation files, including Debian. The 'copy' buttons should be appearing, as well.

I'll create an issue to fix the Downloads page:

Add a link to the "Operating System compatibility" chart on the install page

peterzhuamazon · 2023-06-01T22:26:42Z

_install-and-configure/install-opensearch/index.md

@@ -17,7 +17,17 @@ This section details how to install OpenSearch on your host, including which ope

 ## Operating system compatibility

-We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, or Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019.
+OpenSearch is compatible with Red Hat Enterprise Linux (RHEL) and Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). While OpenSearch should work on most Linux distributions, we only test a subset. 


OpenSearch is compatible to OpenSearch/OpenSearch-Dashboards are compatible?

Signed-off-by: Heather Halter <[email protected]>

peterzhuamazon · 2023-06-03T15:29:39Z

Hi @hdhalter please see my reply to your comments.
Thanks.

Signed-off-by: Heather Halter <[email protected]>

kolchfa-aws

LGTM

_install-and-configure/install-opensearch/index.md

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]>

* updatedtable Signed-off-by: Heather Halter <[email protected]> * addeddashboards Signed-off-by: Heather Halter <[email protected]> * addspaces Signed-off-by: Heather Halter <[email protected]> * removespaces Signed-off-by: Heather Halter <[email protected]> * changes to RPM file Signed-off-by: Heather Halter <[email protected]> * addedredirects Signed-off-by: Heather Halter <[email protected]> * fixedlink Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/install-opensearch/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit bfdd426) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

… (#4264) * updatedtable * addeddashboards * addspaces * removespaces * changes to RPM file * addedredirects * fixedlink * Update _install-and-configure/install-opensearch/index.md --------- (cherry picked from commit bfdd426) Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: kolchfa-aws <[email protected]>

… (#4262) * updatedtable * addeddashboards * addspaces * removespaces * changes to RPM file * addedredirects * fixedlink * Update _install-and-configure/install-opensearch/index.md --------- (cherry picked from commit bfdd426) Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: kolchfa-aws <[email protected]>

…search-project#4218) * updatedtable Signed-off-by: Heather Halter <[email protected]> * addeddashboards Signed-off-by: Heather Halter <[email protected]> * addspaces Signed-off-by: Heather Halter <[email protected]> * removespaces Signed-off-by: Heather Halter <[email protected]> * changes to RPM file Signed-off-by: Heather Halter <[email protected]> * addedredirects Signed-off-by: Heather Halter <[email protected]> * fixedlink Signed-off-by: Heather Halter <[email protected]> * Update _install-and-configure/install-opensearch/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>

updatedtable

dbe7c68

Signed-off-by: Heather Halter <[email protected]>

hdhalter requested review from cwillum, kolchfa-aws, Naarcha-AWS, vagimeli, ananzh, seanneumann, AMoo-Miki and natebower as code owners June 1, 2023 22:02

hdhalter changed the title ~~updatedtable~~ Updates the supported operating system section of install guide Jun 1, 2023

hdhalter self-assigned this Jun 1, 2023

hdhalter added the 3 - Tech review PR: Tech review in progress label Jun 1, 2023

peterzhuamazon approved these changes Jun 1, 2023

View reviewed changes

hdhalter added 3 commits June 1, 2023 16:00

addeddashboards

e73cc4a

Signed-off-by: Heather Halter <[email protected]>

addspaces

9146c08

Signed-off-by: Heather Halter <[email protected]>

removespaces

9285565

Signed-off-by: Heather Halter <[email protected]>

hdhalter added 4 - Doc review PR: Doc review in progress backport 2.7 PR: Backport label for 2.7 and removed 3 - Tech review PR: Tech review in progress labels Jun 2, 2023

hdhalter added 3 - Tech review PR: Tech review in progress and removed 4 - Doc review PR: Doc review in progress labels Jun 5, 2023

hdhalter added 3 commits June 5, 2023 16:30

changes to RPM file

61bfc1e

Signed-off-by: Heather Halter <[email protected]>

addedredirects

52194e5

Signed-off-by: Heather Halter <[email protected]>

fixedlink

aaab9fc

Signed-off-by: Heather Halter <[email protected]>

hdhalter added 4 - Doc review PR: Doc review in progress backport 1.3 PR: Backport label for v1.3.x and removed 3 - Tech review PR: Tech review in progress labels Jun 5, 2023

hdhalter mentioned this pull request Jun 6, 2023

Add link to Operating System Compatibility table from Download page opensearch-project/project-website#1656

Open

kolchfa-aws approved these changes Jun 6, 2023

View reviewed changes

_install-and-configure/install-opensearch/index.md Outdated Show resolved Hide resolved

Update _install-and-configure/install-opensearch/index.md

beef9db

Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]>

hdhalter merged commit bfdd426 into main Jun 6, 2023

opensearch-trigger-bot bot mentioned this pull request Jun 6, 2023

[Backport 1.3] Updates the supported operating system section of install guide #4262

Merged

opensearch-trigger-bot bot mentioned this pull request Jun 6, 2023

[Backport 2.7] Updates the supported operating system section of install guide #4263

Closed

hdhalter added backport 2.8 PR: Backport label for 2.8 and removed backport 2.7 PR: Backport label for 2.7 labels Jun 6, 2023

opensearch-trigger-bot bot mentioned this pull request Jun 6, 2023

[Backport 2.8] Updates the supported operating system section of install guide #4264

Merged

hdhalter deleted the opsysrequirements branch March 28, 2024 21:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates the supported operating system section of install guide #4218

Updates the supported operating system section of install guide #4218

hdhalter commented Jun 1, 2023

hdhalter commented Jun 1, 2023

peterzhuamazon left a comment •

edited

Loading

peterzhuamazon Jun 1, 2023

hdhalter Jun 1, 2023 •

edited

Loading

peterzhuamazon Jun 3, 2023

peterzhuamazon Jun 3, 2023 •

edited

Loading

hdhalter Jun 5, 2023

peterzhuamazon Jun 1, 2023

peterzhuamazon commented Jun 3, 2023 •

edited

Loading

kolchfa-aws left a comment

Updates the supported operating system section of install guide #4218

Updates the supported operating system section of install guide #4218

Conversation

hdhalter commented Jun 1, 2023

Description

Issues Resolved

Checklist

hdhalter commented Jun 1, 2023

peterzhuamazon left a comment • edited Loading

Choose a reason for hiding this comment

peterzhuamazon Jun 1, 2023

Choose a reason for hiding this comment

hdhalter Jun 1, 2023 • edited Loading

Choose a reason for hiding this comment

peterzhuamazon Jun 3, 2023

Choose a reason for hiding this comment

peterzhuamazon Jun 3, 2023 • edited Loading

Choose a reason for hiding this comment

hdhalter Jun 5, 2023

Choose a reason for hiding this comment

peterzhuamazon Jun 1, 2023

Choose a reason for hiding this comment

peterzhuamazon commented Jun 3, 2023 • edited Loading

kolchfa-aws left a comment

Choose a reason for hiding this comment

peterzhuamazon left a comment •

edited

Loading

hdhalter Jun 1, 2023 •

edited

Loading

peterzhuamazon Jun 3, 2023 •

edited

Loading

peterzhuamazon commented Jun 3, 2023 •

edited

Loading