Skip to content

Commit

Permalink
docs: updated docs for pki subcmd
Browse files Browse the repository at this point in the history
  • Loading branch information
soerenschneider committed Sep 2, 2024
1 parent 631d5df commit f1c22fa
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/cli/pki/sc_pki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## sc pki

Sign, issue and revoke x509 certificates and retrieve x509 CA data

```
sc pki [flags]
```

### Options

```
-h, --help help for pki
-m, --mount string Path where the PKI secret engine is mounted (default "pki")
-a, --vault-address string Vault address
```

### Options inherited from parent commands

```
--no-telemetry Do not perform check for updated version
-v, --verbose Print debug logs
```

### SEE ALSO

* [sc](sc.md) - Universal Command Line Interface for soeren.cloud
* [sc pki issue](sc_pki_issue.md) - Issues a x509 certificate

###### Auto generated by spf13/cobra on 2-Sep-2024
36 changes: 36 additions & 0 deletions docs/cli/pki/sc_pki_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## sc pki issue

Issues a x509 certificate

```
sc pki issue [flags]
```

### Options

```
--alt-names stringArray Alternative names
--ca-file string File to save the ca to
-c, --cert-file string File to save the certificate to
-n, --common-name string The CN for the certificate
-h, --help help for issue
-s, --ip-sans stringArray IP Sans
-k, --key-file string File to save the private key to
-r, --role string Vault role
-t, --ttl string TTL of the certificate (default "24h")
```

### Options inherited from parent commands

```
-m, --mount string Path where the PKI secret engine is mounted (default "pki")
--no-telemetry Do not perform check for updated version
-a, --vault-address string Vault address
-v, --verbose Print debug logs
```

### SEE ALSO

* [sc pki](sc_pki.md) - Sign, issue and revoke x509 certificates and retrieve x509 CA data

###### Auto generated by spf13/cobra on 2-Sep-2024

0 comments on commit f1c22fa

Please sign in to comment.