iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Moves install sections inside of each component 

Fixes many links
This commit is contained in:
aetter 2021-05-06 19:20:19 -07:00
parent a4d5b11939
commit 4f18fdbd09
35 changed files with 120 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_includes/nav.html
View File

@ -100,7 +100,4 @@
<li class="nav-list-item"> <li class="nav-list-item">
<a href="https://opensearch.org" target="_blank" class="nav-list-link">Javadoc <svg class="external-arrow" width="16" height="16" fill="#002A3A"><use xlink:href="#external-arrow"></use></svg></a> <a href="https://opensearch.org" target="_blank" class="nav-list-link">Javadoc <svg class="external-arrow" width="16" height="16" fill="#002A3A"><use xlink:href="#external-arrow"></use></svg></a>
</li> </li>
<li class="nav-list-item">
<a href="https://opensearch.org" target="_blank" class="nav-list-link">Reference archive <svg class="external-arrow" width="16" height="16" fill="#002A3A"><use xlink:href="#external-arrow"></use></svg></a>
</li>
</ul> </ul>

2
_layouts/default.html
View File

@ -73,7 +73,7 @@ layout: table_wrappers
{% endif %} {% endif %}
</nav> </nav>
<footer class="site-footer"> <footer class="site-footer">
<p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/master/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p> <p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on GitHub.</p>
<p class="text-small text-grey-dk-100 mb-0">© Amazon Web Services, Inc. or its affiliates. All rights reserved.</p> <p class="text-small text-grey-dk-100 mb-0">© Amazon Web Services, Inc. or its affiliates. All rights reserved.</p>
</footer> </footer>
</div> </div>

2
check-links.sh
View File

@ -2,4 +2,4 @@
# Run `bundle exec jekyll serve` first. # Run `bundle exec jekyll serve` first.
# Uses https://github.com/stevenvachon/broken-link-checker # Uses https://github.com/stevenvachon/broken-link-checker
# I have no idea why we have to exclude the ISM section, but that's the only way I can get this to run. - ae # I have no idea why we have to exclude the ISM section, but that's the only way I can get this to run. - ae
blc http://127.0.0.1:4000/docs/ -ro --filter-level 0 --exclude http://127.0.0.1:4000/docs/docs/ism/ --exclude http://localhost:5601/ blc http://127.0.0.1:4000/docs/ -ro --filter-level 0 --exclude http://localhost:5601/

2
docs/alerting/monitors.md
View File

@ -265,7 +265,7 @@ Below are some variables you can include in your message using Mustache template
Variable | Data Type | Description Variable | Data Type | Description
:--- | :--- | :--- :--- | :--- | :---
`ctx.monitor` | JSON | Includes `ctx.monitor.name`, `ctx.monitor.type`, `ctx.monitor.enabled`, `ctx.monitor.enabled_time`, `ctx.monitor.schedule`, `ctx.monitor.inputs`, `triggers` and `ctx.monitor.last_update_time`. `ctx.monitor` | JSON | Includes `ctx.monitor.name`, `ctx.monitor.type`, `ctx.monitor.enabled`, `ctx.monitor.enabled_time`, `ctx.monitor.schedule`, `ctx.monitor.inputs`, `triggers` and `ctx.monitor.last_update_time`.
`ctx.monitor.user` | JSON | Includes information about the user who created the monitor. Includes `ctx.monitor.user.backend_roles` and `ctx.monitor.user.roles`, which are arrays that contain the backend roles and roles assigned to the user. See [alerting security](../security.md/) for more information. `ctx.monitor.user` | JSON | Includes information about the user who created the monitor. Includes `ctx.monitor.user.backend_roles` and `ctx.monitor.user.roles`, which are arrays that contain the backend roles and roles assigned to the user. See [alerting security](../security/) for more information.
`ctx.monitor.enabled` | Boolean | Whether the monitor is enabled. `ctx.monitor.enabled` | Boolean | Whether the monitor is enabled.
`ctx.monitor.enabled_time` | Milliseconds | Unix epoch time of when the monitor was last enabled. `ctx.monitor.enabled_time` | Milliseconds | Unix epoch time of when the monitor was last enabled.
`ctx.monitor.schedule` | JSON | Contains a schedule of how often or when the monitor should run. `ctx.monitor.schedule` | JSON | Contains a schedule of how often or when the monitor should run.

42
docs/opensearch-dashboards/index.md
View File

@ -11,48 +11,6 @@ has_toc: false
OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more. OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.
## Run OpenSearch Dashboards using Docker
You *can* start OpenSearch Dashboards using `docker run` after [creating a Docker network](https://docs.docker.com/engine/reference/commandline/network_create/) and starting OpenSearch, but the process of connecting OpenSearch Dashboards to OpenSearch is significantly easier with a Docker Compose file.
1. Run `docker pull opensearch/opensearch-dashboards:{{site.opensearch_version}}`.
1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page](../install/docker/#sample-docker-compose-file).
Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file.
{: .tip }
1. Run `docker-compose up`.
Wait for the containers to start. Then see [Get started with OpenSearch Dashboards](#get-started-with-opensearch-dashboards).
1. When finished, run `docker-compose down`.
## Run OpenSearch Dashboards using the tarball
1. Download the tarball from the [OpenSearch downloads page](https://opensearch.org/downloads/){:target='\_blank'}.
1. Extract the TAR file to a directory and change to that directory:
```bash
# x64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz
cd opensearch-dashboards
# ARM64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz
cd opensearch-dashboards
```
1. If desired, modify `config/opensearch_dashboards.yml`.
1. Run OpenSearch Dashboards:
```bash
./bin/opensearch-dashboards
```
## Get started with OpenSearch Dashboards ## Get started with OpenSearch Dashboards
1. After starting OpenSearch Dashboards, you can access it at port 5601. For example, http://localhost:5601. 1. After starting OpenSearch Dashboards, you can access it at port 5601. For example, http://localhost:5601.

24
docs/opensearch-dashboards/install/docker.md Normal file
View File

@ -0,0 +1,24 @@
---
layout: default
title: Docker
parent: Install OpenSearch Dashboards
grand_parent: OpenSearch Dashboards
nav_order: 1
---
# Run OpenSearch Dashboards using Docker
You *can* start OpenSearch Dashboards using `docker run` after [creating a Docker network](https://docs.docker.com/engine/reference/commandline/network_create/) and starting OpenSearch, but the process of connecting OpenSearch Dashboards to OpenSearch is significantly easier with a Docker Compose file.
1. Run `docker pull opensearch/opensearch-dashboards:{{site.opensearch_version}}`.
1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page](../opensearch/docker/#sample-docker-compose-file).
Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file.
{: .tip }
1. Run `docker-compose up`.
Wait for the containers to start. Then see the [OpenSearch Dashboards documentation](../../../opensearch-dashboards/).
1. When finished, run `docker-compose down`.

11
docs/opensearch-dashboards/install/index.md Normal file
View File

@ -0,0 +1,11 @@
---
layout: default
title: Install OpenSearch Dashboards
nav_order: 1
parent: OpenSearch Dashboards
has_children: true
---
# Install and configure OpenSearch Dashboards
OpenSearch Dashboards has two installation options at this time: Docker images and tarballs.

7
docs/opensearch-dashboards/plugins.md → docs/opensearch-dashboards/install/plugins.md
View File

@ -1,8 +1,9 @@
--- ---
layout: default layout: default
title: Standalone OpenSearch Dashboards plugin install title: OpenSearch Dashboards plugins
parent: OpenSearch Dashboards parent: Install OpenSearch Dashboards
nav_order: 1 grand_parent: OpenSearch Dashboards
nav_order: 50
--- ---
# Standalone plugin install # Standalone plugin install

32
docs/opensearch-dashboards/install/tar.md Normal file
View File

@ -0,0 +1,32 @@
---
layout: default
title: Tarball
parent: Install OpenSearch Dashboards
grand_parent: OpenSearch Dashboards
nav_order: 30
---
# Run OpenSearch Dashboards using the tarball
1. Download the tarball from the [OpenSearch downloads page](https://opensearch.org/downloads/){:target='\_blank'}.
1. Extract the TAR file to a directory and change to that directory:
```bash
# x64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz
cd opensearch-dashboards
# ARM64
tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz
cd opensearch-dashboards
```
1. If desired, modify `config/opensearch_dashboards.yml`.
1. Run OpenSearch Dashboards:
```bash
./bin/opensearch-dashboards
```
1. See the [OpenSearch Dashboards documentation](../../opensearch-dashboards/).

2
docs/opensearch/bool.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Boolean queries title: Boolean queries
parent: OpenSearch parent: OpenSearch
nav_order: 11 nav_order: 45
--- ---
# Boolean queries # Boolean queries

2
docs/opensearch/catapis.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: CAT API title: CAT API
parent: OpenSearch parent: OpenSearch
nav_order: 7 nav_order: 20
--- ---
# cat API # cat API

2
docs/opensearch/cluster.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Cluster formation title: Cluster formation
parent: OpenSearch parent: OpenSearch
nav_order: 2 nav_order: 7
--- ---
# Cluster formation # Cluster formation

2
docs/opensearch/common-parameters.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Common REST Parameters title: Common REST Parameters
parent: OpenSearch parent: OpenSearch
nav_order: 91 nav_order: 93
--- ---
# Common REST parameters # Common REST parameters

2
docs/opensearch/configuration.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Configuration title: Configuration
parent: OpenSearch parent: OpenSearch
nav_order: 1 nav_order: 5
--- ---
# OpenSearch configuration # OpenSearch configuration

2
docs/opensearch/full-text.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Full-text queries title: Full-text queries
parent: OpenSearch parent: OpenSearch
nav_order: 10 nav_order: 40
--- ---
# Full-text queries # Full-text queries

2
docs/opensearch/index-alias.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Index aliases title: Index aliases
parent: OpenSearch parent: OpenSearch
nav_order: 4 nav_order: 12
--- ---
# Index aliases # Index aliases

2
docs/opensearch/index-data.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Index data title: Index data
parent: OpenSearch parent: OpenSearch
nav_order: 3 nav_order: 10
--- ---
# Index data # Index data

2
docs/opensearch/index-templates.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Index templates title: Index templates
parent: OpenSearch parent: OpenSearch
nav_order: 5 nav_order: 14
--- ---
# Index templates # Index templates

7
docs/install/docker-security.md → docs/opensearch/install/docker-security.md
View File

@ -1,7 +1,8 @@
--- ---
layout: default layout: default
title: Docker security configuration title: Docker security configuration
parent: Install and configure parent: Install OpenSearch
grand_parent: OpenSearch
nav_order: 5 nav_order: 5
--- ---
@ -108,7 +109,7 @@ networks:
opensearch-net: opensearch-net:
``` ```
Then make your changes to `opensearch.yml`. For a full list of settings, see [Security](../../security/configuration/). This example adds (extremely) verbose audit logging: Then make your changes to `opensearch.yml`. For a full list of settings, see [Security](../../../security/configuration/). This example adds (extremely) verbose audit logging:
```yml ```yml
opensearch_security.ssl.transport.pemcert_filepath: node.pem opensearch_security.ssl.transport.pemcert_filepath: node.pem
@ -133,7 +134,7 @@ opensearch_security.audit.config.disabled_rest_categories: NONE
opensearch_security.audit.config.disabled_transport_categories: NONE opensearch_security.audit.config.disabled_transport_categories: NONE
``` ```
Use this same override process to specify new [authentication settings](../../security/configuration/configuration/) in `/usr/share/opensearch/plugins/opensearch-security/securityconfig/config.yml`, as well as new default [internal users, roles, mappings, action groups, and tenants](../../security/configuration/yaml/). Use this same override process to specify new [authentication settings](../../../security/configuration/configuration/) in `/usr/share/opensearch/plugins/opensearch-security/securityconfig/config.yml`, as well as new default [internal users, roles, mappings, action groups, and tenants](../../../security/configuration/yaml/).
To start the cluster, run `docker-compose up`. To start the cluster, run `docker-compose up`.

7
docs/install/docker.md → docs/opensearch/install/docker.md
View File

@ -1,7 +1,8 @@
--- ---
layout: default layout: default
title: Docker title: Docker
parent: Install and configure parent: Install OpenSearch
grand_parent: OpenSearch
nav_order: 1 nav_order: 1
--- ---
@ -184,7 +185,7 @@ services:
- ./custom-opensearch_dashboards.yml:/usr/share/opensearch-dashboards/config/opensearch_dashboards.yml - ./custom-opensearch_dashboards.yml:/usr/share/opensearch-dashboards/config/opensearch_dashboards.yml
``` ```
You can use this same method to [pass your own certificates](../docker-security/) to the containers for use with the [Security](../../security/configuration/) plugin. You can use this same method to [pass your own certificates](../docker-security/) to the containers for use with the [Security](../../../security/configuration/) plugin.
### (Optional) Set up Performance Analyzer ### (Optional) Set up Performance Analyzer
@ -299,7 +300,7 @@ docker build --tag=opensearch-custom-plugin .
docker run -p 9200:9200 -p 9600:9600 -v /usr/share/opensearch/data opensearch-custom-plugin docker run -p 9200:9200 -p 9600:9600 -v /usr/share/opensearch/data opensearch-custom-plugin
``` ```
You can also use a `Dockerfile` to pass your own certificates for use with the [Security](../../security/) plugin, similar to the `-v` argument in [Configure OpenSearch](#configure-opensearch): You can also use a `Dockerfile` to pass your own certificates for use with the [Security](../../../security/) plugin, similar to the `-v` argument in [Configure OpenSearch](#configure-opensearch):
``` ```
FROM opensearch/opensearch:{{site.opensearch_version}} FROM opensearch/opensearch:{{site.opensearch_version}}

3
docs/install/important-settings.md → docs/opensearch/install/important-settings.md
View File

@ -1,7 +1,8 @@
--- ---
layout: default layout: default
title: Important settings title: Important settings
parent: Install and configure parent: Install OpenSearch
grand_parent: OpenSearch
nav_order: 70 nav_order: 70
--- ---

6
docs/install/index.md → docs/opensearch/install/index.md
View File

@ -1,7 +1,9 @@
--- ---
layout: default layout: default
title: Install and configure title: Install OpenSearch
nav_order: 3 nav_order: 1
parent: OpenSearch
redirect_from: /docs/install/
has_children: true has_children: true
--- ---

13
docs/install/plugins.md → docs/opensearch/install/plugins.md
View File

@ -1,7 +1,8 @@
--- ---
layout: default layout: default
title: OpenSearch plugin install title: OpenSearch plugins
parent: Install and configure parent: Install OpenSearch
grand_parent: OpenSearch
nav_order: 90 nav_order: 90
--- ---
@ -72,9 +73,9 @@ Navigate to the OpenSearch home directory (most likely, it is `/usr/share/opense
sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-security/opensearch-security-{{site.opensearch_major_minor_version}}.1.0.zip sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-security/opensearch-security-{{site.opensearch_major_minor_version}}.1.0.zip
``` ```
After installing the security plugin, you can run `sudo sh /usr/share/opensearch/plugins/opensearch-security/tools/install_demo_configuration.sh` to quickly get started with demo certificates. Otherwise, you must configure it manually and run [securityadmin.sh](../../security/configuration/security-admin/). After installing the security plugin, you can run `sudo sh /usr/share/opensearch/plugins/opensearch-security/tools/install_demo_configuration.sh` to quickly get started with demo certificates. Otherwise, you must configure it manually and run [securityadmin.sh](../../../security/configuration/security-admin/).
The security plugin has a corresponding [OpenSearch Dashboards plugin](../../opensearch-dashboards/plugins) that you probably want to install as well. The security plugin has a corresponding [OpenSearch Dashboards plugin](../../../opensearch-dashboards/install/plugins) that you probably want to install as well.
### Job scheduler ### Job scheduler
@ -90,7 +91,7 @@ sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloa
sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-alerting/opensearch-alerting-{{site.opensearch_major_minor_version}}.1.0.zip sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-alerting/opensearch-alerting-{{site.opensearch_major_minor_version}}.1.0.zip
``` ```
To install Alerting, you must first install the Job Scheduler plugin. Alerting has a corresponding [OpenSearch Dashboards plugin](../../opensearch-dashboards/plugins) that you probably want to install as well. To install Alerting, you must first install the Job Scheduler plugin. Alerting has a corresponding [OpenSearch Dashboards plugin](../../../opensearch-dashboards/install/plugins/) that you probably want to install as well.
### SQL ### SQL
@ -113,7 +114,7 @@ sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloa
sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-index-management/opensearch-index-management-{{site.opensearch_major_minor_version}}.2.0.zip sudo bin/opensearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-plugins/opensearch-index-management/opensearch-index-management-{{site.opensearch_major_minor_version}}.2.0.zip
``` ```
To install Index State Management, you must first install the Job Scheduler plugin. ISM has a corresponding [OpenSearch Dashboards plugin](../../opensearch-dashboards/plugins) that you probably want to install as well. To install Index State Management, you must first install the Job Scheduler plugin. ISM has a corresponding [OpenSearch Dashboards plugin](../../../opensearch-dashboards/install/plugins/) that you probably want to install as well.
### k-NN ### k-NN

3
docs/install/tar.md → docs/opensearch/install/tar.md
View File

@ -1,7 +1,8 @@
--- ---
layout: default layout: default
title: Tarball title: Tarball
parent: Install and configure parent: Install OpenSearch
grand_parent: OpenSearch
nav_order: 50 nav_order: 50
--- ---

2
docs/opensearch/logs.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Logs title: Logs
parent: OpenSearch parent: OpenSearch
nav_order: 20 nav_order: 60
--- ---
# Logs # Logs

2
docs/opensearch/popular-api.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Popular APIs title: Popular APIs
parent: OpenSearch parent: OpenSearch
nav_order: 98 nav_order: 96
--- ---
# Popular APIs # Popular APIs

2
docs/opensearch/reindex-data.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Reindex data title: Reindex data
parent: OpenSearch parent: OpenSearch
nav_order: 6 nav_order: 16
--- ---
# Reindex data # Reindex data

2
docs/opensearch/search-template.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Search templates title: Search templates
parent: OpenSearch parent: OpenSearch
nav_order: 11 nav_order: 50
--- ---
# Search templates # Search templates

2
docs/opensearch/snapshot-restore.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Take and restore snapshots title: Take and restore snapshots
parent: OpenSearch parent: OpenSearch
nav_order: 30 nav_order: 65
--- ---
# Take and restore snapshots # Take and restore snapshots

2
docs/opensearch/tasksapis.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Tasks API title: Tasks API
parent: OpenSearch parent: OpenSearch
nav_order: 8 nav_order: 25
has_math: false has_math: false
--- ---

2
docs/opensearch/term.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Term-level queries title: Term-level queries
parent: OpenSearch parent: OpenSearch
nav_order: 9 nav_order: 30
--- ---
# Term-level queries # Term-level queries

2
docs/opensearch/ux.md
View File

@ -2,7 +2,7 @@
layout: default layout: default
title: Search experience title: Search experience
parent: OpenSearch parent: OpenSearch
nav_order: 12 nav_order: 55
--- ---
# Search experience # Search experience

4
docs/security/configuration/disable.md
View File

@ -16,7 +16,7 @@ opensearch_security.disabled: true
A more permanent option is to remove the security plugin entirely. Delete the `plugins/opensearch-security` folder on all nodes, and delete the `opensearch_security` configuration entries from `opensearch.yml`. A more permanent option is to remove the security plugin entirely. Delete the `plugins/opensearch-security` folder on all nodes, and delete the `opensearch_security` configuration entries from `opensearch.yml`.
To perform these steps on the Docker image, see [Customize the Docker image](../../../install/docker/#customize-the-docker-image). To perform these steps on the Docker image, see [Customize the Docker image](../../../opensearch/install/docker/#customize-the-docker-image).
Disabling or removing the plugin exposes the configuration index for the security plugin. If the index contains sensitive information, be sure to protect it through some other means. If you no longer need the index, delete it. Disabling or removing the plugin exposes the configuration index for the security plugin. If the index contains sensitive information, be sure to protect it through some other means. If you no longer need the index, delete it.
{: .warning } {: .warning }
@ -26,7 +26,7 @@ Disabling or removing the plugin exposes the configuration index for the securit
The security plugin is actually two plugins: one for OpenSearch and one for OpenSearch Dashboards. You can use the OpenSearch plugin independently, but the OpenSearch Dashboards plugin depends on a secured OpenSearch cluster. The security plugin is actually two plugins: one for OpenSearch and one for OpenSearch Dashboards. You can use the OpenSearch plugin independently, but the OpenSearch Dashboards plugin depends on a secured OpenSearch cluster.
If you disable the security plugin in `opensearch.yml` (or delete the plugin entirely) and still want to use OpenSearch Dashboards, you must remove the corresponding OpenSearch Dashboards plugin. For more information, see [Standalone OpenSearch Dashboards plugin install](../../../opensearch-dashboards/plugins/). If you disable the security plugin in `opensearch.yml` (or delete the plugin entirely) and still want to use OpenSearch Dashboards, you must remove the corresponding OpenSearch Dashboards plugin. For more information, see [OpenSearch Dashboards plugin install](../../../opensearch-dashboards/install/plugins/).
### Docker ### Docker

2
docs/security/configuration/index.md
View File

@ -11,7 +11,7 @@ has_toc: false
The plugin includes demo certificates so that you can get up and running quickly, but before using OpenSearch in a production environment, you must configure it manually: The plugin includes demo certificates so that you can get up and running quickly, but before using OpenSearch in a production environment, you must configure it manually:
1. [Replace the demo certificates](../../install/docker-security/) 1. [Replace the demo certificates](../../opensearch/install/docker-security/)
1. [Reconfigure opensearch.yml to use your certificates](tls/) 1. [Reconfigure opensearch.yml to use your certificates](tls/)
1. [Reconfigure config.yml to use your authentication backend](configuration/) (if you don't plan to use the internal user database) 1. [Reconfigure config.yml to use your authentication backend](configuration/) (if you don't plan to use the internal user database)
1. [Modify the configuration YAML files](yaml/) 1. [Modify the configuration YAML files](yaml/)

6
index.md
View File

@ -37,7 +37,7 @@ Component | Purpose
[Anomaly Detection](docs/ad/) | Identify atypical data and receive automatic notifications [Anomaly Detection](docs/ad/) | Identify atypical data and receive automatic notifications
[Asynchronous Search](docs/async/) | Run search requests in the background [Asynchronous Search](docs/async/) | Run search requests in the background
You can install OpenSearch plugins [individually](docs/install/plugins/) or use the [all-in-one packages](docs/install/). Most of these OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface. You can install OpenSearch plugins [individually](docs/opensearch/install/plugins/) or use the [all-in-one packages](docs/opensearch/install/). Most of these OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
For specifics around the project, see the [FAQ](https://opensearch.org/faq/). For specifics around the project, see the [FAQ](https://opensearch.org/faq/).
@ -62,7 +62,7 @@ Docker
curl -XGET --insecure https://localhost:9200 -u admin:admin curl -XGET --insecure https://localhost:9200 -u admin:admin
``` ```
To learn more, see [Install](docs/install/). To learn more, see [Install OpenSearch](docs/opensearch/install/).
--- ---
@ -71,4 +71,4 @@ To learn more, see [Install](docs/install/).
[OpenSearch](https://opensearch.org) is supported by Amazon Web Services. All components are available under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) on [GitHub](https://github.com/opensearch-project/). [OpenSearch](https://opensearch.org) is supported by Amazon Web Services. All components are available under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) on [GitHub](https://github.com/opensearch-project/).
The project welcomes GitHub issues, bug fixes, features, plugins, documentation---anything at all. To get involved, see [Contribute](https://opensearch.org/contribute.html) on the OpenSearch website. The project welcomes GitHub issues, bug fixes, features, plugins, documentation---anything at all. To get involved, see [Contributing](https://opensearch.org/source.html) on the OpenSearch website.