Skip to content

Commit d43cd77

Browse files
committed
fix bugs in diagrams & improve titles
Signed-off-by: Tim Ramlot <[email protected]>
1 parent f212567 commit d43cd77

File tree

11 files changed

+105
-104
lines changed

11 files changed

+105
-104
lines changed

content/docs/usage/certificate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ data:
378378
...
379379
```
380380

381-
## Inner workings diagram
381+
## Inner workings diagram for developers
382382

383383
<object data="/images/request-certificate-debug/certificate-flow.svg"></object>
384384

content/docs/usage/certificaterequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,6 @@ and `bar`:
267267
resourceNames: ["myissuers.my-example.io/foo.myapp", "myissuers.my-example.io/bar.myapp"]
268268
```
269269

270-
## Inner workings diagram
270+
## Inner workings diagram for developers
271271

272272
<object data="/images/request-certificate-debug/certificate-request-flow.svg"></object>

content/docs/usage/gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ Certificate resources:
444444
configure `spec.privateKey.rotationPolicy` field to set the rotation policy of the private key for a Certificate.
445445
Valid values are `Never` and `Always`. If unset a rotation policy `Never` will be used.
446446

447-
## Inner workings diagram
447+
## Inner workings diagram for developers
448448

449449
<object data="/images/request-certificate-debug/gateway-shim-flow.svg"></object>
450450

content/docs/usage/ingress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ guide](../installation/README.md).
221221
222222
If you do not see a `Certificate` resource being created after applying the ingress-shim annotations check that at least `cert-manager.io/issuer` or `cert-manager.io/cluster-issuer` is set. If you want to use `kubernetes.io/tls-acme: "true"` make sure to have checked all steps above and you might want to look for errors in the cert-manager pod logs if not resolved.
223223
224-
## Inner workings diagram
224+
## Inner workings diagram for developers
225225
226226
<object data="/images/request-certificate-debug/ingress-shim-flow.svg"></object>
227227

