Skip to content

Commit c457605

Browse files
committed
update Certificate example and add literalSubject field
Signed-off-by: Tim Ramlot <[email protected]>
1 parent 2de18bb commit c457605

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

content/docs/usage/certificate.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -58,35 +58,58 @@ spec:
5858
labels:
5959
my-secret-label: foo
6060

61+
privateKey:
62+
algorithm: RSA
63+
encoding: PKCS1
64+
size: 2048
65+
66+
# keystores allows adding additional output formats. This is an example for reference only.
67+
keystores:
68+
pkcs12:
69+
create: true
70+
passwordSecretRef:
71+
name: example-com-tls-keystore
72+
key: password
73+
profile: Modern2023
74+
6175
duration: 2160h # 90d
6276
renewBefore: 360h # 15d
77+
78+
isCA: false
79+
usages:
80+
- server auth
81+
- client auth
82+
6383
subject:
6484
organizations:
6585
- jetstack
6686
# The use of the common name field has been deprecated since 2000 and is
6787
# discouraged from being used.
6888
commonName: example.com
69-
isCA: false
70-
privateKey:
71-
algorithm: RSA
72-
encoding: PKCS1
73-
size: 2048
74-
usages:
75-
- server auth
76-
- client auth
77-
# At least one of a DNS Name, URI, IP address or otherName is required.
89+
90+
# The literalSubject field is exclusive with subject and commonName. It allows
91+
# specifying the subject directly as a string. This is useful for when the order
92+
# of the subject fields is important or when the subject contains special types
93+
# which can be specified by their OID.
94+
#
95+
# literalSubject: "O=jetstack, CN=example.com, 2.5.4.42=John, 2.5.4.4=Doe"
96+
97+
# At least one of commonName (possibly through literalSubject), dnsNames, uris, emailAddresses, ipAddresses or otherNames is required.
7898
dnsNames:
7999
- example.com
80100
- www.example.com
81101
uris:
82102
- spiffe://cluster.local/ns/sandbox/sa/example
103+
emailAddresses:
104+
83105
ipAddresses:
84106
- 192.168.0.5
85107
# Needs cert-manager 1.14+ and "OtherNames" feature flag
86108
otherNames:
87109
# Should only supply oid of ut8 valued types
88110
- oid: 1.3.6.1.4.1.311.20.2.3 # User Principal Name "OID"
89111
utf8Value: [email protected]
112+
90113
# Issuer references are always required.
91114
issuerRef:
92115
name: ca-issuer
@@ -96,15 +119,6 @@ spec:
96119
# This is optional since cert-manager will default to this value however
97120
# if you are using an external issuer, change this to that issuer group.
98121
group: cert-manager.io
99-
100-
# keystores allows adding additional output formats. This is an example for reference only.
101-
keystores:
102-
pkcs12:
103-
create: true
104-
passwordSecretRef:
105-
name: example-com-tls-keystore
106-
key: password
107-
profile: Modern2023
108122
```
109123
110124
The signed certificate will be stored in a `Secret` resource named

0 commit comments

Comments
 (0)