🔎 Open source distributed and RESTful search engine.
Go to file
Daniel Doubrovkine (dB.) 97698e082c
Cleaned up developer guide, added TOC. (#572)
Signed-off-by: dblock <dblock@amazon.com>
2021-04-21 09:39:31 -07:00
.ci [License] Add SPDX and OpenSearch Modification license header (#509) 2021-04-09 14:28:18 -05:00
.github Adding instructions on License and DCO practices to PR template (#462) 2021-03-26 18:07:58 -04:00
.idea [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
benchmarks [License] Add SPDX and OpenSearch Modification license header (#509) 2021-04-09 14:28:18 -05:00
buildSrc Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00
client Remove all elastic.co references from javadocs (#586) 2021-04-21 10:41:14 +05:30
dev-tools Add script to perform signoff check between commits (#152) 2021-03-13 10:36:15 -06:00
distribution Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00
gradle [License] Add SPDX and OpenSearch Modification license header (#509) 2021-04-09 14:28:18 -05:00
libs Remove the references to xpack and elastic in tests. (#516) 2021-04-09 15:21:58 -07:00
licenses Remove the Elastic license file, all checks for this license and the license REST APIs. (#12) 2021-03-13 10:36:07 -06:00
modules Speed ups to test suite and precommit tasks. (#580) 2021-04-20 09:02:45 -05:00
plugins [Versioning] Rebase to OpenSearch version 1.0.0 (#555) 2021-04-15 17:06:47 -05:00
qa Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00
rest-api-spec [Rename] Remove final references to legacy keystore (#514) 2021-04-09 19:09:02 -05:00
server Remove all elastic.co references from javadocs (#586) 2021-04-21 10:41:14 +05:30
test [Versioning] Rebase to OpenSearch version 1.0.0 (#555) 2021-04-15 17:06:47 -05:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Remove default indent from .editorconfig (#49183) 2019-11-18 08:05:53 +00:00
.gitattributes Add a CHANGELOG file for release notes. (#29450) 2018-04-18 07:42:05 -07:00
.gitignore [Rename] Replace more instances of Elasticsearch with OpenSearch. (#432) 2021-03-21 20:56:34 -05:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2021-03-13 10:36:16 -06:00
CONTRIBUTING.md Fix DCO CLI example in CONTRIBUTING.md (#576) 2021-04-19 14:15:55 -07:00
DEVELOPER_GUIDE.md Cleaned up developer guide, added TOC. (#572) 2021-04-21 09:39:31 -07:00
Jenkinsfile Update CI workflow to work on new infra (#123) 2021-03-13 10:36:15 -06:00
LICENSE.txt Update LICENSE.txt 2021-03-22 09:25:46 -05:00
MAINTAINERS.md Added a maintainers file (#523) 2021-04-12 19:41:03 -07:00
NOTICE.txt Update NOTICE.TXT with OpenSearch copyright (#232) 2021-03-13 10:36:16 -06:00
README.md Update README with getting started (#549) 2021-04-14 08:19:50 -05:00
TESTING.asciidoc Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00
Vagrantfile [Rename] Update Vagrantfile (#515) 2021-04-09 18:27:48 -05:00
build.gradle Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00
gradle.properties Speed ups to test suite and precommit tasks. (#580) 2021-04-20 09:02:45 -05:00
gradlew Update gradle wrapper to 6.6 (#59909) (#60949) 2020-08-11 11:03:19 +02:00
gradlew.bat Update gradle wrapper to 6.6 (#59909) (#60949) 2020-08-11 11:03:19 +02:00
settings.gradle Remove the oss string from OpenSearch distributions (#575) 2021-04-20 09:27:40 -07:00

README.md

OpenSearch

Hello!

OpenSearch is an open source search and analytics engine derived from Elasticsearch 7.10.2, and is currently in an 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 officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache 2.0 compliant code and doing a full rename of the project. Feel free to take a look around at what we've been up to, and then head over to look at the open issues. Or you could jump right in and start opening issues or contributing.

Getting Started

If you would like to install or run this project please see the Developer Guide. There will be binary distributions coming soon which will enable faster installations.

Guiding Principles

Here are the principles we use to guide our development. From opensearch.org:

When we (the contributors) are successful, the OpenSearch project will be:

1. Great software. If it doesnt solve your problems, everything else is moot. Its going to be software you love to use.

2. Open source like we mean it. We are invested in this being a successful open source project for the long term. Its all Apache 2.0. Theres no Contributor License Agreement. Easy.

3. A level playing field. We will not tweak the software so that it runs better for any vendor (including AWS) at the expense of others. If this happens, call it out and we will fix it as a community.

4. Used everywhere. Our 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 us!

5. Made with your input. We will ask for public input on direction, requirements, and implementation for any feature we build.

6. Open to 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 - we will find a way to make that happen. We dont know what that looks like yet, and we look forward to figuring it out together.

7. Respectful, approachable, and friendly. This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor.

8. A place to invent. You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend.

How you can help

Look for the tag "help wanted"

If you're excited to jump in, we've marked a few issues that would be really helpful.

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 forums. Please let us know your thoughts!

Questions? Feedback?

Let us know in the forums.