Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.8 KB

Using-Docker.md

File metadata and controls

47 lines (34 loc) · 2.8 KB
Raw

Using Docker

Using docker as the runtime environment for testing and validating new developments is now available using the next commands:

Build the plugin

First the plugin must be build using the yarn build command.

Once this build was completed - the expected zip location of the plugin is ./build/observabilityDashboards-?.?.?.zip where as the ?.?.? represents the version of this dashboard plugin.

Note: that the plugin version must correspond to the OpenSearch-Dashboards version - this information appears here

Once the build is completed, make sure to overide the Dockerfile target zip file with the exact name

# Install updated plugin
RUN /usr/share/opensearch-dashboards/bin/opensearch-dashboards-plugin install file:///tmp/observabilityDashboards-3.0.0.zip

Docker imageVersion

The docker images used by this file are all referencing the .env environment file that contains the version that needed to be changed to match your own system.

Run the docker image build

To build the docker image use the next command:

docker build --build-arg VERSION=$(grep VERSION .env | cut -d '=' -f2) -t your_image_name .

Run the docker compose

The docker-compose file represents a simple assembly of an OpenSearch cluster with two nodes and an opensearch dashboard that has the updated image with the latest changes in this plugin.

This is a test only docker compose that should not be used for production purpose - for such use cases please review this link

Option 1 (All from docker)

run docker compose up -d to start the services and once the service is up and running you can start testing the changes.

Option 2 (Combined Docker & Dashboard)

run docker compose up -d opensearch to only run the OpenSearch engine - in this case the dashboard has to be run manualy using yarn start --no-base-path command in the root dashboards path ./OpenSearch-Dashboards/

Note that the OpenSearch version also must correspond to the OpenSearch-Dashboards version

Accessing the Dashboard

The dashboard service uses port localhost:5601 for access and this was already exported in the docker-compose service definition

    ports:
      - 5601:5601 # Map host port 5601 to container port 5601

Security Notice

There is no security plugin and authentication definitions for this development test demo - pay attention not to use this configuration in a production or any environment that may contain confident or personal information without first changing the security definition for accessing the servers - for production use cases please review this link