Fix incorrect filename references in Kubernetes documentation #281
Conversation
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
8 tasks
Co-authored-by: sfroment <[email protected]>
Copilot
AI
changed the title
[WIP] Update leader election implementation based on review feedback
Fix incorrect filename references in Kubernetes documentation
Dec 3, 2025
sfroment
approved these changes
Dec 3, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes broken documentation by correcting all filename references from the non-existent deploy.sequencer.yaml to the actual file stateful.sequencer.yaml in the Kubernetes guide, resolving confusion and command failures for users.
- Updated 7 filename references throughout the Kubernetes documentation
- Ensured consistency across manifest descriptions, configuration instructions, and command examples
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sfroment
added a commit
that referenced
this pull request
Dec 3, 2025
* init: add k8s yaml * feat: add k8s leader election logic * add: k8s yamls * mod: add k8s leader shutdown * add: k8s node yaml * fix: use pv&pvc to maintain status on k8s * chore: yaml && add docs * feat: mod batch producer load batch number when it starts (#272) * fix: cargo.toml * chore: toml * mod: k8s + ovh * chore: lint Signed-off-by: Sacha Froment <[email protected]> * chore: fix here we have 2 result imbricated Signed-off-by: Sacha Froment <[email protected]> * chore: change a bit Signed-off-by: Sacha Froment <[email protected]> * feat: add node deploy Signed-off-by: Sacha Froment <[email protected]> * chore: fix potential race Signed-off-by: Sacha Froment <[email protected]> * chore: update docs Signed-off-by: Sacha Froment <[email protected]> * chore: use anyhow error Signed-off-by: Sacha Froment <[email protected]> * refactor: change the way the main is started" (#275) * chore: add health check Signed-off-by: Sacha Froment <[email protected]> * refactor: change the way the main is started Signed-off-by: Sacha Froment <[email protected]> * chore: nitpick * mod: k8s yaml * chore: remove command in justfile * chore: fix just sequencer & node , fix kill process in start.sh * chore: rm * refactor: coordination k8s (#276) * refactor: coordination k8s Signed-off-by: Sacha Froment <[email protected]> * chore: save Signed-off-by: Sacha Froment <[email protected]> * chore: keep health alive Signed-off-by: Sacha Froment <[email protected]> * fix: start Signed-off-by: Sacha Froment <[email protected]> * Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]> * chore: remove useless Signed-off-by: Sacha Froment <[email protected]> * chore: review comment Signed-off-by: Sacha Froment <[email protected]> * chore: add back save on shutdown Signed-off-by: Sacha Froment <[email protected]> --------- Signed-off-by: Sacha Froment <[email protected]> Co-authored-by: Copilot <[email protected]> * Update justfile Co-authored-by: Copilot <[email protected]> * Update cmd/sequencer/src/main.rs Co-authored-by: Copilot <[email protected]> * Update cmd/sequencer/src/cli.rs Co-authored-by: Copilot <[email protected]> * Update cmd/node/src/cli.rs Co-authored-by: Copilot <[email protected]> * Update cmd/sequencer/src/cli.rs Co-authored-by: Copilot <[email protected]> * Update justfile Co-authored-by: Copilot <[email protected]> * chore: fix 1st call Signed-off-by: Sacha Froment <[email protected]> * Refactor: Use idiomatic assert! in CLI tests (#277) * Initial plan * Replace if-panic patterns with assert! in CLI tests Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> * Fix missing assert in CLI test for command parsing (#278) * Initial plan * Fix matches! macro usage in sequencer CLI tests Added assert! around matches! calls in parse_stop_and_get_pub_key test to properly verify command types instead of just evaluating the boolean. Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> --------- Signed-off-by: Sacha Froment <[email protected]> Co-authored-by: Giwook-Han <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: sfroment <[email protected]> * chore: lint Signed-off-by: Sacha Froment <[email protected]> * chore: lint Signed-off-by: Sacha Froment <[email protected]> * chore: fix registry Signed-off-by: Sacha Froment <[email protected]> * Update docs/k8s.md Co-authored-by: Copilot <[email protected]> * Update docs/k8s.md Co-authored-by: Copilot <[email protected]> * Fix StatefulSet name references in k8s documentation (#283) * Initial plan * Fix StatefulSet name references in k8s documentation Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> * Fix documentation references to use correct StatefulSet manifest filename (#282) * Initial plan * Fix documentation: update references from deploy.sequencer.yaml to stateful.sequencer.yaml Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> * Fix incorrect filename references in Kubernetes documentation (#281) * Initial plan * Fix all references from deploy.sequencer.yaml to stateful.sequencer.yaml Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> * Consolidate shutdown logic in K8s leader election error handling (#284) * Initial plan * Call shutdown() on error paths to ensure consistent cleanup Co-authored-by: sfroment <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sfroment <[email protected]> * fix: healt.port Signed-off-by: Sacha Froment <[email protected]> --------- Signed-off-by: Sacha Froment <[email protected]> Co-authored-by: Sacha Froment <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: sfroment <[email protected]>
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.
Why is this change necessary?
Documentation referenced
deploy.sequencer.yamlat multiple locations, but the actual file is namedstateful.sequencer.yaml, causing broken commands and confusion for users following the guide.Description
Updated all 7 references in
docs/k8s.md:All references now correctly point to
k8s/stateful.sequencer.yamlto match the actual file in the repository.Closes #271
Type of change
Checklist
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.