rstudio / rstudio/helm

docs: incorrectly recommends `job-json-overrides` for Connect Kubernetes job customization

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

Nobody has claimed this yet.

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

Description

The Helm documentation at https://docs.posit.co/helm/docs/customize.html#customize-kubernetes-jobs recommends using job-json-overrides to customize Kubernetes jobs for both Workbench and Connect. However, this mechanism does not work for Connect when templates are enabled.

When Launcher.KubernetesUseTemplates = true (now the default), any values set by using job-json-overrides functionality will be ignored.

Since templates are enabled by default for Connect's Kubernetes deployments, Connect users following these docs are directed to a mechanism that is silently ignored.

We've seen this cause some confusion in recent support tickets (https://rstudioide.zendesk.com/agent/tickets/125510, https://rstudioide.zendesk.com/agent/tickets/125515) where customers attempt to configure nodeSelector constraints for Connect using the documented job-json-overrides approach, which silently fails.

Instead this is possible in Connect via settings like launcher.templateValues.pod.nodeSelector and launcher.templateValues.pod.affinity

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 with the Helm documentation at customize.html#customize-kubernetes-jobs, especially the guidance for Workbench and Connect. Update the Connect guidance to explain that job-json-overrides is ignored when templates are enabled and document the launcher.templateValues.pod.nodeSelector and launcher.templateValues.pod.affinity settings; done means the page no longer directs Connect users to the ineffective mechanism.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.