PWB: Set launcher.useTemplates: true by default#653
Merged
Conversation
GCRev
reviewed
Mar 31, 2025
GCRev
approved these changes
Mar 31, 2025
Contributor
GCRev
left a comment
There was a problem hiding this comment.
LGTM and we hope people read the changelog
Contributor
Author
|
Hopefully there is enough detail |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR sets the default to
launcher.useTemplates: truein the Workbench chart. This bumps the chart a minor version to0.9.0since it could be breaking if someone is usingjob-json-overridesbecause both cannot be set simultaneously. There is a check in the helm chart that will error if bothjob-json-overridesandlauncher.useTemplates=trueare defined, this PR adds to that error to note the chart version where this default was changed.This being
falseby default is the most common root cause of customer issues we see in the field because without it many other chart defaults and examples Posit puts out will subtly not be applied (for example, session changes topip.conf,imagePullSecrets, mounting storage to sessions etc.).Historically before
launcher.templateValuesexisted settingjob-json-overrideswas the way to customize jobs and it is still what is documented in our helm chart README. This PR removes thejob-json-overrideslanguage from the README and instead instructs users to uselauncher.templateValuesto customize the job templates.Also worth noting that the Connect chart sets this default to true.