Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 4.03 KB

readme.md

File metadata and controls

71 lines (56 loc) · 4.03 KB
Raw

ReadonlyREST sandbox

The purpose of this sandbox is to make it easy to set up the Elasticsearch and optionally the Kibana, along with the ROR plugin. It's called sandbox because it creates an isolated environment that is completely independent of what you have installed on your system. Additionally, it doesn't change any settings or data on a system it's run on, besides created Docker volumes (which can be easily cleaned using clean.sh script). Because of all these features, it's well suited for tests, experiments with configuration, development and so on.

Here's a list of things that you can do with this sandbox:

  • Set up a specific version of Elasticsearch and Kibana with the ROR plugin.
  • Set up Elasticsearch and Kibana along with ROR plugin from a custom location.
  • Set up Elasticsearch for remote debugging.
  • Set up Kibana connected to Elasticsearch executed in IDE for Elasticsearch plugin debugging.

Requirements

To use this sandbox you will need two things installed on your system: Docker and Docker Compose. Here are links to pages with instructions on how to install them:

Quick start

Currently, we have two types deployments:

  1. ES+KBN cluster with ROR (ror-demo-cluster)
  2. Local ES+KBN cluster with ROR and remote X-Pack Security cluster in Elastic Cloud (ror-cluster-elastic-cloud-demo)

Pick one of types and go to its location. Then run run.sh script and follow the interactive guides. Make sure that you clean up after your tests (clean.sh script).

Configuration

Here's description of each file under the conf directory:

  • ror-demo-cluster/conf/ (or ror-cluster-elastic-cloud-demo/conf/)
    • elasticsearch.yml - minimal single node Elasticsearch configuration file
    • log4j2.properties - log4j properties file which could be used to change log level for Elasticsearch
    • readonlyrest.yml - sample ROR configuration file which allows Kibana to access it
    • kibana.yml - minimal Kibana configuration file

Exposed ports

By default, services from sandbox expose these ports:

  • 19200 - Elasticsearch REST
  • 19300 - Elasticsearch transport
  • 15601 - Kibana
  • 5000 - remote debugger port (Elasticsearch)

Running clusters

cd ror-demo-cluster (OR cd ror-cluster-elastic-cloud-demo) $ ./run

Then follow the instructions in the interactive script. When you finish your test, clean up:

$ ./clean.sh

Connecting IntelliJ IDEA remote debugger to Elasticsearch set up in sandbox

Here's a description of how to connect using remote debugger to the running Elasticsearch server which has been started using this sandbox.

  1. Open the elasticsearch-readonlyrest-plugin project in IntelliJ IDEA.
  2. Checkout the commit with the same version of ROR code that is running in Elasticsearch you want to connect.
  3. Open Edit configurations... window. It can be done by pressing the shift key twice and entering "Edit configurations" or from Run->Edit configurations... menu.
  4. If you don't have remote debugger configuration yet add it by clicking "+" icon and choosing Remote JVM Debug add new configuration
  5. The new configuration will be automatically selected. You can assign it a custom name like "sandbox remote debugger" on the presented screenshot. The host and port should be set exactly as they are on this screenshot. The last marked thing is a module classpath. You should choose the module corresponding to the ES version you are trying to debug with a name ending with .main. The module selected in the screenshot is appropriate for debugging ES 7.2.x. remote debug
  6. Click OK to save the configuration.
  7. You should now see the name of the created configuration in the upper right corner of IntelliJ IDEA. remote debug
  8. Click on the bug icon next to it to start the debugger.
  9. After the successful connection, a window like that should pop up from the bottom successful debug connection