Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extraEnvConfigMaps and document some values #3691

Merged
merged 1 commit into from
Nov 24, 2020

Conversation

avorima
Copy link
Contributor

@avorima avorima commented Nov 13, 2020

There already is envFromSecret and extraEnvSecrets, so I made envFromConfigMap behave like envFromSecret and added extraEnvConfigMaps to replace it.

This pattern should make the intended use of the values clearer.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 13, 2020
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 13, 2020
@avorima
Copy link
Contributor Author

avorima commented Nov 13, 2020

@gjtempleton I'm unsure what version increase to use, since this "only" is a breaking change for people who use the undocumented envFromConfigMap.

Copy link
Member

@gjtempleton gjtempleton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for the PR!

Good point about the versioning and breaking of the existing functionality being undocumented.

I've already raised #3679 bumping the major version from 1.X to 9.X and I think this change is best included at the same time as also potentially breaking functionality. If you could add an entry to the Readme via the .gotmpl file to highlight the change happening and how users can maintain their existing behaviour I think that's the best approach. I've also got one quick nitpick.

- secretRef:
name: {{ .Values.envFromSecret }}
{{- else if .Values.envFromConfigMap }}
Copy link
Member

@gjtempleton gjtempleton Nov 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this to be an else if? Could a user not conceivably want to define both envFromSecret and envFromConfigMap?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Allowing both is better, you're right. I'll change it.

@avorima avorima force-pushed the document-extra-envs branch from bc41d42 to e46e3e2 Compare November 16, 2020 11:03
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 16, 2020
@avorima avorima force-pushed the document-extra-envs branch from e46e3e2 to 0fb17f4 Compare November 17, 2020 18:30
@avorima avorima requested a review from gjtempleton November 18, 2020 18:26
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 23, 2020
@avorima avorima force-pushed the document-extra-envs branch from 0fb17f4 to d183b2a Compare November 23, 2020 20:08
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 23, 2020
There already is `envFromSecret` and `extraEnvSecrets`, so I made
`envFromConfigMap` behave like `envFromSecret` and added
`extraEnvConfigMaps` to replace it.

This pattern should make the intended use of the values clearer.
@avorima avorima force-pushed the document-extra-envs branch from d183b2a to 0364768 Compare November 23, 2020 20:20
@avorima
Copy link
Contributor Author

avorima commented Nov 23, 2020

@gjtempleton I've added a short migration guide, but I still felt like this change should at least be a minor version increase. WDYT?

@gjtempleton
Copy link
Member

@avorima Agreed on the minor release, thanks for the rebase.

Sorry, I should have got this merged last week before the 9.0.0 release.

@gjtempleton
Copy link
Member

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 24, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avorima, gjtempleton

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 24, 2020
@k8s-ci-robot k8s-ci-robot merged commit ec2709e into kubernetes:master Nov 24, 2020
@avorima avorima deleted the document-extra-envs branch November 24, 2020 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants