opensearch-project/OpenSearch

[DEV] Allow developers to have a local/modify opensearch.yml or ENV

Open

#594 opened on Apr 21, 2021

View on GitHub
 (5 comments) (0 reactions) (1 assignee)Java (1,505 forks)batch import
Build Libraries & InterfacesPriority-Lowenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

I was trying to figure out how to expose 0.0.0.0 from my EC2 test instance on which I do development. What worked was to run ./gradlew -Dtests.opensearch.http.host=0.0.0.0 run.

Describe the solution you'd like

I'd like to be able to do any (combination) of these:

a) modify distribution/src/config/opensearch.yml or another yml and have it get picked up by ./gradlew run b) use an equivalent of dotenv to permanently override settings, e.g. OPENSEARCH_HTTP_HOST=0.0.0.0 ./gradlew run which would allow one to create .env and run dotenv ./gradlew run c) some other set it and forget it mechanism

Describe alternatives you've considered

Run ./gradlew assemble to build the ZIP for the distribution. Extract the zip and edit config/opensearch.yml. But this is more time consuming.

Additional context

Contributor guide

Research direction
Investigate the build system and configuration loading in OpenSearch to propose a solution for allowing developers to easily override settings via opensearch.yml or environment variables.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65