diff --git a/_includes/nav.html b/_includes/nav.html index 555d6a5b..959a9fa3 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -100,7 +100,4 @@
  • Javadoc
    • -
  • - Reference archive -
    • diff --git a/_layouts/default.html b/_layouts/default.html index b1c1ff0a..525a5090 100755 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -73,7 +73,7 @@ layout: table_wrappers {% endif %} diff --git a/check-links.sh b/check-links.sh index deff68cb..b804ad21 100644 --- a/check-links.sh +++ b/check-links.sh @@ -2,4 +2,4 @@ # Run `bundle exec jekyll serve` first. # 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 -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/ diff --git a/docs/alerting/monitors.md b/docs/alerting/monitors.md index 9f1e029e..101ae7df 100644 --- a/docs/alerting/monitors.md +++ b/docs/alerting/monitors.md @@ -265,7 +265,7 @@ Below are some variables you can include in your message using Mustache template 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.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_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. diff --git a/docs/opensearch-dashboards/index.md b/docs/opensearch-dashboards/index.md index 3f5d2e7e..03d5fe19 100644 --- a/docs/opensearch-dashboards/index.md +++ b/docs/opensearch-dashboards/index.md @@ -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. -## 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 1. After starting OpenSearch Dashboards, you can access it at port 5601. For example, http://localhost:5601. diff --git a/docs/opensearch-dashboards/install/docker.md b/docs/opensearch-dashboards/install/docker.md new file mode 100644 index 00000000..4ce53d03 --- /dev/null +++ b/docs/opensearch-dashboards/install/docker.md @@ -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`. diff --git a/docs/opensearch-dashboards/install/index.md b/docs/opensearch-dashboards/install/index.md new file mode 100644 index 00000000..e7647844 --- /dev/null +++ b/docs/opensearch-dashboards/install/index.md @@ -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. diff --git a/docs/opensearch-dashboards/plugins.md b/docs/opensearch-dashboards/install/plugins.md similarity index 98% rename from docs/opensearch-dashboards/plugins.md rename to docs/opensearch-dashboards/install/plugins.md index 12633794..5b13bdc0 100644 --- a/docs/opensearch-dashboards/plugins.md +++ b/docs/opensearch-dashboards/install/plugins.md @@ -1,8 +1,9 @@ --- layout: default -title: Standalone OpenSearch Dashboards plugin install -parent: OpenSearch Dashboards -nav_order: 1 +title: OpenSearch Dashboards plugins +parent: Install OpenSearch Dashboards +grand_parent: OpenSearch Dashboards +nav_order: 50 --- # Standalone plugin install diff --git a/docs/opensearch-dashboards/install/tar.md b/docs/opensearch-dashboards/install/tar.md new file mode 100644 index 00000000..b54d5e24 --- /dev/null +++ b/docs/opensearch-dashboards/install/tar.md @@ -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/). diff --git a/docs/opensearch/bool.md b/docs/opensearch/bool.md index 6b53e4ba..7dae7eda 100644 --- a/docs/opensearch/bool.md +++ b/docs/opensearch/bool.md @@ -2,7 +2,7 @@ layout: default title: Boolean queries parent: OpenSearch -nav_order: 11 +nav_order: 45 --- # Boolean queries diff --git a/docs/opensearch/catapis.md b/docs/opensearch/catapis.md index b28cd9d6..162e131f 100644 --- a/docs/opensearch/catapis.md +++ b/docs/opensearch/catapis.md @@ -2,7 +2,7 @@ layout: default title: CAT API parent: OpenSearch -nav_order: 7 +nav_order: 20 --- # cat API diff --git a/docs/opensearch/cluster.md b/docs/opensearch/cluster.md index 11ed002c..eb0a7968 100644 --- a/docs/opensearch/cluster.md +++ b/docs/opensearch/cluster.md @@ -2,7 +2,7 @@ layout: default title: Cluster formation parent: OpenSearch -nav_order: 2 +nav_order: 7 --- # Cluster formation diff --git a/docs/opensearch/common-parameters.md b/docs/opensearch/common-parameters.md index f1e678a4..66b18275 100644 --- a/docs/opensearch/common-parameters.md +++ b/docs/opensearch/common-parameters.md @@ -2,7 +2,7 @@ layout: default title: Common REST Parameters parent: OpenSearch -nav_order: 91 +nav_order: 93 --- # Common REST parameters diff --git a/docs/opensearch/configuration.md b/docs/opensearch/configuration.md index 48acb312..59668167 100755 --- a/docs/opensearch/configuration.md +++ b/docs/opensearch/configuration.md @@ -2,7 +2,7 @@ layout: default title: Configuration parent: OpenSearch -nav_order: 1 +nav_order: 5 --- # OpenSearch configuration diff --git a/docs/opensearch/full-text.md b/docs/opensearch/full-text.md index 32cbbf22..c1e95f11 100644 --- a/docs/opensearch/full-text.md +++ b/docs/opensearch/full-text.md @@ -2,7 +2,7 @@ layout: default title: Full-text queries parent: OpenSearch -nav_order: 10 +nav_order: 40 --- # Full-text queries diff --git a/docs/opensearch/index-alias.md b/docs/opensearch/index-alias.md index 8f2734db..4f277a8b 100644 --- a/docs/opensearch/index-alias.md +++ b/docs/opensearch/index-alias.md @@ -2,7 +2,7 @@ layout: default title: Index aliases parent: OpenSearch -nav_order: 4 +nav_order: 12 --- # Index aliases diff --git a/docs/opensearch/index-data.md b/docs/opensearch/index-data.md index 6dd5af2d..98185cdc 100644 --- a/docs/opensearch/index-data.md +++ b/docs/opensearch/index-data.md @@ -2,7 +2,7 @@ layout: default title: Index data parent: OpenSearch -nav_order: 3 +nav_order: 10 --- # Index data diff --git a/docs/opensearch/index-templates.md b/docs/opensearch/index-templates.md index 5bdbdc0f..1daab677 100644 --- a/docs/opensearch/index-templates.md +++ b/docs/opensearch/index-templates.md @@ -2,7 +2,7 @@ layout: default title: Index templates parent: OpenSearch -nav_order: 5 +nav_order: 14 --- # Index templates diff --git a/docs/install/docker-security.md b/docs/opensearch/install/docker-security.md similarity index 93% rename from docs/install/docker-security.md rename to docs/opensearch/install/docker-security.md index 3a0d1c66..c730b61a 100644 --- a/docs/install/docker-security.md +++ b/docs/opensearch/install/docker-security.md @@ -1,7 +1,8 @@ --- layout: default title: Docker security configuration -parent: Install and configure +parent: Install OpenSearch +grand_parent: OpenSearch nav_order: 5 --- @@ -108,7 +109,7 @@ networks: 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 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 ``` -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`. diff --git a/docs/install/docker.md b/docs/opensearch/install/docker.md similarity index 97% rename from docs/install/docker.md rename to docs/opensearch/install/docker.md index 82e700d8..3017745e 100644 --- a/docs/install/docker.md +++ b/docs/opensearch/install/docker.md @@ -1,7 +1,8 @@ --- layout: default title: Docker -parent: Install and configure +parent: Install OpenSearch +grand_parent: OpenSearch nav_order: 1 --- @@ -184,7 +185,7 @@ services: - ./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 @@ -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 ``` -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}} diff --git a/docs/install/important-settings.md b/docs/opensearch/install/important-settings.md similarity index 95% rename from docs/install/important-settings.md rename to docs/opensearch/install/important-settings.md index bde9bf6e..0e666b21 100644 --- a/docs/install/important-settings.md +++ b/docs/opensearch/install/important-settings.md @@ -1,7 +1,8 @@ --- layout: default title: Important settings -parent: Install and configure +parent: Install OpenSearch +grand_parent: OpenSearch nav_order: 70 --- diff --git a/docs/install/index.md b/docs/opensearch/install/index.md similarity index 64% rename from docs/install/index.md rename to docs/opensearch/install/index.md index 93bc8196..37a99313 100644 --- a/docs/install/index.md +++ b/docs/opensearch/install/index.md @@ -1,7 +1,9 @@ --- layout: default -title: Install and configure -nav_order: 3 +title: Install OpenSearch +nav_order: 1 +parent: OpenSearch +redirect_from: /docs/install/ has_children: true --- diff --git a/docs/install/plugins.md b/docs/opensearch/install/plugins.md similarity index 94% rename from docs/install/plugins.md rename to docs/opensearch/install/plugins.md index 11a175be..747c0df5 100644 --- a/docs/install/plugins.md +++ b/docs/opensearch/install/plugins.md @@ -1,7 +1,8 @@ --- layout: default -title: OpenSearch plugin install -parent: Install and configure +title: OpenSearch plugins +parent: Install OpenSearch +grand_parent: OpenSearch 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 ``` -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 @@ -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 ``` -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 @@ -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 ``` -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 diff --git a/docs/install/tar.md b/docs/opensearch/install/tar.md similarity index 99% rename from docs/install/tar.md rename to docs/opensearch/install/tar.md index fca67210..52b00fd3 100644 --- a/docs/install/tar.md +++ b/docs/opensearch/install/tar.md @@ -1,7 +1,8 @@ --- layout: default title: Tarball -parent: Install and configure +parent: Install OpenSearch +grand_parent: OpenSearch nav_order: 50 --- diff --git a/docs/opensearch/logs.md b/docs/opensearch/logs.md index 232f1de6..dc8ccd38 100644 --- a/docs/opensearch/logs.md +++ b/docs/opensearch/logs.md @@ -2,7 +2,7 @@ layout: default title: Logs parent: OpenSearch -nav_order: 20 +nav_order: 60 --- # Logs diff --git a/docs/opensearch/popular-api.md b/docs/opensearch/popular-api.md index 6db1cb5d..41fc6513 100644 --- a/docs/opensearch/popular-api.md +++ b/docs/opensearch/popular-api.md @@ -2,7 +2,7 @@ layout: default title: Popular APIs parent: OpenSearch -nav_order: 98 +nav_order: 96 --- # Popular APIs diff --git a/docs/opensearch/reindex-data.md b/docs/opensearch/reindex-data.md index 61ca6105..874a0899 100644 --- a/docs/opensearch/reindex-data.md +++ b/docs/opensearch/reindex-data.md @@ -2,7 +2,7 @@ layout: default title: Reindex data parent: OpenSearch -nav_order: 6 +nav_order: 16 --- # Reindex data diff --git a/docs/opensearch/search-template.md b/docs/opensearch/search-template.md index 7936651a..b5b0a23c 100644 --- a/docs/opensearch/search-template.md +++ b/docs/opensearch/search-template.md @@ -2,7 +2,7 @@ layout: default title: Search templates parent: OpenSearch -nav_order: 11 +nav_order: 50 --- # Search templates diff --git a/docs/opensearch/snapshot-restore.md b/docs/opensearch/snapshot-restore.md index a1efc03a..e1f5320f 100644 --- a/docs/opensearch/snapshot-restore.md +++ b/docs/opensearch/snapshot-restore.md @@ -2,7 +2,7 @@ layout: default title: Take and restore snapshots parent: OpenSearch -nav_order: 30 +nav_order: 65 --- # Take and restore snapshots diff --git a/docs/opensearch/tasksapis.md b/docs/opensearch/tasksapis.md index c3f5b5da..adeabcc2 100644 --- a/docs/opensearch/tasksapis.md +++ b/docs/opensearch/tasksapis.md @@ -2,7 +2,7 @@ layout: default title: Tasks API parent: OpenSearch -nav_order: 8 +nav_order: 25 has_math: false --- diff --git a/docs/opensearch/term.md b/docs/opensearch/term.md index 5aa26734..dd8c6df4 100644 --- a/docs/opensearch/term.md +++ b/docs/opensearch/term.md @@ -2,7 +2,7 @@ layout: default title: Term-level queries parent: OpenSearch -nav_order: 9 +nav_order: 30 --- # Term-level queries diff --git a/docs/opensearch/ux.md b/docs/opensearch/ux.md index 44e3fbd7..a6b40df8 100644 --- a/docs/opensearch/ux.md +++ b/docs/opensearch/ux.md @@ -2,7 +2,7 @@ layout: default title: Search experience parent: OpenSearch -nav_order: 12 +nav_order: 55 --- # Search experience diff --git a/docs/security/configuration/disable.md b/docs/security/configuration/disable.md index bed11352..bdd6267f 100755 --- a/docs/security/configuration/disable.md +++ b/docs/security/configuration/disable.md @@ -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`. -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. {: .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. -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 diff --git a/docs/security/configuration/index.md b/docs/security/configuration/index.md index 2389696e..10a26178 100644 --- a/docs/security/configuration/index.md +++ b/docs/security/configuration/index.md @@ -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: -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 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/) diff --git a/index.md b/index.md index 89896b37..4500b321 100755 --- a/index.md +++ b/index.md @@ -37,7 +37,7 @@ Component | Purpose [Anomaly Detection](docs/ad/) | Identify atypical data and receive automatic notifications [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/). @@ -62,7 +62,7 @@ Docker 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/). -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.