Deploying Elastic using the provided Docker Compose file

To help you evaluate the starter dashboards in a stand-alone sandbox environment, the GitHub repository z-open-data/odp-elastic-samples supplies a Docker Compose file that runs Elastic.

The Compose file starts a container for each Elastic Stack component: Elasticsearch, Logstash, Kibana.

Docker host system requirements

Minimum recommended system requirements for a Docker host running Elastic Stack with the starter dashboards:

• 16 GB RAM
• 200 GB disk space
• 4 vCPUs

Actual system requirements depend on your site-specific practices. For example, the disk space required depends on the amount of data stored in Elasticsearch, which depends on various site-specific factors, including:

• How much data you forward: which attribute tables, and fields in those tables, you forward, and how many systems you are monitoring
• How frequently you forward data, controlled by the attribute table collection interval in OMEGAMON
• How long you keep data, controlled by the Elasticsearch index lifecycle policy that you define

Using the Compose file

1. Install Docker and Docker Compose, if you don't already have them.

2. Check that your Docker host virtual memory settings meet the Elasticsearch requirements.

3. Copy the GitHub repository z-open-data/odp-elastic-samples to your Docker host.

   Either clone the repository or download a .zip file from GitHub.

4. If you plan to deploy the starter dashboards outside of a sandbox environment, then enable Elasticsearch security features. In the supplied Elasticsearch configuration file samples/docker/odp-elastic/elasticsearch/config/elasticsearch.yml, set xpack.security.enabled to true and configure Transport Layer Security (TLS) according to your site-specific requirements. For details, see the Elastic Stack security documentation.

   Warning

   To simplify deploying the starter dashboards inside an already secure, stand-alone sandbox environment, the Docker Compose configuration disables Elasticsearch security features. The elasticsearch.yml file supplied with the Docker Compose file sets xpack.security.enabled to false.

5. Consider configuring the following settings in the supplied Kibana configuration file samples/docker/odp-elastic/kibana/config/kibana.yml:

   • xpack.security.session.idleTimeout
     By default, Kibana times out user sessions that have been inactive for 8 hours. Consider setting a session timeout of your choice.
   • xpack.security.session.lifespan
     By default, Kibana requires users to log in again after 30 days. Consider setting a session life span of your choice.

For details, see the Kibana security documentation.

6. Open a command shell on your Docker host.

7. Change to thesamples/docker/odp-elastic directory of the repository.

8. Enter the following command:

   docker compose up -d
   

For details on Docker Compose, see the Docker documentation.

For details on the Docker images used by the Docker Compose file, see the Elastic Stack documentation.