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 machine infrastructure provider #1725

Closed
ncdc opened this issue Nov 6, 2019 · 3 comments · Fixed by #1865
Closed

Add specification document for machine infrastructure provider #1725

ncdc opened this issue Nov 6, 2019 · 3 comments · Fixed by #1865
Assignees
@ncdc
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone
v0.3.0

Comments

@ncdc
Copy link
Contributor

ncdc commented Nov 6, 2019

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

  • A machine infrastructure provider must provide a CustomResourceDefinition to represent provider-specific details for machine infrastructure. For example, if your provider is Acme, a reasonable name for the CRD might be AcmeMachine.
  • The CRD must have spec and status
  • The CRD's status must have the following fields
    • Ready
    • ...
  • A machine infrastructure 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
@chuckha
Copy link
Contributor

chuckha commented Nov 8, 2019

Most of this is covered https://cluster-api.sigs.k8s.io/architecture/controllers/machine.html

@ncdc
Copy link
Contributor Author

ncdc commented Nov 8, 2019

I'll probably work on adapting it to a slightly different format. Thanks.

@ncdc
Copy link
Contributor Author

ncdc commented Dec 3, 2019

/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 3, 2019
@ncdc ncdc mentioned this issue Dec 10, 2019
Merged
@detiber detiber mentioned this issue Dec 26, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ncdc ncdc

Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. 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.0
Development

Successfully merging a pull request may close this issue.

📖 Add machine infra provider spec doc ncdc/cluster-api
3 participants
@ncdc @chuckha @k8s-ci-robot