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.

Sign up for GitHub

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

Add compatibility page #7821

Merged
merged 16 commits into from
Jul 30, 2024
Merged

Add compatibility page #7821

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
1215ae4
Adding OS matrix changelog and remove CentOS7 as it is approaching EOL
peterzhuamazon Jun 3, 2024
247adac
Merge branch 'main' into centos7-deprecation
Naarcha-AWS Jun 4, 2024
cb2b4bd
Merge remote-tracking branch 'upstream/main' into centos7-deprecation
peterzhuamazon Jun 5, 2024
bf98d30
Merge branch 'centos7-deprecation' of github.com:peterzhuamazon/docum…
peterzhuamazon Jun 5, 2024
ba7e1a5
Merge remote-tracking branch 'upstream/main' into centos7-deprecation
peterzhuamazon Jul 15, 2024
64e089a
Merge branch 'main' into centos7-deprecation
Naarcha-AWS Jul 18, 2024
1689548
Merge branch 'main' into centos7-deprecation
Naarcha-AWS Jul 23, 2024
0af45a3
Add new compatibility page
Naarcha-AWS Jul 23, 2024
6be2a62
Fix links
Naarcha-AWS Jul 23, 2024
661cd7d
Apply suggestions from code review
Naarcha-AWS Jul 23, 2024
9b79243
Apply suggestions from code review
Naarcha-AWS Jul 25, 2024
9fa4177
Merge branch 'main' into peterzhuamazon-centos7-deprecation
Naarcha-AWS Jul 25, 2024
29b2fb4
Update _install-and-configure/install-opensearch/index.md
Naarcha-AWS Jul 30, 2024
af08613
Apply suggestions from code review
Naarcha-AWS Jul 30, 2024
064c9ac
Update _install-and-configure/install-opensearch/index.md
Naarcha-AWS Jul 30, 2024
0537854
Merge branch 'main' into peterzhuamazon-centos7-deprecation
Naarcha-AWS Jul 30, 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
17 changes: 2 additions & 15 deletions _install-and-configure/install-opensearch/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,9 @@

# 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 details 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.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

## 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 [Compatiable operating systems]({{site.url}}{{site.baseurl}}/install-and-configure/os-comp/)

Check failure on line 18 in _install-and-configure/install-opensearch/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/install-opensearch/index.md#L18 

[OpenSearch.Spelling] Error: Compatiable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output 
{"message": "[OpenSearch.Spelling] Error: Compatiable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/install-opensearch/index.md", "range": {"start": {"line": 18, "column": 42}}}, "severity": "ERROR"}
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved


## File system recommendations
Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/rpm.md
View file
Open in desktop
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/).
peterzhuamazon marked this conversation as resolved.
Show resolved Hide resolved

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
View file
Open in desktop
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 on:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"that we are currently testing on" => "that we are currently testing" or "that we currently support" (to match the heading)

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

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


## Change log

The following table details changes made to operating system compatibility.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

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

| Date | Issue | PR | Details |
|:-----------|:-------|:-------|:--------------------------|
| 2024-06-03 | [opensearch-build Issue 4379](https://github.com/opensearch-project/documentation-website/issues/4379) | [PR 7285](https://github.com/opensearch-project/documentation-website/pull/7285) | Remove CentOS7 as it if approaching [EOL](https://blog.centos.org/2023/04/end-dates-are-coming-for-centos-stream-8-and-centos-linux-7/) |

Check failure on line 30 in _install-and-configure/os-comp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/os-comp.md#L30 

[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
Raw output 
{"message": "[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.", "location": {"path": "_install-and-configure/os-comp.md", "range": {"start": {"line": 30, "column": 3}}}, "severity": "ERROR"}

Check failure on line 30 in _install-and-configure/os-comp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/os-comp.md#L30 

[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
Raw output 
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.", "location": {"path": "_install-and-configure/os-comp.md", "range": {"start": {"line": 30, "column": 17}}}, "severity": "ERROR"}
peterzhuamazon marked this conversation as resolved.
Show resolved Hide resolved
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
| 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, remove Ubuntu 16.04/18.04 as we currently only test on 20.04 |

Check failure on line 31 in _install-and-configure/os-comp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/os-comp.md#L31 

[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
Raw output 
{"message": "[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.", "location": {"path": "_install-and-configure/os-comp.md", "range": {"start": {"line": 31, "column": 3}}}, "severity": "ERROR"}

Check failure on line 31 in _install-and-configure/os-comp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/os-comp.md#L31 

[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
Raw output 
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.", "location": {"path": "_install-and-configure/os-comp.md", "range": {"start": {"line": 31, "column": 17}}}, "severity": "ERROR"}
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
| 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 |

Check failure on line 32 in _install-and-configure/os-comp.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _install-and-configure/os-comp.md#L32 

[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
Raw output 
{"message": "[OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.", "location": {"path": "_install-and-configure/os-comp.md", "range": {"start": {"line": 32, "column": 3}}}, "severity": "ERROR"}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Support matrix creation" (sentence case)?

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Loading