Skip to content

Commit ef02ee5

Browse files
committed
Prioritize and write more about Helm schemas
Signed-off-by: Richard Wall <richard.wall@venafi.com>
1 parent f49dda2 commit ef02ee5

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

content/docs/releases/release-notes/release-notes-1.16.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,31 @@ cert-manager 1.16 includes various improvements to the metrics in the cert-manag
77

88
## Breaking changes
99

10+
1. Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields.
11+
For more details, refer to the [Helm](#helm) section below.
1012
1. Venafi Issuer may fail to renew certificates if the requested duration conflicts with the CA’s minimum or maximum policy settings in Venafi.
1113
For more details, refer to the [Venafi Issuer](#venafi-issuer) section below.
1214
1. Venafi Issuer may fail to renew Certificates if the issuer has been configured for TPP with username-password authentication.
1315
For more details, refer to the [Venafi Issuer](#venafi-issuer) section below.
14-
1. Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields.
15-
For more details, refer to the [Helm](#helm) section below.
1616

1717
## Themes
1818

19+
### Helm
20+
21+
The Helm chart now includes a JSON schema which will validate the values that you supply when installing the chart.
22+
This will help you to get your Helm values right first time.
23+
It will alert you to typos and unrecognized fields in your existing Helm values files.
24+
And it will make it easier for the cert-manager maintainers to maintain the Helm chart,
25+
avoiding typos and mistakes in the default values file.
26+
27+
> ⚠️ Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields.
28+
> You can use `helm template cert-manager --repo https://charts.jetstack.io --version 1.16.x --values values.cert-manager.yaml`
29+
> to test your Helm values before you upgrade.
30+
>
31+
> ℹ️ The schema files are generated by [helm-tool](https://github.com/cert-manager/helm-tool), a utility which generates Helm docs, schema files and performs linting.
32+
>
33+
> 📖 Read [Helm: Charts: Schema Files](https://helm.sh/docs/topics/charts/#schema-files) to learn more.
34+
1935
### Extended Metrics
2036

2137
The webhook and cainjector components now have metrics servers,
@@ -107,14 +123,6 @@ And it reduces the peak memory use of the cert-manager components when they star
107123
because they no longer have to hold a duplicate unpaged list of resources in-memory
108124
while they add them to the client side cache.
109125

110-
### Helm Schema Validation
111-
112-
The Helm chart now includes a JSON schema which will validate the values that you supply when installing the chart.
113-
This will help you to get your Helm values right first time.
114-
It will alert you to typos and unrecognized fields in your existing Helm values files.
115-
And it will make it easier for the cert-manager maintainers to maintain the Helm chart,
116-
avoiding typos and mistakes in the default values file.
117-
118126
## Community
119127

120128
Thanks again to all open-source contributors with commits in this release, including: TODO

0 commit comments

Comments
 (0)