Document updates (#323)
author Charlotte Henkle <henkle@amazon.com> 1615871106 -0700 committer CEHENKLE <henkle@amazon.com> 1615953574 -0700 gpgsig -----BEGIN PGP SIGNATURE----- iQGzBAABCAAdFiEEX/CuQ5xIOk0pNjkiruIgsODnx1gFAmBRfqYACgkQruIgsODn x1hV6gv/aXar3NmXw4X3uks7eWWobgtuH9vUAIDjurGcBl3PfSQus9hwmnsmfMcc LiJY2cU1D1vbqrNnHKqC2aRlA1SXj3xEMPdeMyhPX0Dl01urijvXAW5mAte7Tn+F /kK4kcSan552EqPoKnzBUfE3Zia7rriOGF60qGMlZbq2bbQQ2/SfT5WsQrJI2D5k IXm062UR6q5pvZfHy1HB/sIFAETv1/knJHyMWv/vH5wmwQvRvue5d30aNK/K60Kz G4ALXlehj/Nfv5t16SAB+x65Y9lJ1cBJT98PbT8SCa1ZILjbWFJDwKvFqFQ4kkCD QbfzHp3ez4vUrEt9L+p6RmYxxn96VQj1n+2tRlC64sVBvS3qhize85NCBoCSUtRC dGyW/fxeILJtgXNfi49WA4UPQ6LaRSnlvAFXogaFeBLYqReLVL6R/HTNvtqDZ4S8 ZSMs18cFpNq0Lgv2By5Ub0/FBKWQDqe4ydHNK9cdjAEE1wVTTQ2H3X87XPiILrAP l4B1Swwr =a0jN -----END PGP SIGNATURE----- Adding new templates for bugs, issues and PRs. Adding new README. Adding CONTRIBUTING.md and DEVELOPER_GUIDE.md Signed-off-by: CEHENKLE <henkle@amazon.com>
This commit is contained in:
CEHENKLE
GitHub
parent
b0f137e954
commit
bacc7899a2
Binary file not shown.
Binary file not shown.
Binary file not shown.
219
README.asciidoc
219
README.asciidoc
|
|
@ -1,219 +0,0 @@
|
|||
= Elasticsearch
|
||||
|
||||
== A Distributed RESTful Search Engine
|
||||
|
||||
=== https://www.elastic.co/products/elasticsearch[https://www.elastic.co/products/elasticsearch]
|
||||
|
||||
Elasticsearch is a distributed RESTful search engine built for the cloud. Features include:
|
||||
|
||||
* Distributed and Highly Available Search Engine.
|
||||
** Each index is fully sharded with a configurable number of shards.
|
||||
** Each shard can have one or more replicas.
|
||||
** Read / Search operations performed on any of the replica shards.
|
||||
* Multi-tenant.
|
||||
** Support for more than one index.
|
||||
** Index level configuration (number of shards, index storage, etc.).
|
||||
* Various set of APIs
|
||||
** HTTP RESTful API
|
||||
** All APIs perform automatic node operation rerouting.
|
||||
* Document oriented
|
||||
** No need for upfront schema definition.
|
||||
** Schema can be defined for customization of the indexing process.
|
||||
* Reliable, Asynchronous Write Behind for long term persistency.
|
||||
* Near real-time search.
|
||||
* Built on top of Apache Lucene
|
||||
** Each shard is a fully functional Lucene index
|
||||
** All the power of Lucene easily exposed through simple configuration and plugins.
|
||||
* Per operation consistency
|
||||
** Single document-level operations are atomic, consistent, isolated, and durable.
|
||||
|
||||
== Getting Started
|
||||
|
||||
First of all, DON'T PANIC. It will take 5 minutes to get the gist of what Elasticsearch is all about.
|
||||
|
||||
=== Installation
|
||||
|
||||
* https://www.elastic.co/downloads/elasticsearch[Download] and unpack the Elasticsearch official distribution.
|
||||
* Run `bin/elasticsearch` on Linux or macOS. Run `bin\elasticsearch.bat` on Windows.
|
||||
* Run `curl -X GET http://localhost:9200/` to verify Elasticsearch is running.
|
||||
|
||||
=== Indexing
|
||||
|
||||
First, index some sample JSON documents. The first request automatically creates
|
||||
the `my-index-000001` index.
|
||||
|
||||
----
|
||||
curl -X POST 'http://localhost:9200/my-index-000001/_doc?pretty' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"@timestamp": "2099-11-15T13:12:00",
|
||||
"message": "GET /search HTTP/1.1 200 1070000",
|
||||
"user": {
|
||||
"id": "kimchy"
|
||||
}
|
||||
}'
|
||||
|
||||
curl -X POST 'http://localhost:9200/my-index-000001/_doc?pretty' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"@timestamp": "2099-11-15T14:12:12",
|
||||
"message": "GET /search HTTP/1.1 200 1070000",
|
||||
"user": {
|
||||
"id": "elkbee"
|
||||
}
|
||||
}'
|
||||
|
||||
curl -X POST 'http://localhost:9200/my-index-000001/_doc?pretty' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"@timestamp": "2099-11-15T01:46:38",
|
||||
"message": "GET /search HTTP/1.1 200 1070000",
|
||||
"user": {
|
||||
"id": "elkbee"
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
=== Search
|
||||
|
||||
Next, use a search request to find any documents with a `user.id` of `kimchy`.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/my-index-000001/_search?q=user.id:kimchy&pretty=true'
|
||||
----
|
||||
|
||||
Instead of a query string, you can use Elasticsearch's
|
||||
https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html[Query
|
||||
DSL] in the request body.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"query" : {
|
||||
"match" : { "user.id": "kimchy" }
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
You can also retrieve all documents in `my-index-000001`.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"query" : {
|
||||
"match_all" : {}
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
During indexing, Elasticsearch automatically mapped the `@timestamp` field as a
|
||||
date. This lets you run a range search.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/my-index-000001/_search?pretty=true' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"query" : {
|
||||
"range" : {
|
||||
"@timestamp": {
|
||||
"from": "2099-11-15T13:00:00",
|
||||
"to": "2099-11-15T14:00:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
=== Multiple indices
|
||||
|
||||
Elasticsearch supports multiple indices. The previous examples used an index
|
||||
called `my-index-000001`. You can create another index, `my-index-000002`, to
|
||||
store additional data when `my-index-000001` reaches a certain age or size. You
|
||||
can also use separate indices to store different types of data.
|
||||
|
||||
You can configure each index differently. The following request
|
||||
creates `my-index-000002` with two primary shards rather than the default of
|
||||
one. This may be helpful for larger indices.
|
||||
|
||||
----
|
||||
curl -X PUT 'http://localhost:9200/my-index-000002?pretty' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"settings" : {
|
||||
"index.number_of_shards" : 2
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
You can then add a document to `my-index-000002`.
|
||||
|
||||
----
|
||||
curl -X POST 'http://localhost:9200/my-index-000002/_doc?pretty' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"@timestamp": "2099-11-16T13:12:00",
|
||||
"message": "GET /search HTTP/1.1 200 1070000",
|
||||
"user": {
|
||||
"id": "kimchy"
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
You can search and perform other operations on multiple indices with a single
|
||||
request. The following request searches `my-index-000001` and `my-index-000002`.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/my-index-000001,my-index-000002/_search?pretty=true' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"query" : {
|
||||
"match_all" : {}
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
You can omit the index from the request path to search all indices.
|
||||
|
||||
----
|
||||
curl -X GET 'http://localhost:9200/_search?pretty=true' -H 'Content-Type: application/json' -d '
|
||||
{
|
||||
"query" : {
|
||||
"match_all" : {}
|
||||
}
|
||||
}'
|
||||
----
|
||||
|
||||
=== Distributed, highly available
|
||||
|
||||
Let's face it; things will fail...
|
||||
|
||||
Elasticsearch is a highly available and distributed search engine. Each index is broken down into shards, and each shard can have one or more replicas. By default, an index is created with 1 shard and 1 replica per shard (1/1). Many topologies can be used, including 1/10 (improve search performance) or 20/1 (improve indexing performance, with search executed in a MapReduce fashion across shards).
|
||||
|
||||
To play with the distributed nature of Elasticsearch, bring more nodes up and shut down nodes. The system will continue to serve requests (ensure you use the correct HTTP port) with the latest data indexed.
|
||||
|
||||
=== Where to go from here?
|
||||
|
||||
We have just covered a tiny portion of what Elasticsearch is all about. For more information, please refer to the https://www.elastic.co/products/elasticsearch[elastic.co] website. General questions can be asked on the https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[on Slack]. The Elasticsearch GitHub repository is reserved for bug reports and feature requests only.
|
||||
|
||||
=== Building from source
|
||||
|
||||
Elasticsearch uses https://gradle.org[Gradle] for its build system.
|
||||
|
||||
To build a distribution for your local OS and print its output location upon
|
||||
completion, run:
|
||||
----
|
||||
./gradlew localDistro
|
||||
----
|
||||
|
||||
To build a distribution for another platform, run the related command:
|
||||
----
|
||||
./gradlew :distribution:archives:linux-tar:assemble
|
||||
./gradlew :distribution:archives:darwin-tar:assemble
|
||||
./gradlew :distribution:archives:windows-zip:assemble
|
||||
----
|
||||
|
||||
To build distributions for all supported platforms, run:
|
||||
----
|
||||
./gradlew assemble
|
||||
----
|
||||
|
||||
Finished distributions are output to `distributions/archives`.
|
||||
|
||||
See the xref:TESTING.asciidoc[TESTING] for more information about running the Elasticsearch test suite.
|
||||
|
||||
=== Upgrading from older Elasticsearch versions
|
||||
|
||||
To ensure a smooth upgrade process from earlier versions of Elasticsearch, please see our https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[upgrade documentation] for more details on the upgrade process.
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
# OpenSearch
|
||||
|
||||
Hello!
|
||||
|
||||
OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2, and is currently in a pre-alpha state. While we're still in the process of getting set up, we are excited to build the best distributed search engine on the planet with you.
|
||||
|
||||
We'll update this page as the state of the project changes, so please check back frequently.
|
||||
|
||||
## Current state of the world
|
||||
We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache code and doing a full rename of the project. For more details, <add link to blogpost>
|
||||
|
||||
### What works
|
||||
|
||||
* All references to non-Apache 2.0 code should be removed, and we should be using the new project name everywhere.
|
||||
* ./gradlew precommit should be passing. Please let us know if you see issues.
|
||||
* CI/CD with a DCO check.
|
||||
|
||||
### What doesn't work
|
||||
|
||||
* Unit Tests
|
||||
* Integration Tests
|
||||
* Plug-ins
|
||||
|
||||
### Guiding Principles
|
||||
|
||||
* Great software. If it doesn’t solve a user's problem, everything else is moot. It shall be software you love to use.
|
||||
|
||||
* Open source like we mean it. Contributors shall be invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy.
|
||||
|
||||
* A level playing field. Contributors shall not tweak the software so that it runs better for any vendor at the expense of others. If this happens, call it out and the contributors shall fix it together as a community.
|
||||
|
||||
* Used everywhere. The project goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise the community!
|
||||
|
||||
* Made with community input. Project maintainers shall ask for public input on direction, requirements, and implementation for any feature built.
|
||||
|
||||
* Open to all contributions. Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - the project maintainers shall find a way to make it happen.
|
||||
|
||||
* Respectful, approachable, and friendly. This will be a community where all will be heard, accepted, and valued, whether a new or experienced user or contributor.
|
||||
|
||||
* A place to invent and innovate. You will be able to innovate rapidly. This project shall have a stable and predictable foundation that is modular, making it easy to extend.
|
||||
|
||||
|
||||
## How you can help
|
||||
|
||||
### Look for the tag "Low Hanging Fruit"
|
||||
|
||||
If you're excited to jump in, we've tried to mark a few issues that would be good candidates to get started on. Look for the tag "Low Hanging Fruit" to find them.
|
||||
|
||||
### Watch the forum, because there are a bunch of things we want to talk about
|
||||
As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the forum. Please let us know your thoughts!
|
||||
|
||||
### Questions? Feedback?
|
||||
|
||||
Let us know in the forums.
|
||||
Loading…
Reference in New Issue