Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
shannonxtreme opened this issue May 7, 2024 · 7 comments
Assignees
Labels
priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@shannonxtreme
Copy link

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

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 7, 2024
@shannonxtreme
Copy link
Author

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
Copy link
Author

@BenTheElder
Copy link
Member

/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 🙏

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 7, 2024
@shannonxtreme
Copy link
Author

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

@mrala
Copy link

mrala commented Aug 7, 2024

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

@BenTheElder
Copy link
Member

@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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

4 participants