Merge pull request #29 from platform9/feat/cluster-blueprint

feat(resmgr): cluster-blueprint family — REST client + host_config/host_role/host_config_assignment + blueprint DS

Author: PF9-pushkar

CHANGELOG.md

@@ -90,6 +90,13 @@ All notable changes to this project are documented here. The format is based on
   provider). Imported by a composite `<project_id>/<region>` ID (legacy bare `<project_id>` is
   also accepted). Cinder per-volume-type quotas (`volume_type_quota`) are not yet implemented.
 
+- Cluster blueprint / host management (PCD `resmgr` API — the first non-OpenStack, non-gophercloud
+  service): a thin `resmgr` v2 REST client (`clients.Config.ResmgrV2Client()`, endpoint resolved
+  from the Keystone catalog, token via the shared ProviderClient) plus `pcd_host_config` (interface
+  ↔ traffic-type mapping and physical-network labels), `pcd_host_role` (assign a role such as
+  `pf9-ostackhost-neutron` to a host), `pcd_host_config_assignment` (attach a host config to a host),
+  and a `pcd_cluster_blueprint` data source (read a blueprint by name). The `pcd_cluster_blueprint`
+  resource (write path) is tracked separately — see DECISIONS.md.
 - Registry documentation generation wired via `tfplugindocs` (`make generate`) — renders
   `docs/` for every resource and data source plus the provider index from schema
   descriptions. Generated docs are produced on demand / at release and are not committed.

DECISIONS.md

@@ -103,6 +103,28 @@ Both PENDING items are lab-side configuration gaps (Platform9 / lab-ops), not pr
 defects; their acceptance tests flip green on a properly-configured PCD cloud.
 
 
+## 2026-07-13 — api-docs coverage: PCD-native services (resmgr / cluster blueprint)
+
+An audit of `docs.platform9.com/api-docs` (7 services) vs the provider found the
+OpenStack-service families fully/near-covered, but two PCD-native services entirely
+unbuilt: **cluster-blueprint** (`resmgr/v2`) and **kubernetes** (PCD-K/CAPI). Tier-2
+gaps (blockstorage volume_type/snapshot/backup, identity group) were closed first
+(#26, #27).
+
+For the cluster-blueprint family, `resmgr` is the first **non-OpenStack** service, so it
+gets a hand-written REST client (`Config.ResmgrV2Client()`) that resolves the `resmgr`
+catalog endpoint and reuses the authenticated ProviderClient for tokens (verified live
+against the CE lab). Shipped: `pcd_host_config`, `pcd_host_role`,
+`pcd_host_config_assignment`, and a `pcd_cluster_blueprint` **data source**.
+
+**The `pcd_cluster_blueprint` resource (write path) is deliberately deferred to a focused
+follow-up.** Its object is uniquely hairy: a full-object `PUT` (partial models risk
+clearing fields), a `storageBackends` map that carries **plaintext driver credentials**,
+and create semantics (`POST` vs `PUT`) that cannot be safely verified without mutating the
+lab's single working blueprint. It deserves its own careful pass. The mutating resmgr
+resources' acceptance tests are opt-in (`PCD_ACC_RESMGR`) so they never touch a live
+cluster by accident.
+
 ## 2026-07-12 — backed out code PCD does not ship (VPNaaS, Octavia L7)
 
 Live inspection of the CE lab's service catalog (all 14 services + the Octavia provider

examples/data-sources/pcd_cluster_blueprint/data-source.tf

@@ -0,0 +1,3 @@
+data "pcd_cluster_blueprint" "example" {
+  name = "ce-cluster"
+}

examples/resources/pcd_host_config/import.sh

@@ -0,0 +1 @@
+terraform import pcd_host_config.example <host_config_id>

examples/resources/pcd_host_config/resource.tf

@@ -0,0 +1,8 @@
+resource "pcd_host_config" "example" {
+  name           = "hc-single-nic"
+  mgmt_interface = "enp1s0"
+
+  network_labels = {
+    physnet1 = "enp1s0"
+  }
+}

examples/resources/pcd_host_config_assignment/import.sh

@@ -0,0 +1 @@
+terraform import pcd_host_config_assignment.example <host_id>/<host_config_id>

examples/resources/pcd_host_config_assignment/resource.tf

@@ -0,0 +1,10 @@
+resource "pcd_host_config" "example" {
+  name           = "hc-single-nic"
+  mgmt_interface = "enp1s0"
+  network_labels = { physnet1 = "enp1s0" }
+}
+
+resource "pcd_host_config_assignment" "example" {
+  host_id        = "04575315-80ce-4617-9b96-6611d00c9942"
+  host_config_id = pcd_host_config.example.id
+}

examples/resources/pcd_host_role/import.sh

@@ -0,0 +1 @@
+terraform import pcd_host_role.example <host_id>/<role_name>

examples/resources/pcd_host_role/resource.tf

@@ -0,0 +1,5 @@
+# host_id is the resmgr host UUID of an onboarded host.
+resource "pcd_host_role" "example" {
+  host_id   = "04575315-80ce-4617-9b96-6611d00c9942"
+  role_name = "pf9-ostackhost-neutron"
+}

internal/clients/config.go

@@ -235,6 +235,30 @@ func (c *Config) BlockStorageV3Client() (*gophercloud.ServiceClient, error) {
 	return client, nil
 }
 
+// ResmgrV2Client returns a client for the PCD resource manager (`resmgr`) v2
+// API. resmgr is a Platform9-specific REST service (not part of OpenStack, so it
+// has no gophercloud constructor); it backs cluster blueprints, host configs,
+// and host role/config assignment. The endpoint is resolved from the Keystone
+// catalog (service type `resmgr`) and the shared authenticated ProviderClient
+// supplies the token, so requests use `client.Get/Post/Put/Delete`.
+func (c *Config) ResmgrV2Client() (*gophercloud.ServiceClient, error) {
+	url, err := c.Provider.EndpointLocator(gophercloud.EndpointOpts{
+		Type:         "resmgr",
+		Region:       c.Region,
+		Availability: gophercloud.AvailabilityPublic,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("pcd: locating resmgr endpoint: %w", err)
+	}
+	client := &gophercloud.ServiceClient{
+		ProviderClient: c.Provider,
+		Endpoint:       strings.TrimRight(url, "/") + "/v2/",
+		Type:           "resmgr",
+	}
+	c.applyOverride(client, "resmgr")
+	return client, nil
+}
+
 // LoadBalancerV2Client returns an Octavia v2 service client, honoring an
 // endpoint_overrides entry for the "load-balancer" service type if present.
 func (c *Config) LoadBalancerV2Client() (*gophercloud.ServiceClient, error) {