Skip to content

Commit eebf8ca

Browse files
regen docs (#97)
1 parent e1a8880 commit eebf8ca

File tree

5 files changed

+139
-0
lines changed

5 files changed

+139
-0
lines changed

.github/workflows/test.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,21 @@ jobs:
7979
go-version-file: go.mod
8080
check-latest: true
8181
- run: PATH=$PATH:$GOPATH/bin make test
82+
verify-docs:
83+
name: Verify docs
84+
runs-on: ubuntu-latest
85+
steps:
86+
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
87+
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
88+
with:
89+
go-version-file: go.mod
90+
- run: PATH=$PATH:$GOPATH/bin make generate-docs
91+
- name: Verify Changed files
92+
run: |
93+
git diff --exit-code -- . || {
94+
echo "::error Schema has changed changed. Please run 'make update-schema' and commit the changes."
95+
exit 1
96+
}
8297
lint:
8398
name: Lint
8499
runs-on: ubuntu-latest
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "plural_cloud_connection Data Source - terraform-provider-plural"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# plural_cloud_connection (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `cloud_provider` (String) The cloud provider of this cloud connection.
21+
- `configuration` (Attributes) Cloud provider configuration (see [below for nested schema](#nestedatt--configuration))
22+
23+
### Optional
24+
25+
- `id` (String) Internal identifier of this cloud connection
26+
- `name` (String) Human-readable name of this cloud connection.
27+
- `read_bindings` (Set of Object) The read bindings for this cloud connection. (see [below for nested schema](#nestedatt--read_bindings))
28+
29+
<a id="nestedatt--configuration"></a>
30+
### Nested Schema for `configuration`
31+
32+
33+
<a id="nestedatt--read_bindings"></a>
34+
### Nested Schema for `read_bindings`
35+
36+
Optional:
37+
38+
- `group_id` (String)
39+
- `id` (String)
40+
- `user_id` (String)

docs/data-sources/group.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ A representation of a group to organize authorization in your plural console.
1919

2020
- `name` (String) Name of this group.
2121

22+
### Optional
23+
24+
- `global` (Boolean)
25+
2226
### Read-Only
2327

2428
- `description` (String) Description of this group.

docs/resources/cloud_connection.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "plural_cloud_connection Resource - terraform-provider-plural"
4+
subcategory: ""
5+
description: |-
6+
A cloud connection resource for connecting cloud provider accounts.
7+
---
8+
9+
# plural_cloud_connection (Resource)
10+
11+
A cloud connection resource for connecting cloud provider accounts.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `cloud_provider` (String) Cloud provider type (AWS, GCP, etc).
21+
- `configuration` (Attributes) Cloud provider configuration block. (see [below for nested schema](#nestedatt--configuration))
22+
- `name` (String) Name of this cloud connection.
23+
24+
### Optional
25+
26+
- `read_bindings` (Attributes Set) (see [below for nested schema](#nestedatt--read_bindings))
27+
28+
### Read-Only
29+
30+
- `id` (String) Internal identifier of this cloud connection.
31+
32+
<a id="nestedatt--configuration"></a>
33+
### Nested Schema for `configuration`
34+
35+
Optional:
36+
37+
- `aws` (Object) AWS-specific configuration. (see [below for nested schema](#nestedatt--configuration--aws))
38+
- `azure` (Object) Azure-specific configuration. (see [below for nested schema](#nestedatt--configuration--azure))
39+
- `gcp` (Object) GCP-specific configuration. (see [below for nested schema](#nestedatt--configuration--gcp))
40+
41+
<a id="nestedatt--configuration--aws"></a>
42+
### Nested Schema for `configuration.aws`
43+
44+
Required:
45+
46+
- `access_key_id` (String)
47+
- `region` (String)
48+
- `secret_access_key` (String)
49+
50+
51+
<a id="nestedatt--configuration--azure"></a>
52+
### Nested Schema for `configuration.azure`
53+
54+
Required:
55+
56+
- `client_id` (String)
57+
- `client_secret` (String)
58+
- `subscription_id` (String)
59+
- `tenant_id` (String)
60+
61+
62+
<a id="nestedatt--configuration--gcp"></a>
63+
### Nested Schema for `configuration.gcp`
64+
65+
Required:
66+
67+
- `project_id` (String)
68+
- `service_account_key` (String)
69+
70+
71+
72+
<a id="nestedatt--read_bindings"></a>
73+
### Nested Schema for `read_bindings`
74+
75+
Optional:
76+
77+
- `group_id` (String)
78+
- `id` (String)
79+
- `user_id` (String)

docs/resources/group.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ group resource
2222
### Optional
2323

2424
- `description` (String) Description of this group.
25+
- `global` (Boolean)
2526

2627
### Read-Only
2728

0 commit comments

Comments
 (0)