Skip to content

Commit

Permalink
site: clarify cert-manager guide (#2708)
Browse files Browse the repository at this point in the history
Edits the cert-manager guide to remove references to ingress-shim,
which is an internal component of cert-manager, knowledge of which
is unnecessary for a Contour user. Also adds a link to the relevant
cert-manager docs.

Signed-off-by: Steve Kriss <krisss@vmware.com>
  • Loading branch information
skriss authored Jul 21, 2020
1 parent 15af9ad commit 217b06f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions site/_guides/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -603,8 +603,9 @@ $ curl https://httpbinproxy.davecheney.com/get

This method is a workaround until we can deliver the changes in [#950][10] and [#951][11].

The dummy Ingress record exists only to hold the annotations `ingress-shim` requires.
Because it does not include the `ingress-class: contour` annotation, Contour will not see it and so the configuration of the Ingress does not matter, except that it is valid enough for ingress-shim to use.
The dummy Ingress record exists only to hold the annotations that cert-manager requires in order to kick off the certification creation process.
Because it does not include the `ingress-class: contour` annotation, Contour will not see it and so the configuration of the Ingress does not matter, except that it is valid enough for cert-manager to use.
See the [cert-manager docs][12] for more information.

## Wrapping up

Expand Down Expand Up @@ -657,3 +658,4 @@ $ curl -v http://httpbin.davecheney.com/get
[9]: {% link /img/cert-manager/httpbin.png %}
[10]: {{site.github.repository_url}}/issues/950
[11]: {{site.github.repository_url}}/issues/951
[12]: https://cert-manager.io/docs/usage/ingress/

0 comments on commit 217b06f

Please sign in to comment.