Skip to content

Commit f3799ec

Browse files
committed
Add docs for cloudprovider_gcp resource
1 parent 20dd01f commit f3799ec

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

docs/resources/cloudprovider_gcp.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "tlspc_cloudprovider_gcp Resource - tlspc"
44
subcategory: ""
55
description: |-
6-
6+
Configure a GCP Cloud Provider integration with Workload Identity Federation
77
---
88

99
# tlspc_cloudprovider_gcp (Resource)
1010

11-
11+
Configure a GCP Cloud Provider integration with Workload Identity Federation
1212

1313
## Example Usage
1414

@@ -101,14 +101,14 @@ resource "tlspc_cloudprovider_gcp" "gcp-cloudprovider" {
101101

102102
### Required
103103

104-
- `name` (String)
105-
- `project_number` (Number)
106-
- `service_account_email` (String)
107-
- `team` (String)
108-
- `workload_identity_pool_id` (String)
109-
- `workload_identity_pool_provider_id` (String)
104+
- `name` (String) The name of this integration
105+
- `project_number` (Number) GCP Project Number
106+
- `service_account_email` (String) GCP Service Account Email
107+
- `team` (String) The ID of the owning Team
108+
- `workload_identity_pool_id` (String) GCP Workload Identity Pool ID
109+
- `workload_identity_pool_provider_id` (String) GCP Workload Identity Pool Provider ID
110110

111111
### Read-Only
112112

113-
- `id` (String) The ID of this resource.
114-
- `issuer_url` (String)
113+
- `id` (String) The ID of this resource
114+
- `issuer_url` (String) The issuer URL that should be provided to set up the GCP Workload Identity Pool

internal/provider/cloudprovider_gcp_resource.go

+15-6
Original file line numberDiff line numberDiff line change
@@ -37,36 +37,45 @@ func (r *cloudProviderGCPResource) Metadata(_ context.Context, req resource.Meta
3737

3838
func (r *cloudProviderGCPResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
3939
resp.Schema = schema.Schema{
40+
MarkdownDescription: "Configure a GCP Cloud Provider integration with Workload Identity Federation",
4041
Attributes: map[string]schema.Attribute{
4142
"id": schema.StringAttribute{
4243
Computed: true,
4344
PlanModifiers: []planmodifier.String{
4445
stringplanmodifier.UseStateForUnknown(),
4546
},
47+
MarkdownDescription: "The ID of this resource",
4648
},
4749
"issuer_url": schema.StringAttribute{
4850
Computed: true,
4951
PlanModifiers: []planmodifier.String{
5052
stringplanmodifier.UseStateForUnknown(),
5153
},
54+
MarkdownDescription: "The issuer URL that should be provided to set up the GCP Workload Identity Pool",
5255
},
5356
"name": schema.StringAttribute{
54-
Required: true,
57+
Required: true,
58+
MarkdownDescription: "The name of this integration",
5559
},
5660
"team": schema.StringAttribute{
57-
Required: true,
61+
Required: true,
62+
MarkdownDescription: "The ID of the owning Team",
5863
},
5964
"service_account_email": schema.StringAttribute{
60-
Required: true,
65+
Required: true,
66+
MarkdownDescription: "GCP Service Account Email",
6167
},
6268
"project_number": schema.Int64Attribute{
63-
Required: true,
69+
Required: true,
70+
MarkdownDescription: "GCP Project Number",
6471
},
6572
"workload_identity_pool_id": schema.StringAttribute{
66-
Required: true,
73+
Required: true,
74+
MarkdownDescription: "GCP Workload Identity Pool ID",
6775
},
6876
"workload_identity_pool_provider_id": schema.StringAttribute{
69-
Required: true,
77+
Required: true,
78+
MarkdownDescription: "GCP Workload Identity Pool Provider ID",
7079
},
7180
},
7281
}

0 commit comments

Comments
 (0)