Skip to content

Commit

Permalink
Prioritize and write more about Helm schemas
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Wall <[email protected]>
  • Loading branch information
wallrj committed Oct 1, 2024
1 parent f49dda2 commit f1a2240
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions content/docs/releases/release-notes/release-notes-1.16.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,37 @@ cert-manager 1.16 includes various improvements to the metrics in the cert-manag

## Breaking changes

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

## Themes

### Helm

The Helm chart now includes a JSON schema which will validate the values that you supply when installing the chart.
This will help you to get your Helm values right first time.
It will alert you to typos and unrecognized fields in your existing Helm values files.
And it will make it easier for the cert-manager maintainers to maintain the Helm chart,
avoiding typos and mistakes in the default values file.

> ⚠️ Helm schema validation may reject your existing Helm values files if they contain typos or unrecognized fields.
> You can use `helm template` to test your Helm values before you upgrade:
>
> ```bash
> helm template cert-manager \
> --repo https://charts.jetstack.io \
> --version [[VAR::cert_manager_latest_version]] \
> --values values.cert-manager.yaml
> ```
>
> ℹ️ 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.
>
> 📖 Read [Helm: Charts: Schema Files](https://helm.sh/docs/topics/charts/#schema-files) to learn more.
### Extended Metrics
The webhook and cainjector components now have metrics servers,
Expand Down Expand Up @@ -107,14 +129,6 @@ And it reduces the peak memory use of the cert-manager components when they star
because they no longer have to hold a duplicate unpaged list of resources in-memory
while they add them to the client side cache.
### Helm Schema Validation

The Helm chart now includes a JSON schema which will validate the values that you supply when installing the chart.
This will help you to get your Helm values right first time.
It will alert you to typos and unrecognized fields in your existing Helm values files.
And it will make it easier for the cert-manager maintainers to maintain the Helm chart,
avoiding typos and mistakes in the default values file.

## Community
Thanks again to all open-source contributors with commits in this release, including: TODO
Expand Down

0 comments on commit f1a2240

Please sign in to comment.