-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(certificate-sign): Add a description of the signing block
Closes #467
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |