Merge pull request #1244 from ctrought/subject-annotations-docs

document new subject ingress/gateway annotations

Author: jetstack-bot

content/docs/usage/gateway.md

@@ -369,6 +369,42 @@ Certificate resources:
 - `cert-manager.io/common-name`: (optional) this annotation allows you to
   configure `spec.commonName` for the Certificate to be generated.
 
+- `cert-manager.io/email-sans`: (optional) this annotation allows you to
+  configure `spec.emailAddresses` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "[email protected],[email protected]"
+
+- `cert-manager.io/subject-organizations`: (optional) this annotation allows you to
+  configure `spec.subject.organizations` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Company 1,Company 2"
+
+- `cert-manager.io/subject-organizationalunits`: (optional) this annotation allows you to
+  configure `spec.subject.organizationalUnits` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "IT Services,Cloud Services"
+
+- `cert-manager.io/subject-countries`: (optional) this annotation allows you to
+  configure `spec.subject.countries` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Country 1,Country 2"
+
+- `cert-manager.io/subject-provinces`: (optional) this annotation allows you to
+  configure `spec.subject.provinces` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Province 1,Province 2"
+
+- `cert-manager.io/subject-localities`: (optional) this annotation allows you to
+  configure `spec.subject.localities` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "City 1,City 2"
+
+- `cert-manager.io/subject-postalcodes`: (optional) this annotation allows you to
+  configure `spec.subject.postalCodes` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "123ABC,456DEF"
+
+- `cert-manager.io/subject-streetaddresses`: (optional) this annotation allows you to
+  configure `spec.subject.streetAddresses` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "123 Example St,456 Other Blvd"
+
+- `cert-manager.io/subject-serialnumber`: (optional) this annotation allows you to
+  configure `spec.subject.serialNumber` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "10978342379280287615,1111144445555522228888"
+
 - ` cert-manager.io/duration`: (optional) this annotation allows you to
   configure `spec.duration` field for the Certificate to be generated.
 

content/docs/usage/ingress.md

@@ -102,6 +102,42 @@ trigger Certificate resources to be automatically created:
 - `cert-manager.io/common-name`: (optional) this annotation allows you to
   configure `spec.commonName` for the Certificate to be generated.
 
+- `cert-manager.io/email-sans`: (optional) this annotation allows you to
+  configure `spec.emailAddresses` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "[email protected],[email protected]"
+
+- `cert-manager.io/subject-organizations`: (optional) this annotation allows you to
+  configure `spec.subject.organizations` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Company 1,Company 2"
+
+- `cert-manager.io/subject-organizationalunits`: (optional) this annotation allows you to
+  configure `spec.subject.organizationalUnits` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "IT Services,Cloud Services"
+
+- `cert-manager.io/subject-countries`: (optional) this annotation allows you to
+  configure `spec.subject.countries` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Country 1,Country 2"
+
+- `cert-manager.io/subject-provinces`: (optional) this annotation allows you to
+  configure `spec.subject.provinces` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "Province 1,Province 2"
+
+- `cert-manager.io/subject-localities`: (optional) this annotation allows you to
+  configure `spec.subject.localities` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "City 1,City 2"
+
+- `cert-manager.io/subject-postalcodes`: (optional) this annotation allows you to
+  configure `spec.subject.postalCodes` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "123ABC,456DEF"
+
+- `cert-manager.io/subject-streetaddresses`: (optional) this annotation allows you to
+  configure `spec.subject.streetAddresses` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "123 Example St,456 Other Blvd"
+
+- `cert-manager.io/subject-serialnumber`: (optional) this annotation allows you to
+  configure `spec.subject.serialNumber` field for the Certificate to be generated.
+  Supports comma-separated values e.g. "10978342379280287615,1111144445555522228888"
+
 - ` cert-manager.io/duration`: (optional) this annotation allows you to
   configure `spec.duration` field for the Certificate to be generated.
 
@@ -172,4 +208,4 @@ guide](../installation/README.md).
 
 ## Troubleshooting
 
-If you do not see a `Certificate` resource being created after applying the ingress-shim annotations check that at least `cert-manager.io/issuer` or `cert-manager.io/cluster-issuer` is set. If you want to use `kubernetes.io/tls-acme: "true"` make sure to have checked all steps above and you might want to look for errors in the cert-manager pod logs if not resolved.
+If you do not see a `Certificate` resource being created after applying the ingress-shim annotations check that at least `cert-manager.io/issuer` or `cert-manager.io/cluster-issuer` is set. If you want to use `kubernetes.io/tls-acme: "true"` make sure to have checked all steps above and you might want to look for errors in the cert-manager pod logs if not resolved.