Skip to content

Commit 875a9fe

Browse files
JoshVanLmsfussell
andauthored
[1.16] Adds Tencent Cloud Secrets Manager (SSM) (#4833)
Signed-off-by: joshvanl <[email protected]> Signed-off-by: Mark Fussell <[email protected]> Co-authored-by: Mark Fussell <[email protected]>
1 parent 2e00d5a commit 875a9fe

File tree

3 files changed

+73
-1
lines changed

3 files changed

+73
-1
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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 %}})
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- component: Tencent Cloud Secrets Manager (SSM)
2+
link: tencentcloud-ssm
3+
state: Alpha
4+
version: v1
5+
since: "1.9"

daprdocs/layouts/_partials/components/secret-stores.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
{{- $groups := dict
2-
" Generic" $.Site.Data.components.secret_stores.generic
2+
"Generic" $.Site.Data.components.secret_stores.generic
33
"Microsoft Azure" $.Site.Data.components.secret_stores.azure
44
"Alibaba Cloud" $.Site.Data.components.secret_stores.alibaba
55
"Google Cloud Platform (GCP)" $.Site.Data.components.secret_stores.gcp
66
"Amazon Web Services (AWS)" $.Site.Data.components.secret_stores.aws
7+
"Tencent Cloud" $.Site.Data.components.secret_stores.tencentcloud
78
"HuaweiCloud Cloud" $.Site.Data.components.secret_stores.huaweicloud
89
}}
910

0 commit comments

Comments
 (0)