|
| 1 | +--- |
| 2 | +type: docs |
| 3 | +title: "Tencent Cloud Secrets Manager (SSM)" |
| 4 | +linkTitle: "Tencent Cloud Secrets Manager (SSM)" |
| 5 | +description: Detailed information on the Tencent Cloud Secrets Manager (SSM) - secret store component |
| 6 | +aliases: |
| 7 | + - "/operations/components/setup-secret-store/supported-secret-stores/tencentcloud-ssm/" |
| 8 | +--- |
| 9 | + |
| 10 | +## Component format |
| 11 | + |
| 12 | +To setup Tencent Cloud Secrets Manager (SSM) secret store create a component of type `secretstores.tencentcloud.ssm`. |
| 13 | +See [this guide]({{% ref "setup-secret-store.md#apply-the-configuration" %}}) on how to create and apply a secretstore configuration. |
| 14 | +See this guide on [referencing secrets]({{% ref component-secrets.md %}}) to retrieve and use the secret with Dapr components. |
| 15 | + |
| 16 | +```yaml |
| 17 | +apiVersion: dapr.io/v1alpha1 |
| 18 | +kind: Component |
| 19 | +metadata: |
| 20 | + name: tencentcloudssm |
| 21 | +spec: |
| 22 | + type: secretstores.tencentcloud.ssm |
| 23 | + version: v1 |
| 24 | + metadata: |
| 25 | + - name: region |
| 26 | + value: "[tencentcloud_region]" |
| 27 | + - name: secretId |
| 28 | + value: "[tencentcloud_secret_id]" |
| 29 | + - name: secretKey |
| 30 | + value: "[tencentcloud_secret_key]" |
| 31 | + - name: token |
| 32 | + value: "[tencentcloud_secret_token]" |
| 33 | +``` |
| 34 | +
|
| 35 | +{{% alert title="Warning" color="warning" %}} |
| 36 | +The above example uses secrets as plain strings. |
| 37 | +It is recommended to use a local secret store such as [Kubernetes secret store]({{% ref kubernetes-secret-store.md %}}) or a [local file]({{% ref file-secret-store.md %}}) to bootstrap secure key storage. |
| 38 | +{{% /alert %}} |
| 39 | +
|
| 40 | +## Spec metadata fields |
| 41 | +
|
| 42 | +| Field | Required | Details | Example | |
| 43 | +| --------------- | :------: | ---------------------------------------------------------------- | ------------------- | |
| 44 | +| region | Y | The specific region the Tencent SSM instance is deployed in | `"ap-beijing-3"` | |
| 45 | +| secretId | Y | The SecretId of the Tencent Cloud account | `"xyz"` | |
| 46 | +| secretKey | Y | The SecretKey of the Tencent Cloud account | `"xyz"` | |
| 47 | +| token | N | The Token of the Tencent Cloud account. This is required only if using temporary credentials | `""` | |
| 48 | +
|
| 49 | +## Optional per-request metadata properties |
| 50 | +
|
| 51 | +The following [optional query parameters]({{% ref "secrets_api#query-parameters" %}}) can be provided when retrieving secrets from this secret store: |
| 52 | +
|
| 53 | +Query Parameter | Description |
| 54 | +--------- | ----------- |
| 55 | +`metadata.version_id` | Version for the given secret key. |
| 56 | + |
| 57 | +## Setup Tencent Cloud Secrets Manager (SSM) |
| 58 | + |
| 59 | +Setup Tencent Cloud Secrets Manager (SSM) using the Tencent Cloud documentation: https://www.tencentcloud.com/products/ssm |
| 60 | + |
| 61 | +## Related links |
| 62 | + |
| 63 | +- [Secrets building block]({{% ref secrets %}}) |
| 64 | +- [How-To: Retrieve a secret]({{% ref "howto-secrets.md" %}}) |
| 65 | +- [How-To: Reference secrets in Dapr components]({{% ref component-secrets.md %}}) |
| 66 | +- [Secrets API reference]({{% ref secrets_api.md %}}) |
0 commit comments