Skip to content

Update helm README file#5276

Merged
jetstack-bot merged 3 commits intocert-manager:masterfrom
joebowbeer:helm-readme
Jul 8, 2022
Merged

Update helm README file#5276
jetstack-bot merged 3 commits intocert-manager:masterfrom
joebowbeer:helm-readme

Conversation

@joebowbeer
Copy link
Copy Markdown
Contributor

@joebowbeer joebowbeer commented Jul 7, 2022 •
edited
Loading

Pull Request Motivation

Update securityContext descriptions in the helm README. (Follow-up to #5259)

Default security context values are documented in a new section.

Bumped minimum Kubernetes version to 1.20+ as per cert-manager release 1.9. The securityContext defaults require Kubernetes 1.19+

Kind

/kind cleanup

Release Note

NONE

@joebowbeer
Update helm README file
db4fd28 
Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>

Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
@jetstack-bot jetstack-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 7, 2022
@jetstack-bot
Copy link
Copy Markdown
Contributor

jetstack-bot commented Jul 7, 2022

Hi @joebowbeer. Thanks for your PR.

I'm waiting for a cert-manager member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jetstack-bot jetstack-bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. area/deploy Indicates a PR modifies deployment configuration labels Jul 7, 2022
@joebowbeer joebowbeer mentioned this pull request Jul 7, 2022
Merged
wallrj
wallrj requested changes Jul 7, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Thanks @joebowbeer

I can see that it's not feasible to add the new default security context structures to the defaults column (it would be unreadable).

But what if the table cell said

Refer to [Default Security Contexts][#DefaultSecurityContext]

And then we add that section at the bottom of the README. How would that look?

I think we need to say something about the new defaults.

@joebowbeer
Copy link
Copy Markdown
Contributor Author

joebowbeer commented Jul 7, 2022

@wallrj wrote:

I think we need to say something about the new defaults.

OK. I'll try to apply your suggestion.

@joebowbeer
refer to Default Security Contexts
2a56934 
Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
@jetstack-bot jetstack-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 7, 2022
@joebowbeer joebowbeer requested a review from wallrj July 7, 2022 22:17
@joebowbeer
Copy link
Copy Markdown
Contributor Author

joebowbeer commented Jul 7, 2022

@wallrj PTAL

@joebowbeer
Kubernetes 1.20+
455001e 
Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>

Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
wallrj
wallrj approved these changes Jul 8, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Thanks @joebowbeer

I viewed the rendered README.md file in GitHub and the links to the footnote work well.

/approve
/ok-to-test
/lgtm
/kind documentation

deploy/charts/cert-manager/README.template.md
## Prerequisites

- Kubernetes 1.18+
- Kubernetes 1.20+
Copy link
Copy Markdown
Member

@wallrj wallrj Jul 8, 2022

Choose a reason for hiding this comment

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

Note to self: Update the Helm kubeVersion field to 1.20.0-0, the minimum supported version since cert-manager 1.9

cert-manager/deploy/charts/cert-manager/Chart.template.yaml

Line 6 in 300e106

kubeVersion: ">= 1.19.0-0"

@jetstack-bot jetstack-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 8, 2022
@jetstack-bot jetstack-bot added ok-to-test lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 8, 2022
@jetstack-bot
Copy link
Copy Markdown
Contributor

jetstack-bot commented Jul 8, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: joebowbeer, wallrj

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

The pull request process is described here

Details 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

@jetstack-bot jetstack-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2022
@wallrj wallrj mentioned this pull request Jul 8, 2022
Closed
@jetstack-bot jetstack-bot merged commit d8c57e1 into cert-manager:master Jul 8, 2022
@jetstack-bot jetstack-bot added this to the v1.9 milestone Jul 8, 2022
@joebowbeer joebowbeer deleted the helm-readme branch July 8, 2022 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wallrj wallrj wallrj approved these changes

Assignees

@wallrj wallrj

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/deploy Indicates a PR modifies deployment configuration dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. ok-to-test release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

v1.9

Development

Successfully merging this pull request may close these issues.

3 participants

@joebowbeer @jetstack-bot @wallrj