cluster-api icon indicating copy to clipboard operation
cluster-api copied to clipboard

Update Doc for Managed k8s service

Open pydctw opened this issue 3 years ago • 3 comments

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.

pydctw avatar Aug 05 '22 22:08 pydctw

@pydctw: The label(s) kind/doc cannot be applied, because the repository doesn't have them.

In response to this:

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 needs to be updated to reflect the chosen API option.

This is not an exhaustive list and we will be adding new items.

  • [ ] 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.

/kind doc

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Aug 05 '22 22:08 k8s-ci-robot

/kind documentation

pydctw avatar Aug 05 '22 22:08 pydctw

/help /triage accepted

fabriziopandini avatar Sep 30 '22 19:09 fabriziopandini

@fabriziopandini: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to this:

/help /triage accepted

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Sep 30 '22 19:09 k8s-ci-robot

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Feb 08 '23 06:02 k8s-triage-robot

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

  • Confirm that this issue is still relevant with /triage accepted (org members only)
  • Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

k8s-triage-robot avatar Feb 08 '24 07:02 k8s-triage-robot

Unfortunately this issue isn't gaining traction, but keeping it around because improvement to the documentation will be more than welcome

/triage accepted /priority backlog

fabriziopandini avatar Mar 29 '24 16:03 fabriziopandini