Docs: document every driver option and split contributor docs - #246
Merged
Conversation
The Usage section pointed at kitchen.ci and documented no driver options. The clouds.yaml and OS_* documentation added recently was good, but it covered only credentials, so the other 24 default_config keys and the options read directly from config appeared nowhere in the repo. Adds a full configuration reference grouped by concern: image and flavor, instance, networking, waiting and timeouts, API and endpoints. Every default_config key is documented with its real default, along with cloud_config, disable_ssl_validation, flavor_id, flavor_ref, image_id, image_ref, server_wait and user_data, which are read from config but never declared through the DSL. Calls out the two mutually exclusive pairs explicitly. Setting both image_ref and image_id, or both flavor_ref and flavor_id, raises ActionFailed, as does combining cloud_config with user_data. Adds a quick start, a block device mapping section, and examples for floating IPs, multiple networks, cloud-init, slow images, and per-platform images. Leads with Cinc Workstation and adds a "Using with Chef" section. Move the Development section into a new CONTRIBUTING.md, noting that kitchen diagnose is the way to see the settings actually in effect, since the driver merges clouds.yaml into its config in finalize_config!. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Tim Smith <tsmith84@proton.me>
tas50
force-pushed
the
docs-readme-overhaul
branch
from
August 22, 2026 20:47
4516528 to
d83fa41
Compare
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.
What
Adds a complete configuration reference, a quick start, and a
CONTRIBUTING.md.Why
The
clouds.yaml/OS_*documentation added recently is genuinely good — but it covers credentials only. The Usage section immediately below it said:So the other 24
default_configkeys — image, flavor, networking, floating IPs, timeouts — plus 8 options read directly fromconfigwere documented nowhere in the repo.README
source openrc.sh, since that's the path most OpenStack users already have workingclouds.yamldocs rather than duplicating themcinc kitchencommands, and a "Using with Chef" sectionEvery option is now documented. That includes
cloud_config,disable_ssl_validation,flavor_id,flavor_ref,image_id,image_ref,server_waitanduser_data, which are read fromconfigbut never declared throughdefault_config.Mutually exclusive options
Three pairs raise
ActionFailedif you set both halves, which wasn't written down anywhere:image_ref+image_idflavor_ref+flavor_idcloud_config+user_dataThe tables now say so at the point you'd reach for them.
CONTRIBUTING.md
New file, absorbing the README's Development section. It notes that
kitchen diagnoseis the way to see the settings actually in effect — the driver mergesclouds.yamlinto its config duringfinalize_config!, so diagnose reflects the combined result ofclouds.yaml,OS_*, andkitchen.yml. That's the fastest way to characterise a credential-precedence bug.The maintenance note (OSU Open Source Lab) is carried across.
Docs only — no code changes.