Add noderef controller documentation to gitbook #1066
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri 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:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
added
the
cncf-cla: yes
|
/assign @davidewatson |
k8s-ci-robot
added
the
size/S
| @@ -1,5 +1,8 @@ | |||
| # Node Controller | |||
|
|
|||
| > NOTE: This controller is going to be deprecated in v1alpha2, | |||
There was a problem hiding this comment.
Would it be ok to remove the node controller now, instead of saying it's deprecated?
There was a problem hiding this comment.
Probably not, I know for example that the vSphere provider was relying on it at one point.
There was a problem hiding this comment.
Agreed, we should remove the node controller in v1alpha2. It's actually already part of #1051
There was a problem hiding this comment.
It might be better to actually call this out as deprecated now, and state that it will be removed in v1alpha2, otherwise some may interpret this as it will still exist in a deprecated state for v1alpha2.
There was a problem hiding this comment.
Good point, just reworded
There was a problem hiding this comment.
Does it need to remain in master now, though?
There was a problem hiding this comment.
@davidewatson will probably have a better answer, but I think that the gitbook is served from master
There was a problem hiding this comment.
@vincepri is correct, the book is served from master. To see a preview you can click the details of the deploy/netlify stage...
|
|
||
| Infrastructure providers can opt-in to use this controller by providing a KubeConfig as a Kubernetes Secret. | ||
| The secret must be stored in the namespace the Cluster lives in and named as `<cluster-name>-kubeconfig`, | ||
| the data should only contain a single key called `value` and its data should be a valid Kubernetes KubeConfig. |
There was a problem hiding this comment.
@chuckha looks like we're using kubeconfig in the upgrade tool but CAPI is expecting value - I guess we should switch the upgrade tool?
vincepri
force-pushed
the
noderef-controller-docs
branch
from
2632924 to
5c6e1bb
Compare
Signed-off-by: Vince Prignano <[email protected]>
vincepri
force-pushed
the
noderef-controller-docs
branch
from
5c6e1bb to
758f856
Compare
|
/test pull-cluster-api-test |
|
#1052 has merged... |
k8s-ci-robot
added
the
lgtm
Signed-off-by: Vince Prignano [email protected]
What this PR does / why we need it:
This PR adds noderef controller docs to gitbook
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 #
Special notes for your reviewer:
Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.
Release note: