Skip to content

Commit

Permalink
Revert "Remove Install and Configure home page (#2449)"
Browse files Browse the repository at this point in the history
This reverts commit 2eba0f2.
  • Loading branch information
vagimeli committed Jan 30, 2023
1 parent 2478ae2 commit 00aaeba
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 16 deletions.
4 changes: 2 additions & 2 deletions _install-and-configure/configuration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
title: Configuring OpenSearch
title: Configuration
nav_order: 10
---

# Configuring OpenSearch
# OpenSearch configuration

Most OpenSearch configuration can take place in the cluster settings API. Certain operations require you to modify `opensearch.yml` and restart the cluster.

Expand Down
39 changes: 39 additions & 0 deletions _install-and-configure/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
title: Install and configure OpenSearch
nav_order: 1
---

# Install and configure OpenSearch

This section details how to install and configure OpenSearch and OpenSearch Dashboards.

## Install OpenSearch

OpenSearch has the following installation options:

- [Docker]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/)
- [Tarball]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/tar/)
- [RPM]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/rpm/)
- [Debian]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/debian/)
- [Ansible]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/ansible/)
- [Helm]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/helm/)
- [Windows]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/windows/)

OpenSearch does not support direct version downgrades. If your environment must be downgraded, we recommend using snapshots to create a restore point, then restoring the snapshot to a cluster built with the target version. To learn more about restore points, see [Restore snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#restore-snapshots).
{: .note }

## Install Dashboards

OpenSearch Dashboards has the following installation options:

- [Docker]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/docker/)
- [Tarball]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/tar/)
- [RPM]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/rpm/)
- [Debian]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/debian/)
- [Helm]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/helm/)
- [Windows]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/windows/)

## Configuration

For an overview of configuration options for OpenSearch, see [Configuration]({{site.url}}{{site.baseurl}}/install-and-configure/configuration/).
6 changes: 3 additions & 3 deletions _install-and-configure/install-dashboards/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
layout: default
title: Installing OpenSearch Dashboards
title: Install OpenSearch Dashboards
nav_order: 3
has_children: true
redirect_from:
- /dashboards/install/
- /dashboards/compatibility/
---

# Installing OpenSearch Dashboards
# Install and configure OpenSearch Dashboards

This section details how to install and configure OpenSearch Dashboards.

Expand Down Expand Up @@ -36,4 +36,4 @@ Other Chromium-based browsers might work, as well. Internet Explorer and Microso

## Configuration

To learn how to configure TLS for OpenSearch Dashboards, see [Configure TLS]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/tls/).
To learn how to configure TLS for OpenSearch Dashboards, see [Configure TLS]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/tls/)
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ APT, the primary package management tool for Debian–based operating systems, a

Before proceeding with any configuration, you should test your installation of OpenSearch. Otherwise, it can be difficult to determine whether future problems are due to installation issues or custom settings you applied after installation.

When OpenSearch is installed using the Debian package, some demo security settings are automatically applied. This includes self-signed TLS certificates and several users and roles. If you would like to configure these yourself, see [Set up OpenSearch in your environment](#step-3-set-up-opensearch-in-your-environment).
When OpenSearch is installed using the Debian package, some demo security settings are automatically applied. This includes self-signed TLS certificates and several users and roles. If you would like to configure these yourself, see [Set up OpenSearch in your environment](#step-4-set-up-opensearch-in-your-environment).

An OpenSearch node in its default configuration (with demo certificates and users with default passwords) is not suitable for a production environment. If you plan to use the node in a production environment, you should, at a minimum, replace the demo TLS certificates with your own TLS certificates and [update the list of internal users and passwords]({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml). See [Security configuration]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/) for additional guidance to ensure that your nodes are configured according to your security requirements.
{: .warning}
Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /opensearch/install/docker/
---

# Docker
# Why use OpenSearch with Docker?

[Docker](https://www.docker.com/) greatly simplifies the process of configuring and managing your OpenSearch clusters. You can pull official images from [Docker Hub](https://hub.docker.com/u/opensearchproject) or [Amazon Elastic Container Registry (Amazon ECR)](https://gallery.ecr.aws/opensearchproject/) and quickly deploy a cluster using [Docker Compose](https://github.com/docker/compose) and any of the sample Docker Compose files included in this guide. Experienced OpenSearch users can further customize their deployment by creating a custom Docker Compose file.

Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /opensearch/install/helm/
---

# Helm
# Run OpenSearch using Helm

Helm is a package manager that allows you to easily install and manage OpenSearch in a Kubernetes cluster. You can define your OpenSearch configurations in a YAML file and use Helm to deploy your applications in a version-controlled and reproducible way.

Expand Down
5 changes: 2 additions & 3 deletions _install-and-configure/install-opensearch/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
layout: default
title: Installing OpenSearch
title: Install OpenSearch
nav_order: 2
has_children: true
redirect_from:
- /opensearch/install/
- /opensearch/install/compatibility/
- /opensearch/install/important-settings/
- /install-and-configure/index/
---

# Installing OpenSearch
# Install 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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
layout: default
title: Installing plugins
title: Plugin installation
nav_order: 90
redirect_from:
- /opensearch/install/plugins/
- /install-and-configure/install-opensearch/plugins/
---

# Installing plugins
# OpenSearch plugin installation

You can install individual plugins for OpenSearch based on your needs. For information about available plugins, see [Available plugins](#available-plugins).

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 @@ -113,7 +113,7 @@ YUM, the primary package management tool for Red Hat–based operating systems,

Before proceeding with any configuration, you should test your installation of OpenSearch. Otherwise, it can be difficult to determine whether future problems are due to installation issues or custom settings you applied after installation.

When OpenSearch is installed using the RPM package, some demo security settings are automatically applied. This includes self-signed TLS certificates and several users and roles. If you would like to configure these yourself, see [Set up OpenSearch in your environment](#step-3-set-up-opensearch-in-your-environment).
When OpenSearch is installed using the RPM package, some demo security settings are automatically applied. This includes self-signed TLS certificates and several users and roles. If you would like to configure these yourself, see [Set up OpenSearch in your environment](#step-4-set-up-opensearch-in-your-environment).

An OpenSearch node in its default configuration (with demo certificates and users with default passwords) is not suitable for a production environment. If you plan to use the node in a production environment, you should, at a minimum, replace the demo TLS certificates with your own TLS certificates and [update the list of internal users and passwords]({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml). See [Security configuration]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/) for additional guidance to ensure that your nodes are configured according to your security requirements.
{: .warning}
Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/install-opensearch/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ parent: Install OpenSearch
nav_order: 65
---

# Windows
# Install OpenSearch on Windows

The following sections describe installing OpenSearch on Windows from a zip archive.

Expand Down

0 comments on commit 00aaeba

Please sign in to comment.