📖 New Provider documentation #1682

liztio · 2019-10-29T21:12:22Z

What this PR does / why we need it:
We want everyone to use Cluster API, exapnding our reach to the stars above!

So we should make it easier to get started with a new provider.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1090

docs/book/provider_implementations/building_running_and_testing.md

ncdc

Thanks for working on this. A great start!

docs/book/provider_implementations/overview.md

docs/book/provider_implementations/generate_crds.md

docs/book/provider_implementations/create_api.md

docs/book/provider_implementations/populate_controllers.md

docs/book/provider_implementations/register_controllers.md

docs/book/provider_implementations/building_running_and_testing.md

detiber · 2019-10-30T20:06:28Z

docs/book/provider_implementations/naming.md

+Every Kubernetes resource has a *Group*, *Version* and *Kind* that uniquely 
+identifies it.
+
+* The resource *Kind* is the short name of the API, for example, 


A Kind here would be MailgunMachine - the spec and status structs are not exposed as Kubernetes GVKs.
and MailgunMachineList as well.

detiber · 2019-10-30T20:07:13Z

docs/book/provider_implementations/naming.md

+  API for `Machine` resources.
+* The resource *Version* defines the stability of the API and its backward 
+  compatibility guarantees. Examples include v1alpha1, v1beta1, v1, etc.
+  and are governed by the Kubernetes API Deprecation Policy [^1].


I think we should set the expectations that we expect providers to also abide by the k8s api deprecation policy as well.

detiber · 2019-10-30T20:08:23Z

docs/book/provider_implementations/naming.md

+
+{% sample lang="yaml" %}
+```yaml
+apiVersion: mailgun.cluster.k8s.io/v1alpha1


Should this be mailgun.infrastructure.cluster.x-k8s.io instead to align with the other infrastructure providers? (at least until we potentially change that)

docs/book/provider_implementations/overview.md

liztio · 2019-11-01T15:04:47Z

I only pushed this PR so I could have a backup and view the netlify responses, it's not quite ready for review yet

liztio · 2019-11-01T15:20:02Z

I started from a check-out of the v1 docs and am slowly updating them, that's why you see so much outdated information

liztio · 2019-11-15T20:14:07Z

/retest

liztio · 2019-11-26T19:47:56Z

@detiber @ncdc this is ready for review!

liztio · 2019-11-26T19:52:28Z

A more general question: I build capm for this, but I'm not sure where the code should live. We could leave it in my own repo, move it to kubernetes-sigs, or vendor it into this repo. I don't have strong feelings either way.

liztio · 2019-11-26T20:25:32Z

/retest

docs/book/src/providers/implementers-guide/generate_crds.md

docs/book/src/providers/implementers-guide/naming.md

docs/book/src/providers/implementers-guide/overview.md

docs/book/src/providers/implementers-guide/building_running_and_testing.md

config/default/manager_image_patch.yaml

ncdc · 2019-12-04T17:53:00Z

LGTM. Squash please!

ncdc · 2019-12-04T19:08:57Z

/lgtm

detiber · 2019-12-04T20:46:35Z

/assign

ncdc · 2019-12-04T20:52:22Z

/approve

k8s-ci-robot · 2019-12-04T20:52:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liztio, ncdc

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ncdc]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

detiber

Non-blocking issues found, filed #1831 to address them as a followup.

detiber · 2019-12-04T20:59:53Z

docs/book/src/providers/implementers-guide/generate_crds.md

+git init
+```
+
+You'll then need to set up [go modules][gomod]


Broken link

detiber · 2019-12-04T21:08:28Z

docs/book/src/providers/implementers-guide/create_api.md

+	// Request is where you ask extra nicely
+	Request string `json:"request"`
+    // Requester is the email of the person sending the request
+    Requester string


missing json tag, and different indentation.

detiber · 2019-12-04T21:16:06Z

docs/book/src/providers/implementers-guide/building_running_and_testing.md

+
+Before you can deploy the infrastructure controller, you'll need to deploy Cluster API itself.
+
+You can [use a precompiled manifest][install], or clone [`cluster-api`][capi] and apply its manifests using `kustomize`.


capi link is broken

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 29, 2019

k8s-ci-robot requested review from justinsb and randomvariable October 29, 2019 21:12

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 29, 2019

ncdc added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 30, 2019

ncdc reviewed Oct 30, 2019

View reviewed changes

docs/book/provider_implementations/building_running_and_testing.md Outdated Show resolved Hide resolved

ncdc suggested changes Oct 30, 2019

View reviewed changes

detiber reviewed Oct 30, 2019

View reviewed changes

liztio force-pushed the provider-docs branch 2 times, most recently from 7d0e44f to 09bb93b Compare November 15, 2019 19:48

liztio force-pushed the provider-docs branch from 09bb93b to 90547bc Compare November 15, 2019 20:17

liztio force-pushed the provider-docs branch from 91b9582 to 313a860 Compare November 25, 2019 20:40

liztio changed the title ~~[wip] 📖 New Provider documentation~~ 📖 New Provider documentation Nov 26, 2019

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 26, 2019

ncdc reviewed Nov 26, 2019

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 3, 2019

liztio force-pushed the provider-docs branch from 80c052d to 7ef13dd Compare December 3, 2019 16:57

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 3, 2019

ncdc suggested changes Dec 3, 2019

View reviewed changes

config/default/manager_image_patch.yaml Outdated Show resolved Hide resolved

liztio force-pushed the provider-docs branch from 7ef13dd to 1c52894 Compare December 3, 2019 18:54

detiber mentioned this pull request Dec 3, 2019

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

Closed

liztio force-pushed the provider-docs branch from 1c52894 to 1c0bff3 Compare December 4, 2019 17:40

ncdc approved these changes Dec 4, 2019

View reviewed changes

v1alpha3-compliant cluster API provideri implementor's guide

8505b27

liztio force-pushed the provider-docs branch from 1c0bff3 to 8505b27 Compare December 4, 2019 18:43

k8s-ci-robot assigned ncdc Dec 4, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 4, 2019

k8s-ci-robot assigned detiber Dec 4, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 4, 2019

k8s-ci-robot merged commit 065e0e0 into kubernetes-sigs:master Dec 4, 2019

detiber mentioned this pull request Dec 4, 2019

Fixes needed for infrastructure provider implementer guide #1831

Closed

detiber reviewed Dec 4, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 New Provider documentation #1682

📖 New Provider documentation #1682

liztio commented Oct 29, 2019

ncdc left a comment

detiber Oct 30, 2019

detiber Oct 30, 2019

detiber Oct 30, 2019

liztio commented Nov 1, 2019

liztio commented Nov 1, 2019

liztio commented Nov 15, 2019

liztio commented Nov 26, 2019

liztio commented Nov 26, 2019

liztio commented Nov 26, 2019

ncdc commented Dec 4, 2019

ncdc commented Dec 4, 2019

detiber commented Dec 4, 2019

ncdc commented Dec 4, 2019

k8s-ci-robot commented Dec 4, 2019

detiber left a comment

detiber Dec 4, 2019

detiber Dec 4, 2019

detiber Dec 4, 2019


		Before you can deploy the infrastructure controller, you'll need to deploy Cluster API itself.

		You can [use a precompiled manifest][install], or clone [`cluster-api`][capi] and apply its manifests using `kustomize`.

📖 New Provider documentation #1682

📖 New Provider documentation #1682

Conversation

liztio commented Oct 29, 2019

ncdc left a comment

Choose a reason for hiding this comment

detiber Oct 30, 2019

Choose a reason for hiding this comment

detiber Oct 30, 2019

Choose a reason for hiding this comment

detiber Oct 30, 2019

Choose a reason for hiding this comment

liztio commented Nov 1, 2019

liztio commented Nov 1, 2019

liztio commented Nov 15, 2019

liztio commented Nov 26, 2019

liztio commented Nov 26, 2019

liztio commented Nov 26, 2019

ncdc commented Dec 4, 2019

ncdc commented Dec 4, 2019

detiber commented Dec 4, 2019

ncdc commented Dec 4, 2019

k8s-ci-robot commented Dec 4, 2019

detiber left a comment

Choose a reason for hiding this comment

detiber Dec 4, 2019

Choose a reason for hiding this comment

detiber Dec 4, 2019

Choose a reason for hiding this comment

detiber Dec 4, 2019

Choose a reason for hiding this comment