content/docs/usage/kube-csr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,6 @@ are not approved by default, so you will likely need to approve it manually:
172172
$ kubectl certificate approve <name>
173173
```
174174

175-
## Inner workings diagram
175+
## Inner workings diagram for developers
176176

177177
<object data="/images/request-certificate-debug/certificate-signing-request-flow.svg"></object>

public/images/request-certificate-debug/certificate-flow.drawio

Lines changed: 75 additions & 74 deletions
Large diffs are not rendered by default.

public/images/request-certificate-debug/certificate-flow.svg

Lines changed: 1 addition & 1 deletion
Loading

public/images/request-certificate-debug/gateway-shim-flow.drawio

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
<mxfile host="app.diagrams.net" modified="2023-09-07T13:11:24.675Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36" etag="uY4319KJFZV_AFAf-Mg5" version="21.7.2" type="device">
1+
<mxfile host="app.diagrams.net" modified="2023-10-17T11:51:17.707Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36" etag="Vt1oxfD1rWP85PyAdHHE" version="22.0.4" type="device">
22
<diagram id="AW3OrBCQwjyOdo3bwChp" name="Page-1">
3-
<mxGraphModel dx="819" dy="1616" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
3+
<mxGraphModel dx="842" dy="1626" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
44
<root>
55
<mxCell id="0" />
66
<mxCell id="1" parent="0" />
77
<mxCell id="SW6BRf9NdE8UDbDrH991-26" value="kind: Issuer&lt;br&gt;metadata:&lt;br&gt;&amp;nbsp; name:&amp;nbsp;&lt;b style=&quot;border-color: var(--border-color);&quot;&gt;issuer-1&lt;/b&gt;&lt;br&gt;spec: ..." style="text;html=1;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacing=5;fillColor=#EEEEEE;" parent="1" vertex="1">
88
<mxGeometry x="474.5" y="-187.67000000000002" width="210" height="69.67" as="geometry" />
99
</mxCell>
1010
<mxCell id="SW6BRf9NdE8UDbDrH991-5" value="gateway-shim creates the Certificate &lt;b&gt;&quot;cert-1&quot;&lt;/b&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Courier New;" parent="1" vertex="1">
11-
<mxGeometry x="200" y="-20" width="210" height="30" as="geometry" />
11+
<mxGeometry x="203" y="-10" width="210" height="30" as="geometry" />
1212
</mxCell>
1313
<mxCell id="SW6BRf9NdE8UDbDrH991-16" value="" style="group;fontFamily=Courier New;" parent="1" vertex="1" connectable="0">
1414
<mxGeometry x="77.5" y="30" width="225" height="130" as="geometry" />
@@ -20,26 +20,26 @@
2020
<mxGeometry y="0.6128571428571397" width="225" height="129.38714285714286" as="geometry" />
2121
</mxCell>
2222
<mxCell id="MYaeiiRs0e1uR92Mewc--82" value="&lt;div&gt;&lt;font&gt;DOES NOT EXIST YET&lt;/font&gt;&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Courier New;fontColor=#757575;" parent="1" vertex="1">
23-
<mxGeometry x="474.5" y="-90" width="75" height="40" as="geometry" />
23+
<mxGeometry x="474.5" y="-85" width="75" height="40" as="geometry" />
2424
</mxCell>
2525
<mxCell id="MYaeiiRs0e1uR92Mewc--84" value="CERT-MANAGER ISSUER" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=middle;whiteSpace=wrap;rounded=0;dashed=1;fontColor=#757575;fontFamily=Courier New;" parent="1" vertex="1">
2626
<mxGeometry x="474.5" y="-207.67" width="140" height="20" as="geometry" />
2727
</mxCell>
2828
<mxCell id="gfwWATJFP_jRYh0Kxk0O-1" value="" style="group;fontFamily=Courier New;" parent="1" vertex="1" connectable="0">
29-
<mxGeometry x="72.5" y="-240" width="347.5" height="210" as="geometry" />
29+
<mxGeometry x="72.5" y="-240" width="347.5" height="220" as="geometry" />
3030
</mxCell>
3131
<mxCell id="gfwWATJFP_jRYh0Kxk0O-2" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;fontFamily=Courier New;" parent="gfwWATJFP_jRYh0Kxk0O-1" vertex="1">
32-
<mxGeometry width="345.4437869822485" height="210" as="geometry" />
32+
<mxGeometry width="345.4437869822485" height="220" as="geometry" />
3333
</mxCell>
34-
<mxCell id="gfwWATJFP_jRYh0Kxk0O-3" value="&lt;div&gt;apiVersion: gateway.networking.k8s.io/v1alpha2&lt;/div&gt;kind: Gateway&lt;br&gt;metadata:&lt;br&gt;&amp;nbsp; name: gateway-1&lt;br&gt;&amp;nbsp; annotations:&lt;br&gt;&amp;nbsp; &amp;nbsp;&amp;nbsp;cert-manager.io/issuer: issuer-1&lt;br&gt;&lt;div&gt;spec:&lt;/div&gt;&lt;div&gt;&amp;nbsp; listeners:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; -&amp;nbsp;&lt;span style=&quot;background-color: initial;&quot;&gt;hostname: example.com&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; tls:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; mode: Terminate&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; certificateRefs:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; - name: cert-1&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacing=5;" parent="gfwWATJFP_jRYh0Kxk0O-1" vertex="1">
35-
<mxGeometry width="345.4437869822485" height="210" as="geometry" />
34+
<mxCell id="gfwWATJFP_jRYh0Kxk0O-3" value="&lt;div&gt;apiVersion: gateway.networking.k8s.io/v1alpha2&lt;/div&gt;kind: Gateway&lt;br&gt;metadata:&lt;br&gt;&amp;nbsp; name: gateway-1&lt;br&gt;&amp;nbsp; annotations:&lt;br&gt;&amp;nbsp; &amp;nbsp;&amp;nbsp;cert-manager.io/issuer: issuer-1&lt;br&gt;&lt;div&gt;spec:&lt;/div&gt;&lt;div&gt;&amp;nbsp; listeners:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; -&amp;nbsp;&lt;span style=&quot;background-color: initial;&quot;&gt;hostname: example.com&lt;/span&gt;&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; tls:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; mode: Terminate&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; certificateRefs:&lt;/div&gt;&lt;div&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; -&amp;nbsp;kind: Secret&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; name: cert-1&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacing=5;" parent="gfwWATJFP_jRYh0Kxk0O-1" vertex="1">
35+
<mxGeometry width="345.4437869822485" height="220" as="geometry" />
3636
</mxCell>
3737
<mxCell id="MYaeiiRs0e1uR92Mewc--83" value="" style="endArrow=none;html=1;dashed=1;startArrow=classic;startFill=1;fontColor=#757575;strokeColor=#B3B3B3;fontFamily=Courier New;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" parent="gfwWATJFP_jRYh0Kxk0O-1" source="MYaeiiRs0e1uR92Mewc--82" edge="1">
3838
<mxGeometry width="50" height="50" relative="1" as="geometry">
39-
<mxPoint x="206.61801801801784" y="223.875" as="sourcePoint" />
40-
<mxPoint x="185.5" y="190" as="targetPoint" />
39+
<mxPoint x="206.61801801801784" y="239.5357142857143" as="sourcePoint" />
40+
<mxPoint x="185.5" y="204.04761904761907" as="targetPoint" />
4141
<Array as="points">
42-
<mxPoint x="365.5" y="190" />
42+
<mxPoint x="365.5" y="204.04761904761907" />
4343
</Array>
4444
</mxGeometry>
4545
</mxCell>
@@ -51,10 +51,10 @@
5151
<mxCell id="gfwWATJFP_jRYh0Kxk0O-4" value="user creates a Gateway&amp;nbsp;&lt;b&gt;&quot;gateway-1&quot;&lt;/b&gt; with cert-manager annotations" style="text;html=1;strokeColor=none;fillColor=none;align=left;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Courier New;" parent="1" vertex="1">
5252
<mxGeometry x="173.58999999999997" y="-300" width="190.47" height="45.78" as="geometry" />
5353
</mxCell>
54-
<mxCell id="ZZ92xPVQZ7XZ2kMUYkGM-2" value="" style="endArrow=classic;html=1;fontFamily=Courier New;dashed=1;edgeStyle=elbowEdgeStyle;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" target="SW6BRf9NdE8UDbDrH991-26" edge="1">
54+
<mxCell id="ZZ92xPVQZ7XZ2kMUYkGM-2" value="" style="endArrow=classic;html=1;fontFamily=Courier New;dashed=1;edgeStyle=elbowEdgeStyle;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" edge="1">
5555
<mxGeometry width="50" height="50" relative="1" as="geometry">
56-
<mxPoint x="342" y="-153" as="sourcePoint" />
57-
<mxPoint x="632" y="-153" as="targetPoint" />
56+
<mxPoint x="342" y="-151" as="sourcePoint" />
57+
<mxPoint x="474.5" y="-150.83500000000026" as="targetPoint" />
5858
</mxGeometry>
5959
</mxCell>
6060
<mxCell id="gfwWATJFP_jRYh0Kxk0O-10" value="kind: Secret&lt;br&gt;metadata:&lt;br&gt;&amp;nbsp; name:&amp;nbsp;&lt;b style=&quot;border-color: var(--border-color);&quot;&gt;cert&lt;/b&gt;&lt;b&gt;-1&lt;/b&gt;&lt;br&gt;stringData:&lt;br&gt;&amp;nbsp; tls.crt: |&lt;br&gt;&lt;b&gt;&amp;nbsp; &amp;nbsp; -----BEGIN CERTIFICATE-----&lt;br&gt;&amp;nbsp; &amp;nbsp; (leaf)&lt;br&gt;&amp;nbsp; &amp;nbsp; -----END CERTIFICATE-----&lt;br&gt;&lt;/b&gt;&lt;b&gt;&amp;nbsp; &amp;nbsp; -----BEGIN CERTIFICATE-----&lt;br&gt;&amp;nbsp; &amp;nbsp; (intermediate)&lt;br&gt;&amp;nbsp; &amp;nbsp; -----END CERTIFICATE-----&lt;/b&gt;&lt;br&gt;&amp;nbsp; tls.key: |&lt;br&gt;&amp;nbsp; &lt;b&gt;&amp;nbsp;&amp;nbsp;&lt;span&gt;-----BEGIN PRIVATE KEY-----&lt;br&gt;&amp;nbsp; &amp;nbsp; AaBbCcDd0&lt;br&gt;&lt;/span&gt;&lt;/b&gt;&lt;div&gt;&lt;b&gt;&amp;nbsp; &amp;nbsp; -----END PRIVATE KEY-----&lt;/b&gt;&lt;/div&gt;" style="text;html=1;strokeColor=#b85450;fillColor=#f8cecc;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacingTop=0;spacingBottom=0;spacing=5;" parent="1" vertex="1">
@@ -66,8 +66,8 @@
6666
<mxPoint x="810" y="160" as="targetPoint" />
6767
</mxGeometry>
6868
</mxCell>
69-
<mxCell id="gfwWATJFP_jRYh0Kxk0O-12" value="kind: Certificate&lt;br&gt;spec:&lt;br&gt;&amp;nbsp; issuerRef:&amp;nbsp;&lt;b style=&quot;border-color: var(--border-color);&quot;&gt;issuer-1&lt;/b&gt;&lt;br&gt;&amp;nbsp; secretName:&amp;nbsp;&lt;b style=&quot;border-color: var(--border-color);&quot;&gt;cert&lt;/b&gt;-1&lt;br&gt;status:&lt;br&gt;&amp;nbsp; revision: 1&lt;br&gt;&amp;nbsp; conditions:&lt;br&gt;&amp;nbsp; &amp;nbsp; - type: &lt;b&gt;Ready&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; status: &lt;b&gt;&quot;True&quot;&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; reason: &lt;b&gt;Issued&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; - type: Issuing&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; status: &quot;True&quot;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; reason: Pending&lt;br&gt;&amp;nbsp; certificate: |&lt;b&gt;&lt;br&gt;&lt;/b&gt;&amp;nbsp; &amp;nbsp; -----BEGIN CERTIFICATE-----&lt;br&gt;&amp;nbsp; &amp;nbsp; (leaf)&lt;br&gt;&amp;nbsp; &amp;nbsp; -----END CERTIFICATE-----&lt;br&gt;&amp;nbsp; &amp;nbsp; -----BEGIN CERTIFICATE-----&lt;br&gt;&amp;nbsp; &amp;nbsp; (intermediate)&lt;br&gt;&amp;nbsp; &amp;nbsp; -----END CERTIFICATE-----&lt;b&gt;&lt;br&gt;&lt;/b&gt;" style="text;html=1;strokeColor=#82b366;fillColor=#d5e8d4;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacingTop=0;spacingBottom=0;spacing=5;" parent="1" vertex="1">
70-
<mxGeometry x="77.5" y="337" width="234.87" height="303" as="geometry" />
69+
<mxCell id="gfwWATJFP_jRYh0Kxk0O-12" value="kind: Certificate&lt;br&gt;spec:&lt;br&gt;&amp;nbsp; issuerRef:&amp;nbsp;&lt;b style=&quot;border-color: var(--border-color);&quot;&gt;issuer-1&lt;/b&gt;&lt;br&gt;&amp;nbsp; secretName:&amp;nbsp;&lt;b&gt;&lt;span style=&quot;border-color: var(--border-color);&quot;&gt;cert&lt;/span&gt;-1&lt;/b&gt;&lt;br&gt;status:&lt;br&gt;&amp;nbsp; revision: 1&lt;br&gt;&amp;nbsp; conditions:&lt;br&gt;&amp;nbsp; &amp;nbsp; - type: &lt;b&gt;Ready&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; status: &lt;b&gt;&quot;True&quot;&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; reason: &lt;b&gt;Issued&lt;/b&gt;&lt;br&gt;&amp;nbsp; &amp;nbsp; - type: Issuing&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; status: &quot;False&quot;&lt;br&gt;&amp;nbsp; &amp;nbsp; &amp;nbsp; reason: Issued&lt;b&gt;&lt;br&gt;&lt;/b&gt;" style="text;html=1;strokeColor=#82b366;fillColor=#d5e8d4;align=left;verticalAlign=top;whiteSpace=wrap;rounded=0;fontFamily=Courier New;spacingTop=0;spacingBottom=0;spacing=5;" parent="1" vertex="1">
70+
<mxGeometry x="77.5" y="337" width="234.87" height="203" as="geometry" />
7171
</mxCell>
7272
<mxCell id="gfwWATJFP_jRYh0Kxk0O-16" value="" style="endArrow=none;html=1;fontFamily=Courier New;fontColor=#757575;strokeColor=#000000;endFill=0;startArrow=classic;startFill=1;" parent="1" target="SW6BRf9NdE8UDbDrH991-2" edge="1">
7373
<mxGeometry width="50" height="50" relative="1" as="geometry">
@@ -97,7 +97,7 @@
9797
</mxCell>
9898
</UserObject>
9999
<UserObject label="" link="/docs/usage/certificate/" linkTarget="_blank" id="G6DhhnYIuvKHuKb8DNrd-2">
100-
<mxCell style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=data:image/svg+xml,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0OCA0OCIgaGVpZ2h0PSI0OCIgd2lkdGg9IjQ4Ij48cGF0aCBkPSJNMzggMzhIMTBWMTBoMTRWNkgxMGMtMi4yMSAwLTQgMS43OS00IDR2MjhjMCAyLjIxIDEuNzkgNCA0IDRoMjhjMi4yMSAwIDQtMS43OSA0LTRWMjRoLTR2MTR6TTI4IDZ2NGg3LjE3TDE1LjUxIDI5LjY2bDIuODMgMi44M0wzOCAxMi44M1YyMGg0VjZIMjh6IiBmaWxsPSIjRkZGRiIvPjwvc3ZnPg==;" vertex="1" parent="1">
100+
<mxCell style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=data:image/svg+xml,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0OCA0OCIgaGVpZ2h0PSI0OCIgd2lkdGg9IjQ4Ij48cGF0aCBkPSJNMzggMzhIMTBWMTBoMTRWNkgxMGMtMi4yMSAwLTQgMS43OS00IDR2MjhjMCAyLjIxIDEuNzkgNCA0IDRoMjhjMi4yMSAwIDQtMS43OSA0LTRWMjRoLTR2MTR6TTI4IDZ2NGg3LjE3TDE1LjUxIDI5LjY2bDIuODMgMi44M0wzOCAxMi44M1YyMGg0VjZIMjh6IiBmaWxsPSIjRkZGRiIvPjwvc3ZnPg==;" parent="1" vertex="1">
101101
<mxGeometry x="385.5" y="204" width="27.5" height="27.5" as="geometry" />
102102
</mxCell>
103103
</UserObject>

0 commit comments

Comments
 (0)