README.md

Open Distro for Elasticsearch Index Management Kibana

The Open Distro for Elasticsearch Index Management Kibana plugin lets you manage your Open Distro for Elasticsearch Index Management plugin to view, monitor, and manage your indices directly from Kibana.

Documentation

Please see our documentation.

Setup

1. Download Elasticsearch for the version that matches the Kibana version specified in package.json.

2. Download and install the appropriate Open Distro for Elasticsearch Index Management plugin.

3. Download the Kibana source code for the version specified in package.json you want to set up.

   See the Kibana contributing guide for more instructions on setting up your development environment.

4. Change your node version to the version specified in .node-version inside the Kibana root directory.

5. cd into the plugins directory of the Kibana source code directory.

6. Check out this package from version control into the plugins directory.

7. Run yarn kbn bootstrap inside kibana/plugins/index-management-kibana-plugin.

Ultimately, your directory structure should look like this:

.
├── kibana
│   └── plugins
│       └── index-management-kibana-plugin

Build

To build the plugin's distributable zip simply run yarn build.

Example output: ./build/opendistroIndexManagementKibana-1.12.0.0.zip

Run

• yarn start

  • Starts Kibana and includes this plugin. Kibana will be available on localhost:5601.
  • Please run in the Kibana root directory
  • You must have Elasticsearch running with the Index Management plugin

Test

There are unit/stubbed integration tests and cypress e2e/integration tests.

To run the cypress tests, you must have both Elasticsearch and Kibana running with the Index Management plugin running.

If you are running cypress tests with Kibana development server use the --no-base-path option and if you are writing Cypress tests use the --no-watch to make sure your server is not restarted.

• yarn test:jest

  • Runs the plugin tests.

• yarn run cypress open

  • Opens the Cypress test runner

• yarn run cypress run

  • Runs the Cypress test runner

Contributing to Open Distro for Elasticsearch Index Management Kibana

• Refer to CONTRIBUTING.md.
• Since this is a Kibana plugin, it can be useful to review the Kibana contributing guide alongside the documentation around Kibana plugins and plugin development.

Get Started and Contribute!

You can get started by:

• Reporting a bug
• Proposing new ideas to enhance the plugin
• Contribute documentation and sample code
• Read CONTRIBUTING.md for more details to get involved in the project.

Questions

Please feel free to come ask questions on the Open Distro community discussion forum.

License

This code is licensed under the Apache 2.0 License.

Copyright

Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.