cert-manager/docs
jetstack-ci-bot 362735f8f1
Merge pull request #312 from Mikulas/pr/cert-crd-alias
Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Add default shortNames to certificates CRD

Defaults to `[cert, certs]` and is configurable with `certificateCRDShortNames` parameter.

**What this PR does / why we need it**:

Simplifies manual certificate management with kubectl.

Fixes #311

<div name="review-notes" />

**Special notes for your reviewer**:

Instead of a boolean switch do/dont include the shortNames, the value defines the aliases. This may be handy if anybody prefers `[crt, crts]` instead.

I'm not too keen on the `certificateCRDShortNames` variable name. It might be better to use `Resource` instead of `CRD` to be consistent with the `createCustomResource` var.

Other CRDs are probably ok without an alias, but other people workflows may differ. Should these also be configurable? In that case, the variables could be `shortNames: {certificates: [], …}`.

**Release note**:

```release-note
Add Certificate CRD shortnames `cert` and `certs`. This is configurable in the Helm Chart with `certificateResourceShortNames`.
```
2018-02-21 20:48:17 +00:00
..
api-types Added comments for using hostedZoneID field with route53 provider 2017-10-24 13:43:59 +02:00
deploy Merge pull request #312 from Mikulas/pr/cert-crd-alias 2018-02-21 20:48:17 +00:00
devel Add empty README in docs/devel 2017-08-29 16:25:41 +01:00
examples Added Azure DNS support for DNS01 challange 2018-02-13 10:34:06 +01:00
user-guides fix multiline command 2018-02-07 14:55:44 +03:00
high-level-overview.png Add high level overview diagram 2017-09-04 15:52:37 +01:00
README.md Add links to new documentation content 2018-01-18 17:44:05 +00:00

cert-manager documentation

This is the extended documentation page for cert-manager, containing detailed specification of API types, user guides, and developer documentation.

It is split into these three sections for easier navigation.

API types

User guides

Developer docs

Developer documentation can be found in the devel/ directory (coming soon).