Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add missing configurations for CSI documentation #11236

Merged
merged 6 commits into from
Apr 26, 2021
Merged

docs: add missing configurations for CSI documentation #11236

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d29869a
doc: add missing configs for csi
jasonodonnell Mar 30, 2021
8d99a63
Add auth method description
jasonodonnell Mar 30, 2021
ddd2075
Update website/content/docs/platform/k8s/csi/configurations.mdx
jasonodonnell Mar 30, 2021
573f912
Update website/content/docs/platform/k8s/csi/configurations.mdx
jasonodonnell Mar 30, 2021
4aa0bd8
Merge branch 'master' into docs/csi-auth-path
tomhjp Apr 23, 2021
3c9f838
Empty commit to trigger CI
tomhjp Apr 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions website/content/docs/platform/k8s/csi/configurations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ 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
- `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 @@ -27,17 +30,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