Skip to content

Commit dd2bded

Browse files
authored
fix(provider): [119093637] Update provider doc (#2872)
* add * add * add
1 parent 904af24 commit dd2bded

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

website/docs/index.html.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ The following methods are supported, in this order, and explained below:
100100
- Assume role with SAML
101101
- Assume role with OIDC
102102
- Shared credentials
103+
- Enable pod OIDC
104+
- Cam role name
103105

104106
### Static credentials
105107

@@ -236,6 +238,36 @@ $ export TENCENTCLOUD_ASSUME_ROLE_WEB_IDENTITY_TOKEN="my-web-identity-token"
236238
$ terraform plan
237239
```
238240

241+
### Enable pod OIDC
242+
243+
Configure the TencentCloud Provider with TKE OIDC.
244+
245+
-> **Note:** Must ensure CAM OIDC provider and WEBHOOK component are created successfully.
246+
247+
Usage:
248+
249+
```hcl
250+
provider "tencentcloud" {
251+
enable_pod_oidc = true
252+
}
253+
```
254+
255+
### Cam role name
256+
257+
If provided with a Cam role name, Terraform will just access the metadata URL: http://metadata.tencentyun.com/latest/meta-data/cam/security-credentials/<cam_role_name> to obtain the STS credential. The CVM Instance Role also can be set using the TENCENTCLOUD_CAM_ROLE_NAME environment variables.
258+
259+
-> **Note:** Cam-role-name is used to grant the role entity the permissions to access services and resources and perform operations in Tencent Cloud. You can associate the CAM role with a CVM instance to call other Tencent Cloud APIs from the instance using the periodically updated temporary Security Token Service (STS) key.
260+
261+
-> **Note:** Cam-role-name is a no-AK auth type, and there is no need setting secret_id and secret_key while using it.
262+
263+
Usage:
264+
265+
```hcl
266+
provider "tencentcloud" {
267+
cam_role_name = "my-cam-role-name"
268+
}
269+
```
270+
239271
### CDC cos usage
240272

241273
You can set the cos domain by setting the environment variable `TENCENTCLOUD_COS_DOMAIN`, and configure the cdc scenario as follows:
@@ -308,6 +340,7 @@ In addition to generic provider arguments (e.g. alias and version), the followin
308340
* `assume_role_with_web_identity` - (Optional, Available in 1.81.111+) An `assume_role_with_web_identity` block (documented below). If provided, terraform will attempt to assume this role using the supplied credentials. Only one `assume_role_with_web_identity` block may be in the configuration.
309341
* `protocol` - (Optional, Available in 1.37.0+) The protocol of the API request. Valid values: `HTTP` and `HTTPS`. Default is `HTTPS`.
310342
* `domain` - (Optional, Available in 1.37.0+) The root domain of the API request, Default is `tencentcloudapi.com`.
343+
* `cam_role_name` - (Optional, Available in 1.81.117+) The name of the CVM instance CAM role. It can be sourced from the `TENCENTCLOUD_CAM_ROLE_NAME` environment variable.
311344

312345
The nested `assume_role` block supports the following:
313346
* `role_arn` - (Required) The ARN of the role to assume. It can also be sourced from the `TENCENTCLOUD_ASSUME_ROLE_ARN` environment variable.

0 commit comments

Comments
 (0)