Skip to content

Commit 9e5a8c8

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

7 files changed

+126
-84
lines changed

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,15 @@ 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+
**cert-manager version 1.17 and below**
247+
248+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
249+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
250+
**This is definitely not as secure as rotating the private key**.
251+
252+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
253+
254+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
252255

253256
{{< /warning >}}
254257

@@ -353,12 +356,15 @@ EOF
353356

354357
{{< warning >}}
355358

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.
359+
**cert-manager version 1.17 and below**
360+
361+
The default value of the `rotationPolicy` in the Certificate's `privateKey`
362+
section is dependent on your version of cert-manager. In version 1.17 and below, the default value was `Never`. With this configuration, cert-manager **will not** actually rotate the trust anchor: instead, it will update the validity timestamps but **not** generate a new private key.
363+
**This is definitely not as secure as rotating the private key**.
364+
365+
If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest.
366+
367+
To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any certificate that cert-manager is managing.
362368

363369
{{< /warning >}}
364370

0 commit comments

Comments
 (0)