Skip to content

Document the use of the HTTP01 Gateway API solver#625

Merged
jetstack-bot merged 6 commits intocert-manager:release-nextfrom
maelvls:gateway-api-documentation
Aug 11, 2021
Merged

Document the use of the HTTP01 Gateway API solver#625
jetstack-bot merged 6 commits intocert-manager:release-nextfrom
maelvls:gateway-api-documentation

Conversation

@maelvls
Copy link
Member

@maelvls maelvls commented Jun 22, 2021

@jetstack-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@jetstack-bot jetstack-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 22, 2021
@maelvls maelvls changed the base branch from master to release-next June 22, 2021 16:54
@jetstack-bot jetstack-bot added do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 22, 2021
Copy link
Contributor

@JoshVanL JoshVanL left a comment

Choose a reason for hiding this comment

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

Couple comments from me. Looks like this needs some kind of rebasing :)

@maelvls maelvls force-pushed the gateway-api-documentation branch from 6518364 to ed223e5 Compare August 4, 2021 12:30
@netlify
Copy link

netlify bot commented Aug 4, 2021

✔️ Deploy Preview for cert-manager-website ready!

🔨 Explore the source changes: eaefa68

🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/61138ab369bd5d000984f808

😎 Browse the preview: https://deploy-preview-625--cert-manager-website.netlify.app

@jetstack-bot jetstack-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 4, 2021
@maelvls maelvls force-pushed the gateway-api-documentation branch from ed223e5 to 4e5ce0f Compare August 4, 2021 17:29
@jetstack-bot jetstack-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 4, 2021
@maelvls maelvls force-pushed the gateway-api-documentation branch from 4e5ce0f to ac8e0e3 Compare August 4, 2021 17:31
maelvls added 2 commits August 5, 2021 14:50
Signed-off-by: Maël Valais <mael@vls.dev>
Signed-off-by: Maël Valais <mael@vls.dev>
@jetstack-bot jetstack-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 5, 2021
@maelvls maelvls force-pushed the gateway-api-documentation branch from ac8e0e3 to f29a49d Compare August 5, 2021 13:33
@jetstack-bot jetstack-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 5, 2021
@maelvls maelvls marked this pull request as ready for review August 5, 2021 13:34
@jetstack-bot jetstack-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 5, 2021
@maelvls maelvls force-pushed the gateway-api-documentation branch from f29a49d to 1d42ae2 Compare August 5, 2021 13:44
Signed-off-by: Maël Valais <mael@vls.dev>
@maelvls maelvls force-pushed the gateway-api-documentation branch from 1d42ae2 to a007acf Compare August 5, 2021 15:31
Signed-off-by: Maël Valais <mael@vls.dev>
@maelvls maelvls force-pushed the gateway-api-documentation branch from fd00880 to f373024 Compare August 5, 2021 15:51
This is the feature gate name that was picked in
cert-manager/cert-manager#4310.

Signed-off-by: Maël Valais <mael@vls.dev>
@maelvls
Copy link
Member Author

maelvls commented Aug 9, 2021

While writing this PR, I started writing a Getting started guide. I don't know where to publish this or whether it makes sense to publish it.

Next steps:

  • Publish one getting started guide (one the website??)

Copy link
Contributor

@JoshVanL JoshVanL left a comment

Choose a reason for hiding this comment

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

A few comments from me, but otherwise looks good.

/assign @maelvls

Comment on lines +324 to +325
solving the HTTP-01 challenge. These labels must match one of the Gateway
resources on your cluster. The matched Gateway have a listener on port 80.
Copy link
Contributor

Choose a reason for hiding this comment

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

What happens if no Gateways match?

Copy link
Member Author

Choose a reason for hiding this comment

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

I added the following note:

Note that when the labels do not match any Gateway on your cluster, cert-manager will create the temporary HTTPRoute challenge and nothing will happen.

@maelvls maelvls force-pushed the gateway-api-documentation branch 2 times, most recently from c8a6d0b to 8f5db75 Compare August 11, 2021 08:27
Signed-off-by: Maël Valais <mael@vls.dev>
Co-authored-by: JoshVanL <vleeuwenjoshua@gmail.com>
@maelvls maelvls force-pushed the gateway-api-documentation branch from 8f5db75 to eaefa68 Compare August 11, 2021 08:30
@maelvls
Copy link
Member Author

maelvls commented Aug 11, 2021

Done!
/unassign
/assign @JoshVanL

@jetstack-bot jetstack-bot assigned JoshVanL and unassigned maelvls Aug 11, 2021
Copy link
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.

Looks great @maelvls

Thanks.

/lgtm
/approve

Comment on lines +197 to +200
```sh
helm upgrade --install cert-manager jetstack/cert-manager --namespace cert-manager \
--set "extraArgs={--feature-gates=ExperimentalGatewayAPISupport=true}"
```
Copy link
Member

Choose a reason for hiding this comment

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

Random thought: If you'd previously enabled the experimental CertificateRequestSupport would this command disable that. I do not propose changing this command, but it is worth thinking about how easy it is to change extraArgs values during an upgrade.

Copy link
Member Author

@maelvls maelvls Aug 11, 2021

Choose a reason for hiding this comment

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

Good point, I wish we could instead re-use the same flag multiple times:

  helm upgrade --install cert-manager jetstack/cert-manager --namespace cert-manager \
    --set extraArgs="--feature-gates=ExperimentalGatewayAPISupport=true" \
    --set extraArgs="--feature-gates=ExperimentalCertificateRequestSupport=true"

But the only way to set arrays from the command line is to use the syntax extraArgs={...,...} 😞

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 11, 2021
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maelvls, 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

@JoshVanL JoshVanL added the cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager label Aug 11, 2021
@jetstack-bot jetstack-bot removed the do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. label Aug 11, 2021
@jetstack-bot jetstack-bot merged commit 35df077 into cert-manager:release-next Aug 11, 2021
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. cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants