From a4b41fbbbc04f4279ea1506511fee480a809ce39 Mon Sep 17 00:00:00 2001 From: Raman Saparkhan <109868980+roma2023@users.noreply.github.com> Date: Wed, 5 Jul 2023 12:49:31 -0400 Subject: [PATCH] Added Docker Installation Details into DEVELOPER_GUIDE.md (#427) Signed-off-by: Raman Saparkhan --- DEVELOPER_GUIDE.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index e1a5201a..fad93de0 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -1,7 +1,8 @@ - [Developer Guide](#developer-guide) - [Prerequisites](#prerequisites) + - [Docker Image Installation](#docker-setup) - [Running Tests](#running-tests) - - [Linter](#linter) + - [Integration Tests](#integration-tests) - [Documentation](#documentation) - [Running Python Client Generator](#running-python-client-generator) @@ -22,6 +23,22 @@ Install [Nox](https://nox.thea.codes/en/stable/) for task management. $ python -m pip install nox ``` +## Install Docker Image + +Integration tests require [docker](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/). + +Run the following commands to install the docker image: + +``` +docker pull opensearchproject/opensearch:latest +``` + +Integration tests will auto-start the docker image. To start it manually: + +``` +docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:latest +``` + ## Running Tests Tests require a live instance of OpenSearch running in docker.