rstudio / rstudio/helm

job-json-overrides mistakenly applied to other files in `profiles:`

Open
#168 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Markdown
Stars
46
Forks
40
Avg merge
4h 3m
Merged PRs (30d)
6

Description

When using the job-json-overrides computation, we mistakenly add job-json-overrides to other files too.

We should fix this issue!

tmp123.yaml

cat tmp123.yaml
config:
  profiles:
    launcher.kubernetes.profiles.conf:
      '*':
        job-json-overrides:
          - name: hi
            target: ho
            json: silver
    profiles:
      '*':
        key: value
helm template rstudio/rstudio-workbench -f tmp123.yaml | grep profiles -A 8
#  launcher.kubernetes.profiles.conf: |
#
#    [*]
#    allow-unknown-images=1
#    container-images=rstudio/r-session-complete:bionic-2021.09.2-382.pro1
#    default-container-image=rstudio/r-session-complete:bionic-2021.09.2-382.pro1
#    job-json-overrides="/spec/template/spec/volumes/-":"/mnt/job-json-overrides-new/defaultSessionVolume.json","/spec/template/spec/containers/0/volumeMounts/-":"/mnt/job-json-overrides-new/defaultSessionVolumeMount.json","ho":"/mnt/job-json-overrides-new/hi.json"
#
#
#  profiles: |
#
#    [*]
#    job-json-overrides="/spec/template/spec/volumes/-":"/mnt/job-json-overrides-new/defaultSessionVolume.json","/spec/template/spec/containers/0/volumeMounts/-":"/mnt/job-json-overrides-new/defaultSessionVolumeMount.json"
#    key=value

Related to #161 (which may render this approach obsolete)

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

Reproduce the issue with tmp123.yaml using the shown helm template command, then trace how profiles and job-json-overrides are rendered together. Done means the generated launcher.kubernetes.profiles.conf still contains its override while the separate profiles output contains key=value without the job-json-overrides entries; check whether related issue #161 changes the intended approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes, yaml
Domain
devops
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.