Skip to content

Commit

Permalink
Merge pull request #1317 from inteon/new_releases_section
Browse files Browse the repository at this point in the history
Move release and upgrade notes to new "Releases" section
  • Loading branch information
jetstack-bot authored Oct 6, 2023
2 parents 847e775 + abd0be8 commit 2ff494e
Show file tree
Hide file tree
Showing 73 changed files with 343 additions and 376 deletions.
2 changes: 1 addition & 1 deletion content/docs/contributing/contributing-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ If this PR introduces a breaking change, the release note block must start with
### Cherry Picking

If the pull request contains a critical bug fix then this should be cherry picked in to the current stable cert-manager branch
and [released as a patch release](../installation/supported-releases.md#support-policy).
and [released as a patch release](../releases/README.md#support-policy).

To trigger the cherry-pick process, add a comment to the GitHub PR.
For example:
Expand Down
8 changes: 4 additions & 4 deletions content/docs/contributing/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'cert-manager contributing: Release process'
This document aims to outline the process that should be followed for
cutting a new release of cert-manager. If you would like to know more about
current releases and the timeline for future releases, take a look at the
[Supported Releases](../installation/supported-releases.md) page.
[Supported Releases](../releases/README.md) page.

## Prerequisites

Expand Down Expand Up @@ -189,7 +189,7 @@ page if a step is missing or if it is outdated.
document is ready to be merged on
[cert-manager/website](https://github.com/cert-manager/website). See for
example, see
[upgrading-1.0-1.1](https://cert-manager.io/docs/installation/upgrading/upgrading-1.0-1.1/).
[upgrading-1.0-1.1](https://cert-manager.io/docs/releases/upgrading/upgrading-1.0-1.1.md).

4. **(final + patch releases)** Prepare the Website "Release Notes" PR.

Expand Down Expand Up @@ -246,10 +246,10 @@ page if a step is missing or if it is outdated.
In that PR:
1. (**final release**) Update the section "Supported releases" in the
[supported-releases](../installation/supported-releases.md) page.
[supported-releases](../releases/README.md) page.
2. (**final release**) Update the section "How we determine supported
Kubernetes versions" on the
[supported-releases](../installation/supported-releases.md) page.
[supported-releases](../releases/README.md) page.
3. (**final release**) Bump the version that appears in
`scripts/gendocs/generate-new-import-path-docs`. For example:
Expand Down
2 changes: 1 addition & 1 deletion content/docs/installation/api-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ As in upstream Kubernetes, We don't commit to preserving alpha or beta API versi

In cert-manager v1.7 [all alpha and beta API versions prior to `v1` were removed](https://github.com/cert-manager/cert-manager/pull/4635).

NB: The Kubernetes deprecation policy notes that API removal introduces an issue with objects stored at the removed versions. To fix this, we wrote a [custom tool](https://cert-manager.io/docs/installation/upgrading/remove-deprecated-apis/) that users could run once to migrate their resources.
NB: The Kubernetes deprecation policy notes that API removal introduces an issue with objects stored at the removed versions. To fix this, we wrote a [custom tool](https://cert-manager.io/docs/releases/upgrading/remove-deprecated-apis/) that users could run once to migrate their resources.
8 changes: 4 additions & 4 deletions content/docs/installation/featureflags.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,18 @@ Generally, we find user feedback most valuable when determining if a feature is

See `--feature-gates` flags on cert-manager controller and webhook to enable any of these features.

- `AdditionalCertificateOutputFormats`. Added in cert-manager 1.7.0. Allows to specify additional formats in which cert-manager will store issued certificates and keys. See [release note](../release-notes/release-notes-1.7.md#additional-certificate-output-formats). Requires the feature to be enabled on both cert-manager controller and webhook
- `AdditionalCertificateOutputFormats`. Added in cert-manager 1.7.0. Allows to specify additional formats in which cert-manager will store issued certificates and keys. See [release note](../releases/release-notes/release-notes-1.7.md#additional-certificate-output-formats). Requires the feature to be enabled on both cert-manager controller and webhook

- `ExperimentalCertificateSigningRequestControllers`. Added in cert-manager
1.4.0. Allows to use Kubernetes
[CertificateSigningRequest](https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/)
resources with cert-manager. See [release notes](../release-notes/release-notes-1.4.md#experimental-support-for-kubernetes-certificatesigningrequests)
resources with cert-manager. See [release notes](../releases/release-notes/release-notes-1.4.md#experimental-support-for-kubernetes-certificatesigningrequests)

- `ExperimentalGatewayAPISupport`. Added in cert-manager 1.5.0. Allows to use cert-manager to automatically issue certificates for `Gateway` resources as well as use `Gateway`s and `HTTPRoute`s to solve ACME HTTP-01 challenges. See [Securing Gateway resources](../usage/gateway.md)

- `LiteralCertificateSubject`. Added in cert-manager 1.9.0. Allows to specify certificate subject in a form that can be used to define a location in LDAP directory tree. See [release notes](../release-notes/release-notes-1.9.md#literal-certificate-subjects)
- `LiteralCertificateSubject`. Added in cert-manager 1.9.0. Allows to specify certificate subject in a form that can be used to define a location in LDAP directory tree. See [release notes](../releases/release-notes/release-notes-1.9.md#literal-certificate-subjects)

- `ServerSideApply`. Added in cert-manager 1.8.0. If this feature is enabled, cert-manager uses [Server side apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) when creating or updating API resources. This will speed cert-manager operations and prevent the resource version conflict errors. See [release notes](../release-notes/release-notes-1.8.md#server-side-apply)
- `ServerSideApply`. Added in cert-manager 1.8.0. If this feature is enabled, cert-manager uses [Server side apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) when creating or updating API resources. This will speed cert-manager operations and prevent the resource version conflict errors. See [release notes](../releases/release-notes/release-notes-1.8.md#server-side-apply)

- `UseCertificateRequestBasicConstraints`. Added in cert-manager 1.12.0. Makes cert-manager add a basic constraints section to certificate signing requests with the CA constraint set to the correct value. See [`cert-manager#5552`](https://github.com/cert-manager/cert-manager/pull/5552)

Expand Down
4 changes: 2 additions & 2 deletions content/docs/installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ non-namespaced resources in your cluster and care must be taken to ensure that i
### Prerequisites

- [Install Helm version 3 or later](https://helm.sh/docs/intro/install/).
- Install a [supported version of Kubernetes or OpenShift](./supported-releases.md).
- Install a [supported version of Kubernetes or OpenShift](../releases/README.md).
- Read [Compatibility with Kubernetes Platform Providers](./compatibility.md) if you are using Kubernetes on a cloud platform.

### Steps
Expand Down Expand Up @@ -59,7 +59,7 @@ must add the `--set installCRDs=true` flag to your Helm installation command.

Uncomment the relevant line in the next steps to enable this.

Note that if you're using a `helm` version based on Kubernetes `v1.18` or below (Helm `v3.2`), `installCRDs` will not work with cert-manager `v0.16`. See the [v0.16 upgrade notes](./upgrading/upgrading-0.15-0.16.md#helm) for more details.
Note that if you're using a `helm` version based on Kubernetes `v1.18` or below (Helm `v3.2`), `installCRDs` will not work with cert-manager `v0.16`. See the [v0.16 upgrade notes](../releases/upgrading/upgrading-0.15-0.16.md#helm) for more details.

#### 4. Install cert-manager

Expand Down
4 changes: 2 additions & 2 deletions content/docs/installation/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Learn how to install cert-manager using kubectl and static manifests.

## Prerequisites

- [Install `kubectl` version `>= v1.19.0`](https://kubernetes.io/docs/tasks/tools/). (otherwise, you'll have issues updating the CRDs - see [v0.16 upgrade notes](./upgrading/upgrading-0.15-0.16.md#issue-with-older-versions-of-kubectl))
- Install a [supported version of Kubernetes or OpenShift](./supported-releases.md).
- [Install `kubectl` version `>= v1.19.0`](https://kubernetes.io/docs/tasks/tools/). (otherwise, you'll have issues updating the CRDs - see [v0.16 upgrade notes](../releases/upgrading/upgrading-0.15-0.16.md#issue-with-older-versions-of-kubectl))
- Install a [supported version of Kubernetes or OpenShift](../releases/README.md).
- Read [Compatibility with Kubernetes Platform Providers](./compatibility.md) if you are using Kubernetes on a cloud platform.

## Steps
Expand Down
2 changes: 1 addition & 1 deletion content/docs/installation/operator-lifecycle-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 'cert-manager installation: Using OLM'

### Prerequisites

- Install a [supported version of Kubernetes or OpenShift](./supported-releases.md).
- Install a [supported version of Kubernetes or OpenShift](../releases/README.md).
- Read [Compatibility with Kubernetes Platform Providers](./compatibility.md) if you are using Kubernetes on a cloud platform.

### Option 1: Installing from OperatorHub Web Console on OpenShift
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ versions, and information on things to look out for when upgrading.
> Note: Before performing upgrades of cert-manager, it is advised to take a
> backup of all your cert-manager resources just in case an issue occurs whilst
> upgrading. You can read how to backup and restore cert-manager in the [backup
> and restore](../../devops-tips/backup.md) guide.
> and restore](../devops-tips/backup.md) guide.
We recommend that you upgrade cert-manager one minor version at a time, always
choosing the latest patch version for the minor version. You should always read
Expand Down Expand Up @@ -87,7 +87,7 @@ number you want to install:
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/<version>/cert-manager.yaml
```

Once you have deployed the new version of cert-manager, you can [verify](../verify.md) the installation.
Once you have deployed the new version of cert-manager, you can [verify](verify.md) the installation.

## Reinstalling cert-manager

Expand Down Expand Up @@ -118,4 +118,4 @@ cert-manager _including the CRDs_:

- Is `--enable-certificate-owner-ref` flag currently set to true or could it have been set to true at some point previously? Due to an earlier bug, the owner reference that gets added to `Secret`s is _not_ removed when the value of `--enable-certificate-owner-ref` is changed from true to false, see [`cert-manager#4788`](https://github.com/cert-manager/cert-manager/issues/4788)
- Are there currently any certificate issuances in progress? If so, with the custom resources deleted, the progress will be lost. This could potentially cause duplicated issuances.
- Is there a need to convert cert-manager custom resource manifests to v1 API? You can use [`cmctl convert` command](../../reference/cmctl.md#convert) to do that.
- Is there a need to convert cert-manager custom resource manifests to v1 API? You can use [`cmctl convert` command](../reference/cmctl.md#convert) to do that.
Loading

0 comments on commit 2ff494e

Please sign in to comment.