Skip to content

Commit 5cfdfda

Browse files
committed
Update warning regarding certificate private key rotation
Signed-off-by: Chris McKeown <DevOpsFu@users.noreply.github.com>
1 parent c8c2ca9 commit 5cfdfda

7 files changed

+182
-84
lines changed

linkerd.io/content/2-edge/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.14/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.15/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.16/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.17/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.18/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

linkerd.io/content/2.19/tasks/automatically-rotating-control-plane-tls-credentials.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,19 @@ EOF
243243

244244
{{< warning >}}
245245

246-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
247-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
248-
will update the validity timestamps but **not** generate a new private key.
249-
**This is definitely not as secure as rotating the private key**; we recommend
250-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
251-
managing.
246+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
247+
section is dependent on your version of cert-manager. In version 1.17 and
248+
below, the default value was `Never`. With this configuration, cert-manager
249+
**will not** actually rotate the trust anchor: instead, it will update the
250+
validity timestamps but **not** generate a new private key.
251+
**This is definitely not as secure as rotating the private key**.
252+
253+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
254+
above, be aware that this new default will change the `rotationPolicy` if you
255+
are not explicitly setting it in your Certificate resource manifest.
256+
257+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
258+
any certificate that cert-manager is managing.
252259

253260
{{< /warning >}}
254261

@@ -353,12 +360,19 @@ EOF
353360

354361
{{< warning >}}
355362

356-
If you do not set `rotationPolicy: Always` in the Certificate's `privateKey`
357-
section, cert-manager **will not** actually rotate the trust anchor: instead, it
358-
will update the validity timestamps but **not** generate a new private key.
359-
**This is definitely not as secure as rotating the private key**; we recommend
360-
always setting `rotationPolicy: Always` for any certificate that cert-manager is
361-
managing.
363+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
364+
section is dependent on your version of cert-manager. In version 1.17 and
365+
below, the default value was `Never`. With this configuration, cert-manager
366+
**will not** actually rotate the trust anchor: instead, it will update the
367+
validity timestamps but **not** generate a new private key.
368+
**This is definitely not as secure as rotating the private key**.
369+
370+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or
371+
above, be aware that this new default will change the `rotationPolicy` if you
372+
are not explicitly setting it in your Certificate resource manifest.
373+
374+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for
375+
any certificate that cert-manager is managing.
362376

363377
{{< /warning >}}
364378

0 commit comments

Comments
 (0)