Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 5.16 KB

README.md

File metadata and controls

78 lines (54 loc) · 5.16 KB
Raw

OpenSearch Dashboards

Hello!

OpenSearch Dashboards is an open source search and analytics visualization. We aim to to be the best community-driven platform and provide all the contributors a great open source experience.

Feel free to take a look at what the community has been up to, and then head over to the Project Board to track release targets, or jump in and start opening issues or contributing.

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 doesn’t solve your problems, everything else is moot. It’s 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. It’s all Apache 2.0. There’s 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 don’t 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.

Getting Started

If you would like to install and run this project, please see the Downloads Page.

To run OpenSearch Dashboards locally, you first need build artifacts from OpenSearch.

  • Clone the OpenSearch repo with git clone https://github.com/opensearch-project/OpenSearch.git
  • Follow installation and setup instructions in the OpenSearch Developer Guide
  • Run ./gradlew assemble to generate build artifacts for all platforms
  • Run ./gradlew run -Drun.distribution=oss to run the oss build

Or

  • You can also manually find the tar.gz file (.zip on Windows) at ./distribution/archives/<platform-dir>/build/distributions and extract to your desired directory with tar -xvf /path/to/tar/file
  • After extracting, run bin/opensearch inside of the extracted build artifact dir

To run Dashboards with OpenSearch

  • Yarn is required for building and running the OpenSearch Dashboards
  • Install nvm to use the Node 10.24.1 version as it is required
  • Run yarn osd bootstrap in the OpenSearch Dashboards directory
  • While OpenSearch is running locally, run yarn start
  • You can now navigate to http://localhost:5603 where Dashboards runs by default
  • If you pass --no-base-path then it will default to port 5601

Running tests

Jest Unit Tests

Run the command yarn test:jest in the OpenSearch Dashboards project directory to run unit tests

Jest Integration Tests

For the integration tests, you must pass the absolute path of your extracted OpenSearch build artifacts through the TEST_OPENSEARCH_FROM env variable so that Dashboards can run an OpenSearch cluster. You can run: TEST_OPENSEARCH_FROM=/path/to/extracted/build/artifact yarn test:jest_integration

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?

Found a bug or need to leave feedback? Make sure you open an issue. Questions and discussions on this project can be found on the project forums. w00t!!!