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

Add documentation guide for how to implement a bootstrap provider #1559

Closed
detiber opened this issue Oct 16, 2019 · 12 comments
Closed

Add documentation guide for how to implement a bootstrap provider #1559

detiber opened this issue Oct 16, 2019 · 12 comments
Labels
area/bootstrap Issues or PRs related to bootstrap providers kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@detiber
Copy link
Member

detiber commented Oct 16, 2019

What steps did you take and what happened:

With #1545 we will no longer be able to point folks interested in creating a bootstrap provider towards CABPK as a reference implementation. We need to provide a replacement for this (could be docs, could be a test reference implementation, etc). The replacement should be sufficient to get started with a bootstrap provider without having to disentangle what is CAPI related vs CABPK related in the cluster-api repo.

/kind documentation
/priority important-soon
/milestone v0.3.0

related to: #1090 #1138

@k8s-ci-robot k8s-ci-robot added this to the v0.3.0 milestone Oct 16, 2019
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Oct 16, 2019
@avorima
Copy link
Contributor

avorima commented Dec 3, 2019

I'd like to tackle this. My plan is to add a reference implementation under bootstrap/example.

@detiber
Copy link
Member Author

detiber commented Dec 3, 2019

@avorima while I think it might be possible to do a full reference implementation as a submodule, I think it might be a bit too easy to accidentally re-use some of the top level tooling. It might be better to take a documentation first approach like this PR is doing for infrastructure providers: #1682

@avorima
Copy link
Contributor

avorima commented Dec 3, 2019

Good point. I'm using the CAPI docs/**/*.md files for a lot of reference as well. I'll write some docs then.

@ncdc ncdc changed the title Provide a replacement for the previous CABPK reference implementation for implementors Add documentation guide for how to implement a bootstrap provider Dec 6, 2019
@ncdc
Copy link
Contributor

ncdc commented Dec 20, 2019

@avorima are you still interested in working on this?

@avorima
Copy link
Contributor

avorima commented Jan 7, 2020

@ncdc Sorry for the late response. Yes, I'd still like to finish this.

Regarding the docs: IMO the initial steps for creating a bootstrap provider are implicitly documented in the implementer's guide for cluster providers. Should I assume the reader is aware of this and focus on the steps that are specific to bootstrap providers or should it be a self-contained section?

@ncdc
Copy link
Contributor

ncdc commented Jan 8, 2020

@avorima I'm tempted to say self-contained, or find some way to reorganize the cluster one so that there's a common section and then sections specific to cluster & bootstrap providers. @vincepri wdyt?

@ncdc ncdc added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Jan 22, 2020
@ncdc ncdc modified the milestones: v0.3.0, Next Jan 29, 2020
@vincepri
Copy link
Member

This should be potentially an extension of the current guide we already have today https://cluster-api.sigs.k8s.io/developer/providers/implementers-guide/overview.html

@vincepri
Copy link
Member

/area bootstrap

@k8s-ci-robot k8s-ci-robot added the area/bootstrap Issues or PRs related to bootstrap providers label Apr 20, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 19, 2020
@vincepri
Copy link
Member

/lifecycle frozen

@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 20, 2020
@vincepri
Copy link
Member

@k8s-ci-robot
Copy link
Contributor

@vincepri: Closing this issue.

In response to this:

/close

https://cluster-api.sigs.k8s.io/developer/providers/bootstrap.html

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/bootstrap Issues or PRs related to bootstrap providers kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests

6 participants