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.

Sign up for GitHub

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

Jump to bottom

Add specification document for control plane provider #1727

Closed
ncdc opened this issue Nov 6, 2019 · 18 comments
Closed

Add specification document for control plane provider #1727

ncdc opened this issue Nov 6, 2019 · 18 comments
Labels
area/control-plane Issues or PRs related to control-plane lifecycle management help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. 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.
Milestone
v0.3

Comments

@ncdc
Copy link
Contributor

ncdc commented Nov 6, 2019

We should add a specification document for what a control plane provider must do. For example, something like:

  • A control plane provider must provide a CustomResourceDefinition to represent provider-specific details for a control plane. For example, if your provider is Acme, a reasonable name for the CRD might be AcmeControlPlane.
  • The CRD must have spec and status
  • The CRD's status must have the following fields
    • Ready
    • ...
  • A control plane provider must reconcile its custom resources
    • ... Define required behaviors ...

etc.

/kind documentation
/priority important-soon
/milestone v0.3.0
@k8s-ci-robot k8s-ci-robot added this to the v0.3.0 milestone Nov 6, 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 Nov 6, 2019
@ncdc
Copy link
Contributor Author

ncdc commented Nov 6, 2019

Waiting for #1613 to be approved and merged

@ncdc ncdc mentioned this issue Nov 7, 2019
Merged
@randomvariable
Copy link
Member

/assign
/lifecycle active

@k8s-ci-robot k8s-ci-robot added the lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. label Dec 4, 2019
@randomvariable randomvariable mentioned this issue Dec 4, 2019
Closed
33 tasks
@randomvariable randomvariable removed their assignment Dec 16, 2019
@joonas
Copy link

joonas commented Dec 20, 2019

/assign @ncdc

@wfernandes
Copy link
Contributor

/area control-plane

@k8s-ci-robot k8s-ci-robot added the area/control-plane Issues or PRs related to control-plane lifecycle management label Jan 9, 2020
@randomvariable
Copy link
Member

Oh, this should have been closed by #1899
/close

@k8s-ci-robot
Copy link
Contributor

@randomvariable: Closing this issue.

In response to this:

Oh, this should have been closed by #1899
/close

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.

@ncdc
Copy link
Contributor Author

ncdc commented Jan 9, 2020

I was thinking this would look similar to the other spec docs (https://master.cluster-api.sigs.k8s.io/providers/cluster-infrastructure.html, https://master.cluster-api.sigs.k8s.io/providers/machine-infrastructure.html, https://master.cluster-api.sigs.k8s.io/providers/bootstrap.html). WDYT about moving the content from 1899 & adjusting its format?

@randomvariable
Copy link
Member

Yes, that makes sense.

/reopen

@k8s-ci-robot
Copy link
Contributor

@randomvariable: Reopened this issue.

In response to this:

Yes, that makes sense.

/reopen

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 k8s-ci-robot reopened this Jan 10, 2020
@ncdc ncdc mentioned this issue Jan 22, 2020
Closed
@vincepri
Copy link
Member

@randomvariable Are you actively working on this?

@randomvariable
Copy link
Member

Sorry @vincepri, I screwed up the timeline of this issue:
Originally marked as active as I did a version of the doc in #1899, but as @ncdc states, this should be split apart and moved as appropriate. I reopened the issue, but forgot to take off the lifecycle active marker.

/remove-lifecycle active

@k8s-ci-robot k8s-ci-robot removed the lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. label Feb 13, 2020
@vincepri
Copy link
Member

/help

@k8s-ci-robot
Copy link
Contributor

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

Please ensure the request meets the requirements listed here.

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

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 k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Feb 20, 2020
@vincepri
Copy link
Member

vincepri commented Mar 2, 2020

@dlipovetsky @detiber @chuckha @sethp-nr should we review what was merged in #1899 to see if anything changed and possibly adapt it to the format of the other spec documents?

@ncdc ncdc removed their assignment Mar 3, 2020
@vincepri
Copy link
Member

vincepri commented Mar 4, 2020

/milestone v0.3.x

@k8s-ci-robot k8s-ci-robot modified the milestones: v0.3.0, v0.3.x Mar 4, 2020
@vincepri
Copy link
Member

vincepri commented Mar 4, 2020

Bumping this from the milestone for now until we find someone that can tackle the issue

@vincepri
Copy link
Member

Closing due to inactivity

/close

@k8s-ci-robot
Copy link
Contributor

@vincepri: Closing this issue.

In response to this:

Closing due to inactivity

/close

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
Assignees
No one assigned
Labels
area/control-plane Issues or PRs related to control-plane lifecycle management help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. 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.
Projects
None yet
Milestone
v0.3
Development

No branches or pull requests
6 participants
@ncdc @joonas @randomvariable @wfernandes @vincepri @k8s-ci-robot