cloudbees / cloudbees/cloudbees-examples
Inconsistency between documentation and helm-values
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 40
- Forks
- 81
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 1
Description
The documentation states that the JVM memory, for the flow-repo, should be at least 512MB (for minimum specs):
https://docs.cloudbees.com/docs/cloudbees-cd/latest/requirements/k8s-requirements#_small_to_mid_range_deployments
In values.yaml: https://github.com/cloudbees/cloudbees-examples/blob/c2a648bbadaf930b8ad1d7fe2ab428dbc58faac9/cloudbees-cd/kubernetes/values.yaml#L246
We could see that the initial Java heap size is set to 256MB.
I think the initial java heap size should be increased to 512MB and the max one to 1024MB but maybe the pod resources should be increased as well if we increase the JVM memory needs...
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the minimum-specification documentation with cloudbees-cd/kubernetes/values.yaml around line 246. Check the flow-repo JVM heap settings and the related pod resource values, then determine the settings needed to keep the example consistent with the documented 512MB minimum. Done means the values and documentation no longer contradict each other.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm, java, kubernetes
- Domain
- devops, infrastructure
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100