Skip to content

Commit

Permalink
Add compatibility page (opensearch-project#7821)
Browse files Browse the repository at this point in the history
* Adding OS matrix changelog and remove CentOS7 as it is approaching EOL

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Add new compatibility page

Signed-off-by: Archer <naarcha@amazon.com>

* Fix links

Signed-off-by: Archer <naarcha@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

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

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

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

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
Signed-off-by: Archer <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Peter Zhu <zhujiaxi@amazon.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Nathan Bower <nbower@amazon.com>
  • Loading branch information
4 people authored and mingshl committed Aug 2, 2024
1 parent e451721 commit d3fd3cd
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 16 deletions.
17 changes: 2 additions & 15 deletions _install-and-configure/install-opensearch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,9 @@ redirect_from:

# Installing OpenSearch

This section details how to install OpenSearch on your host, including which operating systems are [compatible with OpenSearch](#operating-system-compatibility), which [ports to open](#network-requirements), and which [important settings](#important-settings) to configure on your host.
This section provides information about how to install OpenSearch on your host, including which [ports to open](#network-requirements) and which [important settings](#important-settings) to configure on your host.

## Operating system compatibility

OpenSearch and OpenSearch Dashboards are compatible with Red Hat Enterprise Linux (RHEL) and Debian-based Linux distributions that use [`systemd`](https://en.wikipedia.org/wiki/Systemd), such as Amazon Linux, and Ubuntu Long-Term Support (LTS). While OpenSearch and OpenSearch Dashboards should work on most Linux distributions, we only test a subset.

The following table lists the operating system versions that we are currently testing on:

OS | Version
:---------- | :--------
CentOS | 7
Rocky Linux | 8
Alma Linux | 8
Amazon Linux | 2/2023
Ubuntu | 20.04
Windows Server | 2019
For operating system compatibility, see [Compatible operating systems]({{site.url}}{{site.baseurl}}/install-and-configure/os-comp/).


## File system recommendations
Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Generally speaking, installing OpenSearch from the RPM distribution can be broke
1. **Configure OpenSearch for your environment.**
- Apply basic settings to OpenSearch and start using it in your environment.

The RPM distribution provides everything you need to run OpenSearch inside Red Hat or Red Hat–based Linux Distributions. For a list of supported operating systems, see [Operating system compatibility]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/#operating-system-compatibility).
The RPM distribution provides everything you need to run OpenSearch inside Red Hat or Red Hat–based Linux Distributions. For a list of supported operating systems, see [Operating system compatibility]({{site.url}}{{site.baseurl}}/install-and-configure/os-comp/).

This guide assumes that you are comfortable working from the Linux command line interface (CLI). You should understand how to input commands, navigate between directories, and edit text files. Some example commands reference the `vi` text editor, but you may use any text editor available.
{:.note}
Expand Down
32 changes: 32 additions & 0 deletions _install-and-configure/os-comp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
layout: default
title: Compatible operating systems
nav_order: 12
---

OpenSearch and OpenSearch Dashboards are compatible with Red Hat Enterprise Linux (RHEL) and Debian-based Linux distributions that use [`systemd`](https://en.wikipedia.org/wiki/Systemd), such as Amazon Linux, and Ubuntu Long-Term Support (LTS). While OpenSearch and OpenSearch Dashboards should work on most Linux distributions, we only test a subset.

## Supported operating systems

The following table lists the operating system versions that we are currently testing:

OS | Version
:---------- | :--------
Rocky Linux | 8
Alma Linux | 8
Amazon Linux | 2/2023
Ubuntu | 20.04
Windows Server | 2019


## Change log

The following table lists changes made to operating system compatibility.

<div class="table-styler"></div>

| Date | Issue | PR | Details |
|:-----------|:-------|:-------|:--------------------------|
| 2024-07-23 | [opensearch-build Issue 4379](https://github.com/opensearch-project/opensearch-build/issues/4379) | [PR 7821](https://github.com/opensearch-project/documentation-website/pull/7821) | Remove [CentOS7](https://blog.centos.org/2023/04/end-dates-are-coming-for-centos-stream-8-and-centos-linux-7/). |
| 2024-03-08 | [opensearch-build Issue 4573](https://github.com/opensearch-project/opensearch-build/issues/4573) | [PR 6637](https://github.com/opensearch-project/documentation-website/pull/6637) | Remove CentOS8, add Almalinux8/Rockylinux8, and remove Ubuntu 16.04/18.04 because we currently only test on 20.04 |
| 2023-06-06 | [documentation-website Issue 4217](https://github.com/opensearch-project/documentation-website/issues/4217) | [PR 4218](https://github.com/opensearch-project/documentation-website/pull/4218) | Support matrix creation |

0 comments on commit d3fd3cd

Please sign in to comment.