Skip to content

Commit

Permalink
Merge pull request #982 from wallrj/gsod-2022-audience-definitions
Browse files Browse the repository at this point in the history
[GSOD] Define our audiences
  • Loading branch information
jetstack-bot committed Jun 9, 2023
2 parents 4ed765a + e2d380d commit 8ebb188
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
1 change: 1 addition & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ PEM
PKCS#12
PKCS#8
Pomerium
PostgreSQL
PowerShell
Prometheus
P-521
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,60 @@ We would like them to quickly and easily find the information they need.

By making it easier for each group to find the information they need we aim to reduce the number of support queries.

## Audiences

### New User

Has never used cert-manager and may never have used Kubernetes.
Wants to find out what cert-manager can offer.
May have heard about cert-manager in another tutorial.
May want to know what are the alternatives to cert-manager and the trade offs.
Needs to install cert-manager quickly so that they evaluate it on their laptop.
Needs to learn basic configuration of cert-manager.
Needs to understand what are the next steps.

### Ongoing User

A programmer who wants to deploy a TLS protected APP.
Knows that cert-manager has been installed by their cluster administrator.
Has an existing Issuer or ClusterIssuer.
Needs to know how to create a Certificate which is appropriate for their application. E.g.
* Create a certificate for their PostgreSQL database
* Create an certificate for their Ingress / Gateway
Needs to know how to debug why their certificate hasn’t renewed
Needs to understand the error messages on cert-manager Certificates and Certificate requests
Needs to know which errors they can fix and which errors require assistance from their cluster administrator.

### Cluster Administrator

Knows Kubernetes.
Has a long running cert-manager installation.
Wants to know how to configure it and upgrade it for optimum performance.
Wants to optimize for large numbers of certificates.
Wants to upgrade from older versions.
Wants to monitor cert-manager performance
Wants to set up alerts to notify them when cert-manager goes wrong.
May want to configure cert-manager for multiple cloud providers.
May want to get cert-manager working with some other cluster scoped system like Istio or Knative.

### Integrator

May want to allow cert-manager users to make use of a custom Certificate service.
May want to integrate cert-manager with a DNS API for ACME DNS01.
May want to depend on cert-manager for managing TLS certificates for a higher level system.
Needs to learn how to write plugins / extensions for cert-manager.
Needs links to state-of-the-art examples of plugins and extensions.

### New Contributor

Wants to report a bug in cert-manager.
Wants to fix a bug in cert-manager.
Wants to suggest a feature for cert-manager.
Wants to implement a feature for cert-manager.
Needs to learn how to navigate the cert-manager code.
Learn cert-manager coding standards and house style.
Needs to know how to run the tests for cert-manager.

## Scope

The scope of this project is as follows:
Expand Down

0 comments on commit 8ebb188

Please sign in to comment.