Document query parameter for al secret stores with documentation.

Signed-off-by: Tiago Alves Macambira <tmacam@burocrata.org>
This commit is contained in:
Tiago Alves Macambira 2023-06-30 15:59:20 -07:00
parent b47aa93ac3
commit 4920dfd830
6 changed files with 32 additions and 5 deletions

View File

@ -43,6 +43,15 @@ The above example uses secrets as plain strings. It is recommended to use a loca
| accessKeySecret | Y | The AlibabaCloud Access Key Secret to access this resource | `"accessKeySecret"` | | accessKeySecret | Y | The AlibabaCloud Access Key Secret to access this resource | `"accessKeySecret"` |
| securityToken | N | The AlibabaCloud Security Token to use | `"securityToken"` | | securityToken | N | The AlibabaCloud Security Token to use | `"securityToken"` |
## Optional per-request metadata properties
The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store:
Query Parameter | Description
--------- | -----------
`metadata.version_id` | version for the given secret key
`metadata.path` | (For bulk requests only) the path from the metadata. If not set means root path (all secrets).
## Create an AlibabaCloud OOS Parameter Store instance ## Create an AlibabaCloud OOS Parameter Store instance
Setup AlibabaCloud OOS Parameter Store using the AlibabaCloud documentation: https://www.alibabacloud.com/help/en/doc-detail/186828.html. Setup AlibabaCloud OOS Parameter Store using the AlibabaCloud documentation: https://www.alibabacloud.com/help/en/doc-detail/186828.html.

View File

@ -50,12 +50,12 @@ When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernet
## Optional per-request metadata properties ## Optional per-request metadata properties
The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided to AWS Secret Manager component: The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store:
Query Parameter | Description Query Parameter | Description
--------- | ----------- --------- | -----------
metadata.version_id | version for the given secret key `metadata.version_id` | version for the given secret key
metadata.version_stage | version stage for the given secret key `metadata.version_stage` | version stage for the given secret key
## Create an AWS Secrets Manager instance ## Create an AWS Secrets Manager instance

View File

@ -53,6 +53,15 @@ The Azure Key Vault secret store component supports authentication with Azure AD
Additionally, you must provide the authentication fields as explained in the [Authenticating to Azure]({{< ref authenticating-azure.md >}}) document. Additionally, you must provide the authentication fields as explained in the [Authenticating to Azure]({{< ref authenticating-azure.md >}}) document.
## Optional per-request metadata properties
The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store:
Query Parameter | Description
--------- | -----------
`metadata.version_id` | version for the given secret key
`metadata.maxresults` | (For bulk requests only) number of secrets to return after which the request will be truncated.
## Example ## Example
### Prerequisites ### Prerequisites

View File

@ -67,7 +67,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description Query Parameter | Description
--------- | ----------- --------- | -----------
metadata.version_id | version for the given secret key `metadata.version_id` | version for the given secret key
## Setup GCP Secret Manager instance ## Setup GCP Secret Manager instance

View File

@ -72,7 +72,7 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters"
Query Parameter | Description Query Parameter | Description
--------- | ----------- --------- | -----------
metadata.version_id | version for the given secret key `metadata.version_id` | version for the given secret key
## Setup Hashicorp Vault instance ## Setup Hashicorp Vault instance

View File

@ -40,6 +40,15 @@ The above example uses secrets as plain strings. It is recommended to use a loca
| accessKey | Y | The HuaweiCloud Access Key to access this resource | `"accessKey"` | | accessKey | Y | The HuaweiCloud Access Key to access this resource | `"accessKey"` |
| secretAccessKey | Y | The HuaweiCloud Secret Access Key to access this resource | `"secretAccessKey"` | | secretAccessKey | Y | The HuaweiCloud Secret Access Key to access this resource | `"secretAccessKey"` |
## Optional per-request metadata properties
The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store:
Query Parameter | Description
--------- | -----------
`metadata.version_id` | version for the given secret key
## Setup HuaweiCloud Cloud Secret Management Service (CSMS) instance ## Setup HuaweiCloud Cloud Secret Management Service (CSMS) instance
Setup HuaweiCloud Cloud Secret Management Service (CSMS) using the HuaweiCloud documentation: https://support.huaweicloud.com/intl/en-us/usermanual-dew/dew_01_9993.html. Setup HuaweiCloud Cloud Secret Management Service (CSMS) using the HuaweiCloud documentation: https://support.huaweicloud.com/intl/en-us/usermanual-dew/dew_01_9993.html.