docs: import-ID lookups and a Community Edition example (PCD-9784) - #51
Merged
Conversation
Records the lab-verified facts (import needs the volume type UUID, pcdctl needs a sourced RC and OS_INSECURE on CE, where the resmgr host UUID comes from, import blocks with generated config), the approved decisions, and the two deliverables: registry guides plus per-resource import lookups, and the first-party docs handoff.
…PCD-9784) Every resource's Import section now names the pcdctl command (or resmgr call) that prints the ID it needs, and links a new Importing guide that covers CLI setup, terraform import versus import blocks with generated configuration, a per-resource lookup table, the resmgr host UUID, and a worked blueprint import. README's PCD-native table gains pcd_cluster and pcd_host_cluster_role.
The volume type, blueprint resource, and blueprint data source descriptions now say what volume_backend_name selects, that image_library_storage names a volume type, and what shape storage_backends_json takes; the two examples pair an NFS backend with its volume type.
examples/complete/community-edition/ builds a region from one prepared host to a running instance with an attached NFS-backed volume; the new guide renders those files with tffile so the published text and the runnable configuration cannot drift.
Applied and destroyed examples/complete/community-edition on a CE 2026.4 lab with an NFS backend whose two key levels differ. pcd_host_cluster_role.backends names the second-level (driver configuration) keys, not the top-level backend names; the top-level key becomes volume_backend_name on the host. Boolean driver options must be JSON booleans: quoted strings never validate and the host converges forever. The provider already uploads images to the image-library host's 9494 endpoint, so the guide states the reachability requirement. The Destroy section records the three-run teardown (image backing volume, HostClusterDeleteFailed, HostInAuthState).
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs-only change for PCD-9784: every registry page that imports by a PCD-assigned ID now says how to look that ID up, and the registry carries a lab-validated, runnable zero-to-VM configuration for Community Edition. Along the way the lab run exposed two things the docs had wrong.
What changed
docs/guides/importing.md): CLI setup (pcdctlRC file,OS_INSECUREon CE),terraform importversusimportblocks with-generate-config-out, a per-resource lookup table for every importable resource, the resmgr host UUID and the host-config/blueprint/cluster lookups, and a worked blueprint import.import.sh(52 resources) carries the lookup command above the import line, so each registry page's Import section answers "where does this ID come from". The resource template links the guide.docs/guides/community-edition.md) rendered from a runnableexamples/complete/community-edition/: volume type, blueprint with an NFS backend, host config, cluster, three cluster roles, provider network, CirrOS image, flavor, instance with an attached volume.pcd_host_cluster_role.backends: it lists the second-level keys ofstorage_backends_json(the driver configuration names), not the top-level backend names as the description said. The top-level key is what becomesvolume_backend_nameon the host. The mistake was invisible while every example used the same name at both levels.pcd_blockstorage_volume_typeandpcd_cluster_blueprintdescriptions and examples explain thevolume_backend_name/storage_backends_json/image_library_storagelinkage and the JSON shape; README's PCD-native table addspcd_clusterandpcd_host_cluster_role.Validated on the CE lab (2026.4, provider built from this branch)
storage_backends_jsoncomes outnull # sensitive).pcdctlservice commands need the sourced RC file plusOS_INSECURE=trueon CE; every command cited in the guide was run.nfs/nfs-primary): resmgr computed[nfs-primary]withvolume_backend_name = nfs, the volume type routed a volume to it, the image uploaded to the image-library host, the instance booted and answered ping, plan clean.backendsyields an empty backend set and a host stuck converging (resmgr 409s every role change); boolean driver options written as quoted strings never validate on the host and it converges forever.HostClusterDeleteFailed,HostInAuthState); the guide's Destroy section walks through it. Region left empty.Pages touched
docs/guides/importing.md,docs/guides/community-edition.md(new);docs/resources/*.md(Import sections);docs/resources/blockstorage_volume_type.md,cluster_blueprint.md,host_cluster_role.md,docs/data-sources/cluster_blueprint.md;README.md;CHANGELOG.md; the sources undertemplates/,examples/, and the three schema descriptions ininternal/.Release
Docs-only
v0.1.11after merge, so the registry renders the guides before the first-party page links to them.