Repository navigation
merge queue: merged #88: align CSI-Addons specifications with the CSI specification format - #90
Closed
mergify[bot] wants to merge 8 commits into
Closed
mergify[bot] wants to merge 8 commits into
mergify[bot] wants to merge 8 commits into
Conversation
Bring the VolumeReplication spec to CSI specification documentation parity: - replace the placeholder '# spec' title; add Notational Conventions (RFC 2119) - add an Error Handling section that documents the gRPC status conventions (status.message / status.details) and the error codes common to all RPCs, and leave only RPC-specific codes (NOT_FOUND, FAILED_PRECONDITION, UNAVAILABLE) in each per-RPC table, mirroring the CSI spec's structure - add a high-level description, capability statement (VolumeReplication VOLUME_REPLICATION / GET_REPLICATION_DESTINATION_INFO) and idempotency/behavioral semantics to every RPC - rename the generic '#### Error Scheme' headings to '#### <RPC> Errors' - add a description for ReplicationSource - fix typos (avaiable, retrived, 'in not replicated', 'a unknown') - add the 'Replication Source cannot be enabled' (9 FAILED_PRECONDITION) row to EnableVolumeReplication to match the reference implementation (enableReplicationKnownErrors in volumereplication_controller.go) - GetVolumeReplicationInfo documents status as REQUIRED (matching the proto), and DisableVolumeReplication states a single rule for a missing source (NOT_FOUND) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
- add Notational Conventions (RFC 2119), Terminology, Objective/Goals/Non-Goals, Solution Overview, Architecture and Secrets Requirements sections - add an Error Handling section with the gRPC status conventions and the error codes common to all RPCs; leave only RPC-specific codes in each per-RPC table, mirroring the CSI spec - state the objective's modify/query RPCs as capability-gated, consistent with the per-RPC capability requirements - promote the RPC/Errors headings so heading levels increment by one - correct the gRPC code for 'Volumes cannot be grouped together' from the wrong '7 FAILED_PRECONDITION' to '9 FAILED_PRECONDITION' (code 7 is PERMISSION_DENIED) - fix 'PRC' typos Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
- add Notational Conventions (RFC 2119) and an Architecture section - add an Error Handling section with the gRPC status conventions and the error codes common to all RPCs; each per-RPC Errors section references it and defines no additional codes, mirroring the CSI spec - add a description, capability statement (NetworkFence NETWORK_FENCE / GET_CLIENTS_TO_FENCE) and behavioral/idempotency semantics to every RPC, plus a description for ClientDetails - remove the unused 'DR' terminology entry Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
- add Notational Conventions (RFC 2119) and an Architecture section - add an Error Handling section with the gRPC status conventions and the error codes common to all RPCs; the EncryptionKeyRotate Errors table keeps only the RPC-specific NOT_FOUND code, mirroring the CSI spec - add a high-level EncryptionKeyRotate description, capability statement (EncryptionKeyRotation) and behavioral/retry semantics - add the 'Call not implemented' (UNIMPLEMENTED) common code, matching the controller's Unimplemented handling - normalise the title to 'CSI-Addons' and fix 'encrpytion'/'a unknown' typos Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
- add Notational Conventions (RFC 2119) and an Architecture section - add an Error Handling section with the gRPC status conventions and the error codes common to all RPCs; each per-RPC table keeps only RPC-specific codes (NOT_FOUND and the specialized UNIMPLEMENTED for storage that cannot reclaim), mirroring the CSI spec - add a high-level description, capability statement (ReclaimSpace OFFLINE for the Controller, ONLINE for the Node) and idempotency/behavioral semantics to both RPCs Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
- add Notational Conventions (RFC 2119) and an Error Handling section (gRPC status / status.message / status.details conventions) - add the 'general flow of the success case' example (GetIdentity, GetCapabilities, Probe) that the CSI Identity service documents Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
The top-level README listed only four of the operation specs. Add entries for the Identity service and the Encryption Key Rotation operation so every specification in the repository is linked from the index. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
|
Important Review skippedBot user detected. To trigger a single review, invoke the
|
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.
Note
This is a merge queue draft opened by Mergify. Its pull request has merged, and nobody needs to act on it.
Mergify opened it for batch urbane-axoa-pxov2a of the
defaultqueue, to test #88 before it merged intomain.🎉 What landed
Mergify merged its pull request into
main, then closed this draft:8bf9451This draft's code was built in this order:
mainat80d74f9Metadata for CI tooling, read by
mergify ciRequired conditions of queue rule
defaultfor mergecheck-success=test-lintcheck-success=test-protocgithub-review-approved[🛡 GitHub branch protection]Required conditions to stay in the queue
github-review-approved[🛡 GitHub branch protection]