Merge pull request #2145 from munnerz/011-release-notes
Add v0.11 draft release notes
This commit is contained in:
commit
1a12c5d99c
96
design/release-notes/release-0.11/draft-release-notes.md
Normal file
96
design/release-notes/release-0.11/draft-release-notes.md
Normal file
@ -0,0 +1,96 @@
|
||||
The v0.11 release is a significant milestone for the cert-manager project, and
|
||||
is full of new features.
|
||||
We are making a number of changes to our CRDs in a backwards incompatible way,
|
||||
in preparation for moving into `v1beta1` and eventually `v1` in the coming
|
||||
releases:
|
||||
|
||||
* Renaming our API group from `certmanager.k8s.io` to `cert-manager.io`
|
||||
* Bumping the API version from v1alpha1 to v1alpha2
|
||||
* Removing fields deprecated in v0.8 (`certificate.spec.acme`,
|
||||
`issuer.spec.http01` and `issuer.spec.dns01`)
|
||||
* Renaming annotation prefixes on Ingress & cert-manager resources to use the
|
||||
new `cert-manager.io` prefix, and in some cases `acme.cert-manager.io`
|
||||
* Using the `status` subresource for submitting status updates to the API,
|
||||
first introduced in Kubernetes 1.9.
|
||||
* Tightening use of common name vs DNS name with ACME certificates
|
||||
|
||||
We have also switched to using the new [CertificateRequest] based Certificate
|
||||
issuance implementation, first introduced in alpha in cert-manager v0.9.
|
||||
|
||||
These changes enable exciting new integrations points in cert-manager, enabling
|
||||
new things like:
|
||||
|
||||
* External issuer types, such as the [Smallstep Step Issuer]
|
||||
* Deeper integrations into Kubernetes, with an experimental [CSI driver] that
|
||||
can be used to automatically mount signed certificates into pods
|
||||
* Experimental integration with Istio, allowing you to utilise any of
|
||||
cert-manager's configured issuer types/CAs with the [node agent]
|
||||
* Retrieving certificates without giving cert-manager access to your private
|
||||
keys
|
||||
|
||||
This is a really exciting time for cert-manager, as these changes have been
|
||||
made possible by refining our past decisions around API types, and they will
|
||||
enable us to push ahead with many new features in the project.
|
||||
|
||||
## Important information
|
||||
|
||||
With all of these great changes, there is also work to do.
|
||||
|
||||
The changes to our CRD resources mean that upgrading requires more manual
|
||||
intervention that in previous releases.
|
||||
|
||||
It's recommended that you backup and completely uninstall cert-manager before
|
||||
re-installing the v0.11 release.
|
||||
|
||||
You will also need to manually update all your backed up cert-manager resource
|
||||
types to use the new `apiVersion` setting.
|
||||
|
||||
A table of resources and their old and new `apiVersion`s:
|
||||
|
||||
| Kind | Old apiVersion | New apiVersion |
|
||||
|--------------------|-------------------------------|---------------------------------|
|
||||
| Certificate | `certmanager.k8s.io/v1alpha1` | `cert-manager.io/v1alpha2` |
|
||||
| Issuer | `certmanager.k8s.io/v1alpha1` | `cert-manager.io/v1alpha2` |
|
||||
| ClusterIssuer | `certmanager.k8s.io/v1alpha1` | `cert-manager.io/v1alpha2` |
|
||||
| Order | `certmanager.k8s.io/v1alpha1` | `acme.cert-manager.io/v1alpha2` |
|
||||
| Challenge | `certmanager.k8s.io/v1alpha1` | `acme.cert-manager.io/v1alpha2` |
|
||||
| CertificateRequest | `certmanager.k8s.io/v1alpha1` | `acme.cert-manager.io/v1alpha2` |
|
||||
|
||||
You must also make sure to update all references to cert-manager in annotations to their
|
||||
new prefix:
|
||||
|
||||
| Annotation | Affected resources | New annotation |
|
||||
|------------|--------------------|----------------|
|
||||
|
||||
## Contributors
|
||||
|
||||
This release has seen code contributions from a number of people in the
|
||||
community :tada:
|
||||
|
||||
TODO: add list
|
||||
|
||||
As always, a big thank you to those opening issues, replying to issues and
|
||||
helping out in the Slack channel. As well as working in other projects to help
|
||||
users secure services running on Kubernetes.
|
||||
|
||||
## Action required
|
||||
|
||||
## Notable changes
|
||||
|
||||
### Renamed API group
|
||||
|
||||
### Release v1alpha2
|
||||
|
||||
### Deprecated old config fields
|
||||
|
||||
### New CertificateRequest resource type
|
||||
|
||||
### Support for out-of-tree issuer types
|
||||
|
||||
### New fields on Certificate resources
|
||||
|
||||
### Improved ACME Order controller design
|
||||
|
||||
### No longer generating 'temporary certificates' by default
|
||||
|
||||
## Changelog
|
||||
Loading…
Reference in New Issue
Block a user