stackabletech / stackabletech/operator-rs

Add struct to allow universal method of setting jvm parameters

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
167
Forks
19
Avg merge
1d 6h
Merged PRs (30d)
9

Description

A customer wanted to override the jvm heap settings for the Druid operator today and was unable to do this.
In this specific instance it was resolved by the addition of resource configs to the Druid operator, which barely missed the last release window and hence is only available in the nightly version at the moment.

In the future it may become necessary though to allow users to override jvm parameter in some operators and ideally we'll want to do this in a universal way.

We should publish a struct in the operator framework that can be used by operators to allow setting these settings.

We have considered multiple versions of this:

  1. A HashMap<String, String>
  2. A Vec
  3. A custom struct with both a HashMap and a List to accomodate both

All of these have drawbacks and benefits, especiallly when considering how to merge these.
At the moment we tend towards option 2 as this is the most simple one.

The downside is, that is doesn't allow merging with higher level structs to for example override the value of -Xmaxmx=100 with -Xmaxmx=200 for a rolegroup, as this is only a string to us and we won't understand that it refers to the same setting.

We do think that this is an acceptable compromise, since hopefully the need to override values here should not be too frequent.

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

No file, test, or entry point is named in the issue. Start by locating the operator framework's public configuration types, then compare the HashMap, Vec, and custom-struct options against the stated merging requirements. Done means publishing a reusable JVM-parameter structure with an agreed representation and merge behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, rust
Domain
backend-api-design, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.