kubernetes-sigs / kubernetes-sigs/cluster-api
Update Doc for Managed k8s service
- Dominant language
- Go
- Stars
- 4.3k
- Forks
- 1.6k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 113
Description
**User Story**
As a Cluster API provider developer, I would like to have a doc describing clear contracts between CAPI and providers for managed k8s service.
**Detailed Description**
When [Managed Kubernetes in CAPI proposal](https://github.com/kubernetes-sigs/cluster-api/pull/6988) is approved, CAPI doc should be updated to reflect the chosen API option.
This is not an exhaustive list and feel free to add items in the comments.
- [ ] A new "implementing managed kubernetes" guide that contains details about how to represent a managed Kubernetes service in CAPI. The content will be based on the selected option from the proposal along with other considerations such as managed node and addon management.
- [ ] Update the [Provider contracts documentation](https://cluster-api.sigs.k8s.io/developer/providers/contracts.html) to state that the same kind should not be used to satisfy 2 different provider contracts.
- [ ] Update the [Cluster Infrastructure documentation](https://cluster-api.sigs.k8s.io/developer/providers/cluster-infrastructure.html) to provide guidance on how to populate the `controlPlaneEndpoint` in the scenario where the control plane creates the api server load balancer. We should include sample code.
- [ ] Update the [Control Plane Controller](https://cluster-api.sigs.k8s.io/developer/architecture/controllers/control-plane.html) diagram for managed k8s services case. The Control Plane reconcile needs to start when `InfrastructureReady` is true.
Contributor guide
Research direction
Start by reviewing the Managed Kubernetes in CAPI proposal linked in the issue, then inspect the Provider contracts, Cluster Infrastructure, and Control Plane Controller documentation pages. Update the documentation for the selected managed-service API option, including the provider-contract guidance, controlPlaneEndpoint sample, and reconciliation diagram; done means all listed checklist items are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100