Skip to content

Commit 4094a2b

Browse files
PF9-pushkarPF9-pushkar
authored
Merge pull request #40 from platform9/pushkar/registry-docs
docs: commit generated registry docs (fixes empty Registry Documentation tab)
2 parents c8a5f8b + ba702d7 commit 4094a2b

80 files changed

Lines changed: 4398 additions & 7 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,11 @@ PCD-Terraform-Provider-Validation-Status.md
4040
DECISIONS.md
4141
docs/compatibility/ce-2026.4.md
4242

43-
# Generated registry docs — produced by `make generate` (tfplugindocs) on demand and
44-
# at release time; not committed.
45-
# Guides are authored in templates/guides/ and rendered into docs/guides/.
46-
/docs/index.md
47-
/docs/resources/
48-
/docs/data-sources/
49-
/docs/guides/
43+
# Generated registry docs (docs/index.md, docs/resources/, docs/data-sources/, docs/guides/)
44+
# ARE committed: the Terraform Registry renders provider documentation from the docs/ tree at
45+
# the release tag, so it must be in the repo. Regenerate with `make generate` (tfplugindocs)
46+
# and commit the result. Only the maintainer-internal docs/compatibility/ note above stays
47+
# untracked.
5048

5149
# Editors / OS
5250
.idea/

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ All notable changes to this project are documented here. The format is based on
66

77
## [Unreleased]
88

9+
## [0.1.1] - 2026-08-11
10+
11+
### Changed
12+
- Commit the generated registry documentation (`docs/`) so the Terraform Registry renders the
13+
provider's resource, data-source, and guide pages. v0.1.0 shipped without a committed `docs/`
14+
tree — the Registry builds documentation from the repository at the release tag, so its
15+
"Documentation" tab was empty. The docs are now generated with `tfplugindocs` (`make generate`)
16+
from the schema descriptions, `examples/`, and `templates/`, and committed. No provider
17+
behavior change.
18+
919
## [0.1.0] - 2026-08-07
1020

1121
Initial public release: a first-party Terraform provider for Platform9 Private Cloud

‎docs/data-sources/blockstorage_snapshot.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_blockstorage_snapshot Data Source - pcd"
4+
subcategory: "Block Storage"
5+
description: |-
6+
Look up a Cinder volume snapshot by ID or filters.
7+
---
8+
9+
# pcd_blockstorage_snapshot (Data Source)
10+
11+
Look up a Cinder volume snapshot by ID or filters.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_blockstorage_snapshot" "example" {
17+
name = "tf-example-snapshot"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `name` (String) Filter by name.
27+
- `region` (String) The region. Defaults to the provider's region.
28+
- `snapshot_id` (String) Look up by snapshot ID (takes precedence over filters).
29+
- `volume_id` (String) Filter by (and report) the source volume.
30+
31+
### Read-Only
32+
33+
- `description` (String) The snapshot description.
34+
- `id` (String) The snapshot ID.
35+
- `size` (Number) Size in GB.
36+
- `status` (String) The Cinder status.

‎docs/data-sources/blockstorage_volume.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_blockstorage_volume Data Source - pcd"
4+
subcategory: "Block Storage"
5+
description: |-
6+
Look up a Cinder volume by ID or name.
7+
---
8+
9+
# pcd_blockstorage_volume (Data Source)
10+
11+
Look up a Cinder volume by ID or name.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_blockstorage_volume" "example" {
17+
name = "tf-example-volume"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `name` (String) Look up by name.
27+
- `region` (String) The region. Defaults to the provider's region.
28+
- `volume_id` (String) Look up by volume ID (takes precedence over name).
29+
30+
### Read-Only
31+
32+
- `availability_zone` (String) The availability zone.
33+
- `bootable` (Boolean) Whether the volume is bootable.
34+
- `id` (String) The volume ID.
35+
- `size` (Number) Size in GB.
36+
- `status` (String) The Cinder status.
37+
- `volume_type` (String) The volume type.

‎docs/data-sources/cluster_blueprint.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_cluster_blueprint Data Source - pcd"
4+
subcategory: "Cluster Blueprint"
5+
description: |-
6+
Reads a PCD cluster blueprint by name.
7+
---
8+
9+
# pcd_cluster_blueprint (Data Source)
10+
11+
Reads a PCD cluster blueprint by name.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_cluster_blueprint" "example" {
17+
name = "ce-cluster"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Required
25+
26+
- `name` (String) The blueprint (cluster) name.
27+
28+
### Read-Only
29+
30+
- `dns_domain_name` (String) The internal DNS domain name for VMs.
31+
- `enable_distributed_routing` (Boolean) Whether distributed routing is enabled.
32+
- `image_library_shared_storage` (Boolean) Whether the image library uses shared storage.
33+
- `image_library_storage` (String) The image library storage location.
34+
- `instance_shared_storage` (Boolean) Whether instance storage is shared.
35+
- `networking_type` (String) The networking type (`ovn` or `ovs`).
36+
- `storage_backends_json` (String, Sensitive) The Cinder storage backends as a JSON string (contains credentials).
37+
- `virtual_networking` (Attributes) Virtual (tenant) networking settings. (see [below for nested schema](#nestedatt--virtual_networking))
38+
- `vm_storage` (String) The VM ephemeral storage path.
39+
40+
<a id="nestedatt--virtual_networking"></a>
41+
### Nested Schema for `virtual_networking`
42+
43+
Read-Only:
44+
45+
- `enabled` (Boolean)
46+
- `underlay_type` (String)
47+
- `vnid_range` (String)

‎docs/data-sources/compute_availability_zones.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_compute_availability_zones Data Source - pcd"
4+
subcategory: "Compute"
5+
description: |-
6+
Return the compute availability zones.
7+
---
8+
9+
# pcd_compute_availability_zones (Data Source)
10+
11+
Return the compute availability zones.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_compute_availability_zones" "example" {
17+
state = "available"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `region` (String) The region. Defaults to the provider's region.
27+
- `state` (String) Filter by state: available (default) or unavailable.
28+
29+
### Read-Only
30+
31+
- `id` (String) Data source identifier.
32+
- `names` (List of String) The matching availability zone names.

‎docs/data-sources/compute_flavor.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_compute_flavor Data Source - pcd"
4+
subcategory: "Compute"
5+
description: |-
6+
Look up a compute flavor by name or ID.
7+
---
8+
9+
# pcd_compute_flavor (Data Source)
10+
11+
Look up a compute flavor by name or ID.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_compute_flavor" "example" {
17+
name = "m1.large"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `flavor_id` (String) Look up by flavor ID (takes precedence over name).
27+
- `name` (String) Look up by exact name.
28+
- `region` (String) The region. Defaults to the provider's region.
29+
30+
### Read-Only
31+
32+
- `disk` (Number) Root disk in GB.
33+
- `id` (String) The flavor ID.
34+
- `is_public` (Boolean) Whether the flavor is public.
35+
- `ram` (Number) Memory in MB.
36+
- `rx_tx_factor` (Number) RX/TX factor.
37+
- `swap` (Number) Swap in MB.
38+
- `vcpus` (Number) Number of vCPUs.

‎docs/data-sources/compute_keypair.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_compute_keypair Data Source - pcd"
4+
subcategory: "Compute"
5+
description: |-
6+
Look up an SSH keypair by name.
7+
---
8+
9+
# pcd_compute_keypair (Data Source)
10+
11+
Look up an SSH keypair by name.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_compute_keypair" "example" {
17+
name = "tf-example-keypair"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Required
25+
26+
- `name` (String) The keypair name.
27+
28+
### Optional
29+
30+
- `region` (String) The region. Defaults to the provider's region.
31+
32+
### Read-Only
33+
34+
- `fingerprint` (String) The keypair fingerprint.
35+
- `id` (String) Mirrors name.
36+
- `public_key` (String) The public key.
37+
- `user_id` (String) The owning user.

‎docs/data-sources/dns_zone.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_dns_zone Data Source - pcd"
4+
subcategory: "DNS"
5+
description: |-
6+
Look up a DNS zone by ID or name. Exactly one zone must match.
7+
---
8+
9+
# pcd_dns_zone (Data Source)
10+
11+
Look up a DNS zone by ID or name. Exactly one zone must match.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_dns_zone" "example" {
17+
name = "example.com."
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `name` (String) Look up by (and report) the zone name.
27+
- `region` (String) The region. Defaults to the provider's region.
28+
- `zone_id` (String) Look up by zone ID (takes precedence over name).
29+
30+
### Read-Only
31+
32+
- `description` (String) The zone description.
33+
- `email` (String) The SOA contact email.
34+
- `id` (String) The zone ID.
35+
- `pool_id` (String) The pool hosting the zone.
36+
- `serial` (Number) The current SOA serial.
37+
- `status` (String) The zone status (e.g. ACTIVE).
38+
- `ttl` (Number) The zone TTL.
39+
- `type` (String) The zone type (PRIMARY or SECONDARY).

‎docs/data-sources/identity_auth_scope.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pcd_identity_auth_scope Data Source - pcd"
4+
subcategory: "Identity"
5+
description: |-
6+
Details about the authentication scope (user, project, domain, and roles) of the token the provider is currently using. Useful for wiring identity attributes into other resources.
7+
---
8+
9+
# pcd_identity_auth_scope (Data Source)
10+
11+
Details about the authentication scope (user, project, domain, and roles) of the token the provider is currently using. Useful for wiring identity attributes into other resources.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "pcd_identity_auth_scope" "example" {
17+
name = "tf-example-scope"
18+
region = "RegionOne"
19+
}
20+
```
21+
22+
<!-- schema generated by tfplugindocs -->
23+
## Schema
24+
25+
### Required
26+
27+
- `name` (String) An arbitrary name for this scope lookup (used as the data source identifier).
28+
29+
### Optional
30+
31+
- `region` (String) The region the scope was resolved in. Defaults to the provider's region.
32+
33+
### Read-Only
34+
35+
- `domain_id` (String) ID of the scoped domain (for a domain-scoped token).
36+
- `domain_name` (String) Name of the scoped domain.
37+
- `id` (String) Mirrors `name`; present so the data source has a stable identifier.
38+
- `project_domain_id` (String) Domain ID of the scoped project.
39+
- `project_domain_name` (String) Domain name of the scoped project.
40+
- `project_id` (String) ID of the scoped project (empty for a domain-scoped token).
41+
- `project_name` (String) Name of the scoped project.
42+
- `roles` (Attributes List) Roles the user holds in the current scope. (see [below for nested schema](#nestedatt--roles))
43+
- `user_domain_id` (String) Domain ID of the authenticated user.
44+
- `user_domain_name` (String) Domain name of the authenticated user.
45+
- `user_id` (String) ID of the authenticated user.
46+
- `user_name` (String) Name of the authenticated user.
47+
48+
<a id="nestedatt--roles"></a>
49+
### Nested Schema for `roles`
50+
51+
Read-Only:
52+
53+
- `role_id` (String) Role ID.
54+
- `role_name` (String) Role name.

0 commit comments

Comments
 (0)