Skip to content

Commit a52b62a

Browse files
jlacefieanekkanti
andauthored
Updates to documentation
* Initial Contributing.MD * Issues/PR and review language added * updates for CLA, license headers, and general improvements * updated the doc for Namespace ca certs and all resource import examples * run go generate --------- Co-authored-by: Abhinav Nekkanti <[email protected]>
1 parent 7341c55 commit a52b62a

File tree

11 files changed

+73
-10
lines changed

11 files changed

+73
-10
lines changed

docs/resources/apikey.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,10 @@ Optional:
7474
Import is supported using the following syntax:
7575

7676
```shell
77-
terraform import temporalcloud_apikey.terraform terraform.badf00d
77+
# API Keys can be imported to incorporate existing API Keys into your Terraform pipeline.
78+
# To import an API Key, you need
79+
# - a resource configuration in your Terraform configuration file/module to accept the imported API Key. In the example below, the placeholder is "temporalcloud_apikey" "tfapikey"
80+
# - the API Key's ID, which is found when clicking into an API Key in the Temporal Cloud UI. In the example below, this is zJV5zQ3IhsAbw75dAkVNEMsAd3a5AemC
81+
82+
terraform import temporalcloud_apikey.tfapikey zJV5zQ3IhsAbw75dAkVNEMsAd3a5AemC
7883
```

docs/resources/namespace.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ resource "temporalcloud_namespace" "terraform3" {
122122

123123
### Optional
124124

125-
- `accepted_client_ca` (String) The Base64-encoded CA cert in PEM format that clients use when authenticating with Temporal Cloud.
125+
- `accepted_client_ca` (String) The Base64-encoded CA cert in PEM format that clients use when authenticating with Temporal Cloud. This is a required field when a Namespace uses mTLS authentication.
126126
- `api_key_auth` (Boolean) If true, Temporal Cloud will use API key authentication for this namespace. If false, mutual TLS (mTLS) authentication will be used.
127127
- `certificate_filters` (Attributes List) A list of filters to apply to client certificates when initiating a connection Temporal Cloud. If present, connections will only be allowed from client certificates whose distinguished name properties match at least one of the filters. (see [below for nested schema](#nestedatt--certificate_filters))
128128
- `codec_server` (Attributes) A codec server is used by the Temporal Cloud UI to decode payloads for all users interacting with this namespace, even if the workflow history itself is encrypted. (see [below for nested schema](#nestedatt--codec_server))
@@ -180,5 +180,10 @@ Read-Only:
180180
Import is supported using the following syntax:
181181

182182
```shell
183-
terraform import temporalcloud_namespace.terraform terraform.badf00d
183+
# Namespace can be imported to incorporate existing Namespaces into your Terraform pipeline.
184+
# To import a Namespace, you need
185+
# - a resource configuration in your Terraform configuration file/module to accept the imported Namespace. In the example below, the placeholder is "temporalcloud_namespace" "terraform"
186+
# - the Namespace ID, which includes the Namespace Name and Account ID available at the top of the Namespace's page in the Temporal Cloud UI. In the example below, this is namespaceid.acctid
187+
188+
terraform import temporalcloud_namespace.terraform namespaceid.acctid
184189
```

docs/resources/namespace_search_attribute.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,18 @@ resource "temporalcloud_namespace_search_attribute" "custom_search_attribute3" {
6363
### Read-Only
6464

6565
- `id` (String) The ID of this search attribute.
66+
67+
## Import
68+
69+
Import is supported using the following syntax:
70+
71+
```shell
72+
# Search Attributes can be imported to incorporate existing Namespace Search Attributes into your Terraform pipeline.
73+
# To import a Search Attribute, you need
74+
# - a resource configuration in your Terraform configuration file/module to accept the imported Search Attribute. In the example below, the placeholder is "temporalcloud_namespace_search_attribute" "saimport"
75+
# - the Namespace ID, which includes the Namespace Name and Account ID available at the top of the Namespace's page in the Temporal Cloud UI. In the example below, this is namespaceid.acctid
76+
# - the name of the Search Attribute, which is available in the Search Attribute configuration of Namespace's page in the Temporal Cloud UI. In the example below, this is searchAttr
77+
78+
79+
terraform import temporalcloud_namespace_search_attribute.saimport namespaceid.acctid/searchAttr
80+
```

docs/resources/service_account.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,10 @@ Optional:
8989
Import is supported using the following syntax:
9090

9191
```shell
92-
terraform import temporalcloud_service_account.terraform terraform.badf00d
92+
# Service Accounts can be imported to incorporate existing Service Accounts into your Terraform pipeline.
93+
# To import a Service Account, you need
94+
# - a resource configuration in your Terraform configuration file/module to accept the imported Service Account. In the example below, the placeholder is "temporalcloud_service_account" "saimport"
95+
# - the Service Accounts's ID, which is found using the Temporal Cloud CLI tcld sa l. In the example below, this is e3cb94fbdbb845f480044d053d00665b
96+
97+
terraform import temporalcloud_service_account.saimport e3cb94fbdbb845f480044d053d00665b
9398
```

docs/resources/user.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,10 @@ Optional:
8989
Import is supported using the following syntax:
9090

9191
```shell
92-
terraform import temporalcloud_user.terraform terraform.badf00d
92+
# Users can be imported to incorporate existing Users into your Terraform pipeline.
93+
# To import a User, you need
94+
# - a resource configuration in your Terraform configuration file/module to accept the imported User. In the example below, the placeholder is "temporalcloud_user" "user"
95+
# - the User's ID, which is found using the Temporal Cloud CLI tcld u l. In the example below, this is 72360058153949edb2f1d47019c1e85f
96+
97+
terraform import temporalcloud_user.user 72360058153949edb2f1d47019c1e85f
9398
```
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
terraform import temporalcloud_apikey.terraform terraform.badf00d
1+
# API Keys can be imported to incorporate existing API Keys into your Terraform pipeline.
2+
# To import an API Key, you need
3+
# - a resource configuration in your Terraform configuration file/module to accept the imported API Key. In the example below, the placeholder is "temporalcloud_apikey" "tfapikey"
4+
# - the API Key's ID, which is found when clicking into an API Key in the Temporal Cloud UI. In the example below, this is zJV5zQ3IhsAbw75dAkVNEMsAd3a5AemC
5+
6+
terraform import temporalcloud_apikey.tfapikey zJV5zQ3IhsAbw75dAkVNEMsAd3a5AemC
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
terraform import temporalcloud_namespace.terraform terraform.badf00d
1+
# Namespace can be imported to incorporate existing Namespaces into your Terraform pipeline.
2+
# To import a Namespace, you need
3+
# - a resource configuration in your Terraform configuration file/module to accept the imported Namespace. In the example below, the placeholder is "temporalcloud_namespace" "terraform"
4+
# - the Namespace ID, which includes the Namespace Name and Account ID available at the top of the Namespace's page in the Temporal Cloud UI. In the example below, this is namespaceid.acctid
5+
6+
terraform import temporalcloud_namespace.terraform namespaceid.acctid
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Search Attributes can be imported to incorporate existing Namespace Search Attributes into your Terraform pipeline.
2+
# To import a Search Attribute, you need
3+
# - a resource configuration in your Terraform configuration file/module to accept the imported Search Attribute. In the example below, the placeholder is "temporalcloud_namespace_search_attribute" "saimport"
4+
# - the Namespace ID, which includes the Namespace Name and Account ID available at the top of the Namespace's page in the Temporal Cloud UI. In the example below, this is namespaceid.acctid
5+
# - the name of the Search Attribute, which is available in the Search Attribute configuration of Namespace's page in the Temporal Cloud UI. In the example below, this is searchAttr
6+
7+
8+
terraform import temporalcloud_namespace_search_attribute.saimport namespaceid.acctid/searchAttr
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
terraform import temporalcloud_service_account.terraform terraform.badf00d
1+
# Service Accounts can be imported to incorporate existing Service Accounts into your Terraform pipeline.
2+
# To import a Service Account, you need
3+
# - a resource configuration in your Terraform configuration file/module to accept the imported Service Account. In the example below, the placeholder is "temporalcloud_service_account" "saimport"
4+
# - the Service Accounts's ID, which is found using the Temporal Cloud CLI tcld sa l. In the example below, this is e3cb94fbdbb845f480044d053d00665b
5+
6+
terraform import temporalcloud_service_account.saimport e3cb94fbdbb845f480044d053d00665b
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
terraform import temporalcloud_user.terraform terraform.badf00d
1+
# Users can be imported to incorporate existing Users into your Terraform pipeline.
2+
# To import a User, you need
3+
# - a resource configuration in your Terraform configuration file/module to accept the imported User. In the example below, the placeholder is "temporalcloud_user" "user"
4+
# - the User's ID, which is found using the Temporal Cloud CLI tcld u l. In the example below, this is 72360058153949edb2f1d47019c1e85f
5+
6+
terraform import temporalcloud_user.user 72360058153949edb2f1d47019c1e85f

0 commit comments

Comments
 (0)