Skip to content

Commit

Permalink
cherry-pick: update CSI documentation on website (#11531)
Browse files Browse the repository at this point in the history
* Add documentation for vault-csi-provider namespace config (#11344)

* docs: add missing configurations for CSI documentation (#11236)

* docs: add missing csi mount config (#11518)

* docs: remove duplicate config from csi (#11529)

Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>
  • Loading branch information
jasonodonnell and tomhjp committed May 4, 2021
1 parent 3e2ab43 commit 15e0de5
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions website/content/docs/platform/k8s/csi/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,17 @@ The following parameters are supported by the Vault provider:

- `vaultAddress` `(string: "")` - The address of the Vault server.

- `vaultSkipTLSVerify` `(string: "false")` - When set to true, skips verification of the Vault server
- `vaultNamespace` `(string: "")` - The Vault [namespace](/docs/enterprise/namespaces) to use.

- `vaultSkipTLSVerify` `(string: "false")` - When set to true, skips verification of the Vault server
certificiate. Setting this to true is not recommended for production.

- `vaultCACertPath` `(string: "")` - The path on disk where the Vault CA certificate can be found
when verifying the Vault server certificate.

- `vaultCADirectory` `(string: "")` - The directory on disk where the Vault CA certificate can be found
when verifying the Vault server certificate.

- `vaultTLSClientCertPath` `(string: "")` - The path on disk where the client certificate can be found
for mTLS communications with Vault.

Expand All @@ -26,17 +31,22 @@ The following parameters are supported by the Vault provider:

- `vaultTLSServerName` `(string: "")` - The name to use as the SNI host when connecting via TLS.

- `vaultKubernetesMountPath` `(string: "kubernetes")` - The name of the auth mount used for login.
At this time only the Kubernetes auth method is supported.

- `objects` `(array)` - An array of secrets to retrieve from Vault.

- `objectName` `(string: "")` - The alias of the object which can be referenced within the secret provider class and
- `objectName` `(string: "")` - The alias of the object which can be referenced within the secret provider class and
the name of the secret file.

- `method` `(string: "GET")` - The type of HTTP request. Supported values include "GET" and "PUT".

- `secretPath` `(string: "")` - The path in Vault where the secret is located.

- `secretArgs` `(map: {})` - Additional arguments to be sent to Vault for a specific secret. Arguments can vary
for different secret engines. For example:
- `secretKey` `(string: "")` - The key in the Vault secret to extract. If omitted, the whole response from Vault will be written as JSON.

- `secretArgs` `(map: {})` - Additional arguments to be sent to Vault for a specific secret. Arguments can vary
for different secret engines. For example:

```yaml
secretArgs:
Expand Down

0 comments on commit 15e0de5

Please sign in to comment.