Add instructions to run OpenSearch from source code

DEVELOPER_GUIDE.md

@@ -82,6 +82,32 @@ opensearch.username: "admin" # Default username
 opensearch.password: "admin" # Default password
 ```
 
+### Run OpenSearch from Source Code using Docker
+
+#### 1. Build the Distributions
+First, compile the source code to build the distributions:
+
+```bash
+./gradlew assemble
+```
+
+After the build completes, you'll find an artifact like `opensearch-ml-3.0.0.0-SNAPSHOT.zip` in the `plugin/build/distributions` directory.
+
+
+#### 2. Run OpenSearch Using Docker Compose
+Navigate to the root directory of the project and start OpenSearch with the following command:
+
+```bash
+docker-compose -f docs/docker/dev-docker-compose.yml up
+```
+
+
+#### 3. Access OpenSearch
+After a few minutes, the server will be ready. You can make requests using `curl` or other HTTP clients. For example,
+```bash
+curl -X GET http://localhost:9200/ 
+```
+
 ### Build
 
 This package uses the [Gradle](https://docs.gradle.org/current/userguide/userguide.html) build system. Gradle comes with excellent documentation that should be your first stop when trying to figure out how to operate or modify the build. we also use the OpenSearch build tools for Gradle. These tools are idiosyncratic and don't always follow the conventions and instructions for building regular Java code using Gradle. Not everything in this package will work the way it's described in the Gradle documentation. If you encounter such a situation, the OpenSearch build tools [source code](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/main/groovy/org/opensearch/gradle) is your best bet for figuring out what's going on.

docs/docker/dev-docker-compose.yml

@@ -0,0 +1,157 @@
+version: '3'
+services:
+  opensearch-node1:
+    image: opensearchstaging/opensearch:3.0.0
+    container_name: opensearch-node1
+    environment:
+      - cluster.name=opensearch-cluster # Sets the name of the OpenSearch cluster
+      - node.name=opensearch-node1 # Sets the name of the node in the cluster
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2 # Defines initial nodes for cluster discovery
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2 # Defines initial cluster manager nodes
+      - bootstrap.memory_lock=true # along with the memlock settings below, disables swapping
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MyPassword123! # Sets the initial admin password
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" # Sets JVM heap size to 512MB
+      - "DISABLE_SECURITY_PLUGIN=true" # Disables the security plugin for easy access
+
+    ulimits:
+      memlock:
+        soft: -1 # Ensures unlimited memory locking
+        hard: -1
+      nofile:
+        soft: 65536 # maximum number of open files for the OpenSearch user, set to at least 65536 on modern systems
+        hard: 65536
+    volumes:
+      # Persist data for the first OpenSearch node to ensure cluster state, indexes, and metadata are retained
+      - opensearch-data1:/usr/share/opensearch/data
+
+      # Mount the local plugin build directory into the container to make custom plugins available for installation
+      - ../../plugin/build/distributions:/usr/share/opensearch/dev
+
+    # We will now remove the existing 'opensearch-skills' plugin to prevent version conflicts
+    # Remove the existing 'opensearch-ml' plugin to ensure a clean installation
+    # Install the new version of the 'opensearch-ml' plugin from a local distribution file
+    # Start the OpenSearch service using the Docker entrypoint script
+    command: bash -c "bin/opensearch-plugin remove opensearch-skills; bin/opensearch-plugin remove opensearch-ml; bin/opensearch-plugin install --batch file:///usr/share/opensearch/dev/opensearch-ml-3.0.0.0-SNAPSHOT.zip; ./opensearch-docker-entrypoint.sh opensearch"
+    ports:
+      - 9200:9200 # Main OpenSearch API port
+      - 9600:9600 # required for Performance Analyzer
+      - 5005:5005 # Debugging port
+
+    networks:
+      - opensearch-net # Connects to OpenSearch network
+  opensearch-node2:
+    image: opensearchstaging/opensearch:3.0.0
+    container_name: opensearch-node2
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-node2
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MyPassword123!
+      - "DISABLE_SECURITY_PLUGIN=true"
+
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      # Persist data for the second OpenSearch node to maintain high availability and redundancy
+      - opensearch-data2:/usr/share/opensearch/data
+
+      # Mount the local plugin build directory into the container to make custom plugins available for installation
+      - ../../plugin/build/distributions:/usr/share/opensearch/dev
+
+    # We will now remove the existing 'opensearch-skills' plugin to prevent version conflicts
+    # Remove the existing 'opensearch-ml' plugin to ensure a clean installation
+    # Install the new version of the 'opensearch-ml' plugin from a local distribution file
+    # Start the OpenSearch service using the Docker entrypoint script
+    command: bash -c "bin/opensearch-plugin remove opensearch-skills; bin/opensearch-plugin remove opensearch-ml; bin/opensearch-plugin install --batch file:///usr/share/opensearch/dev/opensearch-ml-3.0.0.0-SNAPSHOT.zip; ./opensearch-docker-entrypoint.sh opensearch"
+    networks:
+      - opensearch-net
+
+  opensearch-ml1:
+    image: opensearchstaging/opensearch:3.0.0
+    container_name: opensearch-ml1
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-ml1
+      - node.roles=ml # Defines this node as an ML node
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MyPassword123!
+      - "DISABLE_SECURITY_PLUGIN=true"
+
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      # Persist machine learning-related data for the first ML node to store model metadata and results
+      - opensearch-ml1:/usr/share/opensearch/data
+
+      # Mount the local plugin build directory into the container to make custom plugins available for installation
+      - ../../plugin/build/distributions:/usr/share/opensearch/dev
+
+    # We will now remove the existing 'opensearch-skills' plugin to prevent version conflicts
+    # Remove the existing 'opensearch-ml' plugin to ensure a clean installation
+    # Install the new version of the 'opensearch-ml' plugin from a local distribution file
+    # Start the OpenSearch service using the Docker entrypoint script
+    command: bash -c "bin/opensearch-plugin remove opensearch-skills; bin/opensearch-plugin remove opensearch-ml; bin/opensearch-plugin install --batch file:///usr/share/opensearch/dev/opensearch-ml-3.0.0.0-SNAPSHOT.zip; ./opensearch-docker-entrypoint.sh opensearch"
+    networks:
+      - opensearch-net
+
+  opensearch-ml2:
+    image: opensearchstaging/opensearch:3.0.0
+    container_name: opensearch-ml2
+    environment:
+      - cluster.name=opensearch-cluster
+      - node.name=opensearch-ml2
+      - node.roles=ml
+      - discovery.seed_hosts=opensearch-node1,opensearch-node2
+      - cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+      - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MyPassword123!
+      - "DISABLE_SECURITY_PLUGIN=true"
+
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    volumes:
+      # Persist machine learning-related data for the second ML node to support distributed ML processing and data redundancy
+      - opensearch-ml2:/usr/share/opensearch/data
+
+      # Mount the local plugin build directory into the container to make custom plugins available for installation
+      - ../../plugin/build/distributions:/usr/share/opensearch/dev
+
+    # We will now remove the existing 'opensearch-skills' plugin to prevent version conflicts
+    # Remove the existing 'opensearch-ml' plugin to ensure a clean installation
+    # Install the new version of the 'opensearch-ml' plugin from a local distribution file
+    # Start the OpenSearch service using the Docker entrypoint script
+    command: bash -c "bin/opensearch-plugin remove opensearch-skills; bin/opensearch-plugin remove opensearch-ml; bin/opensearch-plugin install --batch file:///usr/share/opensearch/dev/opensearch-ml-3.0.0.0-SNAPSHOT.zip; ./opensearch-docker-entrypoint.sh opensearch"
+    networks:
+      - opensearch-net
+
+volumes:
+  opensearch-data1:
+  opensearch-data2:
+  opensearch-ml1:
+  opensearch-ml2:
+
+
+networks:
+  opensearch-net: