docs(config): clarify no-statefile model and local/cloud pull+deploy usage#52
Open
tkkhq wants to merge 3 commits into
Open
docs(config): clarify no-statefile model and local/cloud pull+deploy usage#52tkkhq wants to merge 3 commits into
tkkhq wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Documents Volcano’s live-diff, no-state-file reconciliation model and retry behavior after partial apply failures.
Changes:
- Clarifies partial failure reporting and retries.
- Adds guidance for users familiar with Terraform.
- Documents live planning and unsupported Terraform concepts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| the plan from scratch. | ||
| - No workspaces, no `-target`: the whole manifest reconciles against the | ||
| currently selected project (`volcano use` / `VOLCANO_PROJECT_ID`) as one | ||
| unit. To leave something alone, omit it from the file. |
tkkhq
changed the title
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
volcano-config.yaml(companion to https://github.com/Kong/volcano-hosting/pull/564) and the previously-unstated apply-phase-failure exit behavior.pull) and apply-to-cloud (deploy) are already implemented and shipped commands, not something to build:volcano cloud config pullexports a cloud project's current configuration to a file, andvolcano cloud config deployapplies a manifest file to a cloud project (mirroring the local-modevolcano config pull/deploy). Added a table and a concretelogin→use→pull→ edit →deploy --dry-run→deploywalkthrough so this isn't easy to miss when skimming the doc.Why
Verified against
internal/cmd/cloud/cloud.go(which wires the sameconfigcmd.New(deps)under thecloudnamespace) and by building the CLI and runningvolcano cloud config pull --help/volcano cloud config deploy --help— both commands exist today and are part of the current release chain (present inv0.0.6-nightly.20260713.1). No CLI code changes were needed; the gap was that the doc undersold cloud usage next to the local-mode examples.Scope
Documentation only — no behavior change.