opensearch-project / opensearch-project/data-prepper

Support parsing configuration files with Spring

Open
#932 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog enhancement Priority-Low
Dominant language
Java
Stars
374
Forks
354
Avg merge
3d 18h
Merged PRs (30d)
8

Description

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

Configuration file parsing is not type safe
Environment variable configuration properties are not supported
No support for shared configuration properties for multiple stage/environment deployments. (ex: ci, cert, perf, prod)

Describe the solution you'd like

Parse configuration properties to @ConfigurationProperties objects using Spring Configuration. Use @PropertySource("classpath:pipelines.yaml") annotation to designate configuration file.

Describe alternatives you've considered (Optional)
none

Additional context
Additional Spring dependencies may need to be added to the project to support the full yaml syntax.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the project's current configuration-loading approach and the Spring annotations named in the issue: @ConfigurationProperties and @PropertySource("classpath:pipelines.yaml"). Determine the required support for type-safe YAML parsing, environment variables, and shared stage or environment properties, including any Spring dependencies. Done means these configuration scenarios are supported and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.