Skip to content

Commit

Permalink
docs: supported version range
Browse files Browse the repository at this point in the history
To be moved to the "production ready" tier in upstream's documentation,
we need to include the versions of Kubernetes and cert-manager
supported, and link to upstream's installation docs.
  • Loading branch information
terinjokes committed Oct 2, 2024
1 parent c94a25a commit 5f3a2a0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
7 changes: 6 additions & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
Origin CA Issuer is a [[https://github.com/cert-manager/cert-manager][cert-manager]] CertificateRequest controller for Cloudflare's [[https://developers.cloudflare.com/ssl/origin-configuration/origin-ca][Origin CA]] feature.

** Getting Started
We assume you have a Kubernetes cluster (1.16 or newer) with cert-manager (1.0 or newer) installed. We also assume you have permissions to create Custom Resource Definitions.
*** Prerequisites

- Kubernetes: releases with [[https://endoflife.date/kubernetes][maintenance support]]
- cert-manager: releases under [[https://endoflife.date/cert-manager][upstream support]], which can be installed following upstream's [[https://cert-manager.io/docs/installation/][documentation]].

You must also have permissions in the Kubernetes cluster to create Custom Resource Definitions.

*** Installing Origin CA Issuer
First, we need to install the Custom Resource Definitions for the Origin CA Issuer.
Expand Down
2 changes: 1 addition & 1 deletion deploy/charts/origin-ca-issuer/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
type: application
name: origin-ca-issuer
version: 0.5.7
version: 0.5.8
appVersion: 0.9.0
description: A Helm chart for origin-ca-issuer
home: https://github.com/cloudflare/origin-ca-issuer
Expand Down
4 changes: 2 additions & 2 deletions deploy/charts/origin-ca-issuer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ origin-ca-issuer is a Kubernetes addon to automate issuance and renewals of Clou

## Prerequisites

* Kubernetes 1.16+
* cert-manager 1.0.0+
* Kubernetes releases in [maintenance support](https://endoflife.date/kubernetes)
* cert-manager releases with upstream [support](https://endoflife.date/cert-manager)

## Installing the Chart

Expand Down

0 comments on commit 5f3a2a0

Please sign in to comment.