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

redirect to vSphere cloud provider docs in cloud providers page #16778

Merged
merged 1 commit into from
Oct 27, 2019
Merged

redirect to vSphere cloud provider docs in cloud providers page #16778

merged 1 commit into from
Oct 27, 2019

Conversation

andrewsykim
Copy link
Member

Signed-off-by: Andrew Sy Kim [email protected]

The vSphere cloud provider has a docs site at https://cloud-provider-vsphere.sigs.k8s.io, we should redirect vSphere users there in the "Cloud Providers" page.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 9, 2019
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Oct 9, 2019
@andrewsykim
Copy link
Member Author

/assign @dvonthenen

@andrewsykim
Copy link
Member Author

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 9, 2019
@netlify
Copy link

netlify bot commented Oct 9, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 99eac71

https://deploy-preview-16778--kubernetes-io-master-staging.netlify.com

@netlify
Copy link

netlify bot commented Oct 9, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 104ff5b

https://deploy-preview-16778--kubernetes-io-master-staging.netlify.com

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's some feedback.


### Node Name
The in-tree vSphere cloud provider is recommended if you are running vSphere < 6.7u3. Quick start for the in-tree cloud provider can be found [here](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/k8s-vcp-on-vsphere-with-kubeadm.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The in-tree vSphere cloud provider is recommended if you are running vSphere < 6.7u3. Quick start for the in-tree cloud provider can be found [here](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/k8s-vcp-on-vsphere-with-kubeadm.html).
If you are running vSphere < 6.7u3, VMware recommend you use the in-tree vSphere cloud provider. See [Running a Kubernetes Cluster on vSphere with kubeadm](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/k8s-vcp-on-vsphere-with-kubeadm.html) for a quick start guide.


The VSphere cloud provider uses the detected hostname of the node (as determined by the kubelet) as the name of the Kubernetes Node object.
For all vSphere deployments on vSphere >= 6.7u3, the [external vSphere cloud provider](https://github.com/kubernetes/cloud-provider-vsphere) - along with the [vSphere CSI driver](https://github.com/kubernetes-sigs/vsphere-csi-driver) - is recommended. Quick start for the external cloud provider can be found [here](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/kubernetes-on-vsphere-with-kubeadm.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For all vSphere deployments on vSphere >= 6.7u3, the [external vSphere cloud provider](https://github.com/kubernetes/cloud-provider-vsphere) - along with the [vSphere CSI driver](https://github.com/kubernetes-sigs/vsphere-csi-driver) - is recommended. Quick start for the external cloud provider can be found [here](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/kubernetes-on-vsphere-with-kubeadm.html)
For all vSphere deployments on vSphere >= 6.7u3, VMware recommend the [external vSphere cloud provider](https://github.com/kubernetes/cloud-provider-vsphere), along with the [vSphere CSI driver](https://github.com/kubernetes-sigs/vsphere-csi-driver). See [Running a Kubernetes Cluster on vSphere with kubeadm](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/k8s-vcp-on-vsphere-with-kubeadm.html) for a quick start guide.


The `--hostname-override` parameter is ignored by the VSphere cloud provider.
For in-depth documentation on the vSphere cloud provider, visit the docs site at https://cloud-provider-vsphere.sigs.k8s.io/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a hyperlink here.


### Node Name
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As there are two options, consider using tabs.

@davidvonthenen
Copy link

Good feedback... plus, I learned about using tabs. 😀

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 10, 2019
@davidvonthenen
Copy link

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Oct 10, 2019
@andrewsykim
Copy link
Member Author

@sftim thanks for the feedback, comments addressed


{{< tabs name="vSphere cloud provider" >}}
{{% tab name="vSphere >= 6.7U3" %}}
For all vSphere deployments on vSphere >= 6.7U3, VMware recommends the [external vSphere cloud provider](https://github.com/kubernetes/cloud-provider-vsphere), along with the [vSphere CSI driver](https://github.com/kubernetes-sigs/vsphere-csi-driver). See [Deploying a Kubernetes Cluster on vSphere with CSI and CPI](https://cloud-provider-vsphere.sigs.k8s.io/tutorials/kubernetes-on-vsphere-with-kubeadm.html) for a quick start guide.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it make sense here to point to CAPV? could be a nice way to get started quickly with vSphere consuming the out-of-tree components mentioned here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes -- but I personally don't think we should be prescriptive to deployment solutions in the cloud provider docs.

@andrewsykim
Copy link
Member Author

andrewsykim commented Oct 16, 2019

/hold cancel

Comments addressed, PTAL

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 16, 2019
@sftim
Copy link
Contributor

sftim commented Oct 17, 2019

Thinking about this more, I'm not 100% comfortable with “VMWare recommends X”. It'd be more in line with the style guide (and the rest of the page) to write “use X” instead.
However I don't know if that's enough of a concern to block a merge.

@andrewsykim
Copy link
Member Author

I agree, I think "VMware recommends" is too prescriptive for kubernetes.io docs. I think just :

For all vSphere deployments on vSphere >= 6.7U3, the external vSphere cloud provider is recommended

👍 ?

@zparnold
Copy link
Member

/approve
pending @sftim 's lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zparnold

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2019
@andrewsykim
Copy link
Member Author

@sftim updated wording per your suggestion, PTAL :)

@sftim
Copy link
Contributor

sftim commented Oct 27, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 27, 2019
@k8s-ci-robot k8s-ci-robot merged commit f53c6e1 into kubernetes:master Oct 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants