Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maltesander committed Sep 30, 2024
1 parent 4f0fe53 commit a89ecd4
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
apiVersion: secrets.stackable.tech/v1alpha1
kind: SecretClass
metadata:
name: tls
spec:
backend:
autoTls:
ca:
secret:
name: secret-provisioner-tls-ca
namespace: default
keyGeneration: # <1>
rsa: # <2>
length: 4096 # <3>
15 changes: 15 additions & 0 deletions docs/modules/secret-operator/pages/secretclass.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@ CAUTION: Attributes of the certificate (such as the expiration date, fingerprint

xref:scope.adoc[Scopes] are used to populate the claims (such as `subjectAlternateName`) of the provisioned certificates.

[#backend-tls-key-length]
=== `TLS key length`

Currently, only RSA is supported in the `autoTls` backend. You can however configure the key length for generated private keys or certs.

----
include::example$secretclass-tls-key-length.yaml[]
----
<1> `autoTls.ca.keyGeneration` specifies which algorithm and additional parameters are used
<2> `autoTls.ca.keyGeneration.rsa` specifies the RSA algorithm
<3> `autoTls.ca.keyGeneration.rsa.length` specifies the amount of bits used for key or certs. Currently `2048`, `4096` and `8192` are supported.

Check notice on line 51 in docs/modules/secret-operator/pages/secretclass.adoc

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] docs/modules/secret-operator/pages/secretclass.adoc#L51

A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1]) Suggestions: `Currently,` URL: https://languagetool.org/insights/post/linking-words/ Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1 Category: PUNCTUATION
Raw output
docs/modules/secret-operator/pages/secretclass.adoc:51:94: A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
 Suggestions: `Currently,`
 URL: https://languagetool.org/insights/post/linking-words/ 
 Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
 Category: PUNCTUATION

CAUTION: Using a key length higher than `2048` will significantly increase the computation time. If options higher than `2048` are choosen, the CPU

Check failure on line 53 in docs/modules/secret-operator/pages/secretclass.adoc

View workflow job for this annotation

GitHub Actions / misspell

[misspell] docs/modules/secret-operator/pages/secretclass.adoc#L53

"choosen" is a misspelling of "chosen"
Raw output
./docs/modules/secret-operator/pages/secretclass.adoc:53:131: "choosen" is a misspelling of "chosen"
resources for the secret operator should be increased in order to avoid pods waiting for the computation of their key.

==== Certificate lifetime

By default the Secret Operator will generally aim to use as short-lived certificates as possible.
Expand Down

0 comments on commit a89ecd4

Please sign in to comment.