Create documentation for setting up and using the out-of-tree provider

kubernetes / cloud-provider-gcp

cloud-provider-gcp contains several projects used to run Kubernetes in Google Cloud

Apache License 2.0

114 stars 204 forks source link

Create documentation for setting up and using the out-of-tree provider #686

Open shannonxtreme opened 3 months ago

shannonxtreme commented 3 months ago

Related issues: #664 #359

With the in-tree provider becoming obsolete, we need basic documentation that covers the following:

Key concepts about the out-of-tree provider (what is it, why/when would you use it, components and architecture)
Basic set up and configuration of the out-of-tree provider (what core components use the --cloud-provider config, IAM requirements, GCP VPC requirements)
Migration from the in-tree provider (high-level migration overview with best practices to minimize unexpected disruptions)

Collaborators: @aojea @BenTheElder

/assign

shannonxtreme commented 3 months ago

From #664 - the CI manifest is a good source of info for a "Install the GCP provider" task: https://github.com/kubernetes/cloud-provider-gcp/blob/25e5dcc715781316bc5e39f8b17c0d5b313453f7/deploy/packages/default/manifest.yaml

shannonxtreme commented 3 months ago

Content plan here: https://docs.google.com/document/d/1NuY8PAIw41SHNfuOoiuBqmWGnn-h0fhZt2MpxtWN_nw/edit?usp=sharing

BenTheElder commented 3 months ago

/triage accepted /priority important-soon (TBH I could about call this critical-urgent, but I think that's reserved for "clusters are on fire/vulnerable right now", this will be critical-urgent by the end of 1.31 cycle if we're not there yet)

Thank you @shannonxtreme 🙏

shannonxtreme commented 3 months ago

Plan is approved, drafted the content for conceptual section: https://docs.google.com/document/d/1RLb3V-ci-Sz54C4jh8ucPRFnIBpNXewmoQ3PMmV0RNY/edit

mrala commented 2 weeks ago

Hi! Is there an ETA for when the documentation for using the out-of-tree provider will be updated?

BenTheElder commented 2 weeks ago

@shannonxtreme has a very detailed draft and @aojea has been reviewing it, but there's no specific ETA, I think everyone involved is juggling many things and chipping away at this part time 😅

shannonxtreme commented 2 weeks ago

Yeah lol that sums it up. I have to change up my instructions, I'd originally drafted from a live migration perspective but haven't been able to get my nodes annotated with the ProviderID, so I have to go with the create a cluster from scratch flow instead