kubernetes-sigs/cluster-api

Update Doc for Managed k8s service

Open

#7,032 opened on Aug 5, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (1,532 forks)auto 404
help wantedkind/documentationlifecycle/stalepriority/backlogtriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

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 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 to state that the same kind should not be used to satisfy 2 different provider contracts.
  • Update the Cluster Infrastructure documentation 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 diagram for managed k8s services case. The Control Plane reconcile needs to start when InfrastructureReady is true.

Contributor guide

Research direction
Review the approved proposal (PR #6988) and the existing documentation pages mentioned. Understand the API options chosen and then update the relevant docs accordingly. Focus on the four specific checklist items: creating a new guide, updating provider contracts, cluster infrastructure, and control plane controller diagram.
Tech stack
go
Domain
backendinfrastructuredocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75