Skip to content

docs: add Kubernetes operator documentation#13

Open
JeffMboya wants to merge 21 commits intomainfrom
docs/kubernetes-operator
Open

docs: add Kubernetes operator documentation#13
JeffMboya wants to merge 21 commits intomainfrom
docs/kubernetes-operator

Conversation

@JeffMboya
Copy link
Copy Markdown
Contributor

@JeffMboya JeffMboya commented Mar 2, 2026

What type of PR is this?

This is a documentation update because it updates the Kubernetes Operator documentation.

What does this do?

Updates the Kubernetes Operator documentation with improved content.

Which issue(s) does this PR fix/relate to?

Noissue

Have you included tests for your changes?

Yes, manually tested

Did you document any new/modified features?

No modified feature

Notes

@JeffMboya JeffMboya force-pushed the docs/kubernetes-operator branch from 18f23c3 to 02b62c9 Compare March 4, 2026 14:06
- Add kubernetes-operator.mdx with installation and configuration guide
- Document PropletSet CRD with field descriptions and examples
- Add expected output examples for all kubectl commands
- Document monitoring, troubleshooting, and CRD reference
- Add 9 SVG diagrams for architecture, lifecycle state machines, and workflows
- Replace text-based ASCII diagrams with professional SVG images
- Add descriptive captions for all diagrams
- Include: architecture overview, MQTT communication flow, scheduler algorithm,
  task execution paths, and lifecycle diagrams for Proplet, Task, PropellerJob,
  FederatedJob, and TrainingRound
- Link to SuperMQ docs on first mention in both files
- Add links to CRD, Proplet spec, and Task spec references
- Add intro paragraph pointing to main docs for complete reference
… tables

- Fix monitoringProfile.intervalMs (int) -> interval (metav1.Duration)
- Fix monitoringProfile.collectFds -> collectFileDescriptors
- Add missing monitoringProfile.historySize field to CRD reference table
- Fix ErrDeadProplets typo -> ErrDeadProplers to match codebase
- Align all markdown tables in kubernetes-operator docs and examples
@JeffMboya JeffMboya force-pushed the docs/kubernetes-operator branch from b6e4d3c to 8b55a97 Compare March 18, 2026 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant