generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 620
Update and redirect main page in 1.2 #10481
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
dc84aab
Correct menu for 1.2
kolchfa-aws 6fc40ac
Merge branch '1.2' into menu-fix-1.2
kolchfa-aws f77161f
Redirect index page to about and add version
kolchfa-aws 29594ce
Apply suggestions from code review
kolchfa-aws da1d3a1
Update index.md
kolchfa-aws File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,131 @@ | ||
| --- | ||
| layout: default | ||
| title: About OpenSearch | ||
| nav_exclude: true | ||
| title: Get started | ||
| nav_order: 1 | ||
| redirect_from: /404.html | ||
| permalink: /about/ | ||
| redirect_to: / | ||
| canonical_url: https://opensearch.org/docs/latest/about/ | ||
| --- | ||
|
|
||
| # OpenSearch and OpenSearch Dashboards | ||
| **Version {{site.opensearch_major_minor_version}}** | ||
| {: .label .label-blue } | ||
|
|
||
| This site contains the technical documentation for [OpenSearch](https://opensearch.org/), the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. | ||
|
|
||
| [Get started](#docker-quickstart){: .btn .btn-blue } | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Why use OpenSearch? | ||
|
|
||
| OpenSearch is well-suited to the following use cases: | ||
|
|
||
| * Log analytics | ||
| * Real-time application monitoring | ||
| * Clickstream analytics | ||
| * Search backend | ||
|
|
||
| Component | Purpose | ||
| :--- | :--- | ||
| [OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/) | Data store and search engine | ||
| [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) | Search frontend and visualizations | ||
| [Security]({{site.url}}{{site.baseurl}}/security-plugin/) | Authentication and access control for your cluster | ||
| [Alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) | Receive notifications when your data meets certain conditions | ||
| [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) | Use SQL or a piped processing language to query your data | ||
| [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) | Automate index operations | ||
| [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) | Find “nearest neighbors” in your vector data | ||
| [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) | Monitor and optimize your cluster | ||
| [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications | ||
| [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background | ||
| [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) | Replicate your data across multiple OpenSearch clusters | ||
|
|
||
| Most 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/). | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Docker quickstart | ||
| Docker | ||
| {: .label .label-green } | ||
|
|
||
| 1. Install and start [Docker Desktop](https://www.docker.com/products/docker-desktop). | ||
| 1. Run the following commands: | ||
|
|
||
| ```bash | ||
| docker pull opensearchproject/opensearch:{{site.opensearch_version}} | ||
| docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}} | ||
| ``` | ||
|
|
||
| 1. In a new terminal session, run: | ||
|
|
||
| ```bash | ||
| curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200' | ||
| ``` | ||
|
|
||
| 1. [Create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) your first index. | ||
|
|
||
| ```bash | ||
| curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index' | ||
| ``` | ||
|
|
||
| 1. [Add some data]({{site.url}}{{site.baseurl}}/opensearch/index-data/) to your newly created index. | ||
|
|
||
| ```bash | ||
| curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' -H 'Content-Type: application/json' -d '{"Description": "To be or not to be, that is the question."}' | ||
| ``` | ||
|
|
||
| 1. [Retrieve the data]({{site.url}}{{site.baseurl}}/opensearch/index-data/#read-data) to see that it was added properly. | ||
|
|
||
| ```bash | ||
| curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' | ||
| ``` | ||
|
|
||
| 1. After verifying that the data is correct, [delete the document]({{site.url}}{{site.baseurl}}/opensearch/index-data/#delete-data). | ||
|
|
||
| ```bash | ||
| curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' | ||
| ``` | ||
|
|
||
| 1. Finally, [delete the index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/delete-index). | ||
|
|
||
| ```bash | ||
| curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/' | ||
| ``` | ||
|
|
||
| To learn more, see [Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker/) and [Docker security configuration]({{site.url}}{{site.baseurl}}/opensearch/install/docker-security/). | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| For more comprehensive installation instructions for other download types, such as tarballs, see these pages: | ||
|
|
||
| - [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/) | ||
| - [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/) | ||
|
|
||
|
|
||
| ## The secure path forward | ||
|
|
||
| OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must [configure the security plugin manually]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/): your own certificates, your own authentication method, your own users, and your own passwords. | ||
|
|
||
|
|
||
| ## Looking for the Javadoc? | ||
|
|
||
| See [opensearch.org/javadocs/](https://opensearch.org/javadocs/). | ||
|
|
||
|
|
||
| ## Get involved | ||
|
|
||
| [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 [Contributing](https://opensearch.org/source.html) on the OpenSearch website. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| <small>OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.</small> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,129 +1,9 @@ | ||
| --- | ||
| layout: default | ||
| title: Get started | ||
| nav_order: 1 | ||
| redirect_from: /404.html | ||
| title: OpenSearch Documentation | ||
| nav_exclude: true | ||
| redirect_to: /about/ | ||
| permalink: / | ||
| canonical_url: https://docs.opensearch.org/latest/about/ | ||
| --- | ||
|
|
||
| # OpenSearch documentation | ||
|
|
||
| This site contains the technical documentation for [OpenSearch](https://opensearch.org/), the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. | ||
|
|
||
| [Get started](#docker-quickstart){: .btn .btn-blue } | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Why use OpenSearch? | ||
|
|
||
| OpenSearch is well-suited to the following use cases: | ||
|
|
||
| * Log analytics | ||
| * Real-time application monitoring | ||
| * Clickstream analytics | ||
| * Search backend | ||
|
|
||
| Component | Purpose | ||
| :--- | :--- | ||
| [OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/) | Data store and search engine | ||
| [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) | Search frontend and visualizations | ||
| [Security]({{site.url}}{{site.baseurl}}/security-plugin/) | Authentication and access control for your cluster | ||
| [Alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) | Receive notifications when your data meets certain conditions | ||
| [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) | Use SQL or a piped processing language to query your data | ||
| [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) | Automate index operations | ||
| [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) | Find “nearest neighbors” in your vector data | ||
| [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) | Monitor and optimize your cluster | ||
| [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications | ||
| [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background | ||
| [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) | Replicate your data across multiple OpenSearch clusters | ||
|
|
||
| Most 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/). | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Docker quickstart | ||
| Docker | ||
| {: .label .label-green } | ||
|
|
||
| 1. Install and start [Docker Desktop](https://www.docker.com/products/docker-desktop). | ||
| 1. Run the following commands: | ||
|
|
||
| ```bash | ||
| docker pull opensearchproject/opensearch:{{site.opensearch_version}} | ||
| docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}} | ||
| ``` | ||
|
|
||
| 1. In a new terminal session, run: | ||
|
|
||
| ```bash | ||
| curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200' | ||
| ``` | ||
|
|
||
| 1. [Create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) your first index. | ||
|
|
||
| ```bash | ||
| curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index' | ||
| ``` | ||
|
|
||
| 1. [Add some data]({{site.url}}{{site.baseurl}}/opensearch/index-data/) to your newly created index. | ||
|
|
||
| ```bash | ||
| curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' -H 'Content-Type: application/json' -d '{"Description": "To be or not to be, that is the question."}' | ||
| ``` | ||
|
|
||
| 1. [Retrieve the data]({{site.url}}{{site.baseurl}}/opensearch/index-data/#read-data) to see that it was added properly. | ||
|
|
||
| ```bash | ||
| curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' | ||
| ``` | ||
|
|
||
| 1. After verifying that the data is correct, [delete the document]({{site.url}}{{site.baseurl}}/opensearch/index-data/#delete-data). | ||
|
|
||
| ```bash | ||
| curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' | ||
| ``` | ||
|
|
||
| 1. Finally, [delete the index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/delete-index). | ||
|
|
||
| ```bash | ||
| curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/' | ||
| ``` | ||
|
|
||
| To learn more, see [Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker/) and [Docker security configuration]({{site.url}}{{site.baseurl}}/opensearch/install/docker-security/). | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| For more comprehensive installation instructions for other download types, such as tarballs, see these pages: | ||
|
|
||
| - [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/) | ||
| - [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/) | ||
|
|
||
|
|
||
| ## The secure path forward | ||
|
|
||
| OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must [configure the security plugin manually]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/): your own certificates, your own authentication method, your own users, and your own passwords. | ||
|
|
||
|
|
||
| ## Looking for the Javadoc? | ||
|
|
||
| See [opensearch.org/javadocs/](https://opensearch.org/javadocs/). | ||
|
|
||
|
|
||
| ## Get involved | ||
|
|
||
| [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 [Contributing](https://opensearch.org/source.html) on the OpenSearch website. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| <small>OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.</small> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.