Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nightkr committed Jun 21, 2023
1 parent 5422c5b commit d553fcb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/modules/secret-operator/pages/secretclass.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -217,17 +217,26 @@ Each backend should conform to at least one common format. This is intended to a
minimal impact on secret consumers.

[#format-tls]
=== TLS
=== TLS (PEM)

*Name*: `pem-certificate`

The secret contains the following files:

`ca.crt`:: The certificate of the Certificate Authority (and associated chain) that has signed the certificate, in the PEM format.
`tls.crt`:: The certificate identifying the `Pod`, in the PEM format.
`tls.key`:: The private key corresponding to `tls.crt`, in the PEM format.

[#format-tls-pkcs12]
=== TLS (PKCS#12)

*Name*: `pkcs12-certificate`

[#format-kerberos]
=== Kerberos

*Name*: `kerberos-keytab`

The secret contains the following files:

`krb5.conf`:: Kerberos configuration file for authenticating against the Kerberos realm.
Expand Down
10 changes: 10 additions & 0 deletions docs/modules/secret-operator/pages/volume.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ The name of the xref:secretclass.adoc[] that is responsible for providing this s

The xref:scope.adoc[scopes] used to select or provision the secret. Multiple scopes should be separated by commas (`,`), and scope parameters are separated by equals signs (`=`) where applicable.

=== `secrets.stackable.tech/format`

*Required*: false

*Default value*: default format of backend

*Backends*: All

The xref:secretclass.adoc#format[] that the secret should be written as.

=== `secrets.stackable.tech/kerberos.service.names`

*Required*: false
Expand Down

0 comments on commit d553fcb

Please sign in to comment.