diff --git a/_install-and-configure/configuration.md b/_install-and-configure/configuration.md index e768b01e92..3293d9038e 100755 --- a/_install-and-configure/configuration.md +++ b/_install-and-configure/configuration.md @@ -1,10 +1,10 @@ --- layout: default -title: Configuration +title: Configuring OpenSearch nav_order: 10 --- -# OpenSearch configuration +# Configuring OpenSearch Most OpenSearch configuration can take place in the cluster settings API. Certain operations require you to modify `opensearch.yml` and restart the cluster. diff --git a/_install-and-configure/index.md b/_install-and-configure/index.md deleted file mode 100644 index 6fd833be3a..0000000000 --- a/_install-and-configure/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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/). diff --git a/_install-and-configure/install-dashboards/index.md b/_install-and-configure/install-dashboards/index.md index 874bf58ffd..c9cb4469a5 100644 --- a/_install-and-configure/install-dashboards/index.md +++ b/_install-and-configure/install-dashboards/index.md @@ -1,6 +1,6 @@ --- layout: default -title: Install OpenSearch Dashboards +title: Installing OpenSearch Dashboards nav_order: 3 has_children: true redirect_from: @@ -8,7 +8,7 @@ redirect_from: - /dashboards/compatibility/ --- -# Install and configure OpenSearch Dashboards +# Installing OpenSearch Dashboards This section details how to install and configure OpenSearch Dashboards. @@ -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/). diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md index 85ac40b989..d0172bbe6d 100644 --- a/_install-and-configure/install-opensearch/debian.md +++ b/_install-and-configure/install-opensearch/debian.md @@ -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-4-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-3-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} diff --git a/_install-and-configure/install-opensearch/docker.md b/_install-and-configure/install-opensearch/docker.md index 2d85b5fd1d..b7f1e1bf4d 100644 --- a/_install-and-configure/install-opensearch/docker.md +++ b/_install-and-configure/install-opensearch/docker.md @@ -7,7 +7,7 @@ redirect_from: - /opensearch/install/docker/ --- -# Why use OpenSearch with Docker? +# 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. diff --git a/_install-and-configure/install-opensearch/helm.md b/_install-and-configure/install-opensearch/helm.md index 4143c777e6..b15c00628e 100644 --- a/_install-and-configure/install-opensearch/helm.md +++ b/_install-and-configure/install-opensearch/helm.md @@ -7,7 +7,7 @@ redirect_from: - /opensearch/install/helm/ --- -# Run OpenSearch using Helm +# 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. diff --git a/_install-and-configure/install-opensearch/index.md b/_install-and-configure/install-opensearch/index.md index 09dff4bc7f..07f06f334e 100644 --- a/_install-and-configure/install-opensearch/index.md +++ b/_install-and-configure/install-opensearch/index.md @@ -1,15 +1,16 @@ --- layout: default -title: Install OpenSearch +title: Installing OpenSearch nav_order: 2 has_children: true redirect_from: - /opensearch/install/ - /opensearch/install/compatibility/ - /opensearch/install/important-settings/ + - /install-and-configure/index/ --- -# Install OpenSearch +# 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. diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md index 5f9599ce38..0ba2ce3ddc 100644 --- a/_install-and-configure/install-opensearch/rpm.md +++ b/_install-and-configure/install-opensearch/rpm.md @@ -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-4-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-3-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} diff --git a/_install-and-configure/install-opensearch/windows.md b/_install-and-configure/install-opensearch/windows.md index a0734d668f..e92b5b941b 100644 --- a/_install-and-configure/install-opensearch/windows.md +++ b/_install-and-configure/install-opensearch/windows.md @@ -5,7 +5,7 @@ parent: Install OpenSearch nav_order: 65 --- -# Install OpenSearch on Windows +# Windows The following sections describe installing OpenSearch on Windows from a zip archive. diff --git a/_install-and-configure/install-opensearch/plugins.md b/_install-and-configure/plugins.md similarity index 99% rename from _install-and-configure/install-opensearch/plugins.md rename to _install-and-configure/plugins.md index 98b7ee7044..2c715ac99f 100644 --- a/_install-and-configure/install-opensearch/plugins.md +++ b/_install-and-configure/plugins.md @@ -1,12 +1,13 @@ --- layout: default -title: Plugin installation +title: Installing plugins nav_order: 90 redirect_from: - /opensearch/install/plugins/ + - /install-and-configure/install-opensearch/plugins/ --- -# OpenSearch plugin installation +# Installing plugins You can install individual plugins for OpenSearch based on your needs. For information about available plugins, see [Available plugins](#available-plugins).