Skip to content

Commit

Permalink
docs(certificate-sign): Add a description of the signing block
Browse files Browse the repository at this point in the history
Closes #467
  • Loading branch information
vaerh committed May 27, 2024
1 parent 958597f commit 9ede2a3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions templates/resources/system_certificate.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# {{.Name}} ({{.Type}})
{{ .Description | trimspace }}

Certificate resource management consists of two independent processes:
* key creation and certificate signing request (`key` + `csr`)
* certificate signing by the issuer (`crt`)

For a complete certificate creation cycle, both of the above steps must be performed. In this case the `sign {}` block must be specified in the configuration.

If you need to import the current state of the certificate resource, then do not specify the `sign{}` block.

Importing an external certificate is also done without specifying the `sign{}` block, because the certificate should have already been signed by the issuer at this step.

---

{{ if .HasExample -}}
## Example Usage
{{ tffile .ExampleFile }}
{{- end }}

{{ .SchemaMarkdown | trimspace }}

{{ if .HasImport -}}
## Import
Import is supported using the following syntax:
{{ codefile "shell" .ImportFile }}
{{- end }}

0 comments on commit 9ede2a3

Please sign in to comment.