cert-manager / website

Source code for the cert-manager.io website, including project documentation
https://cert-manager.io
Apache License 2.0
53 stars 330 forks source link

Case for CertificatePrivateKey (encoding, algorithm) is wrong (v1) #330

Closed jr0d closed 1 week ago

jr0d commented 3 years ago

Greetings!

The documentation states that:

PrivateKeyEncoding:

allowed values are “pkcs1” and “pkcs8” standing for PKCS#1 and PKCS#8

PrivateKeyAlgorithm:

allowed values are either “rsa” or “ecdsa”

However, allowed values are uppercase, PKCS1/PKCS8 and RSA/ECDSA respectively. The change seems to have been added in v1beta1.

 > k apply -f test-cert.yaml
The Certificate "test-certificate" is invalid:
* spec.privateKey.algorithm: Unsupported value: "rsa": supported values: "RSA", "ECDSA"
* spec.privateKey.encoding: Unsupported value: "pksc1": supported values: "PKCS1", "PKCS8"
meyskens commented 3 years ago

This changed in v1.0 indeed, PRs are welcome!

inteon commented 1 week ago

This has been fixed, see https://github.com/cert-manager/website/blob/8ccd9cb0f5c695c76abf952b26d77a808d59a41f/content/docs/reference/api-docs.md?plain=1#L3874/.