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

Update minikube documentation #19756

Merged

Conversation

cwansart
Copy link
Contributor

@cwansart cwansart commented Mar 20, 2020

This pull request updates the outdated Minikube documentation using the deprecated --vm-driver parameter, which was replaced by --driver. It also updates the driver lists in all localizations and removing xhyve which does not exist anymore.

@k8s-ci-robot
Copy link
Contributor

Welcome @cwansart!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. language/de Issues or PRs related to German language language/en Issues or PRs related to English language language/es Issues or PRs related to Spanish language language/fr Issues or PRs related to French language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 20, 2020
@netlify
Copy link

netlify bot commented Mar 20, 2020

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

Built with commit 23f955b

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 20, 2020
@sftim
Copy link
Contributor

sftim commented Mar 20, 2020

Hi @cwansart and thanks for this PR.
To make reviewing easier, we'd like you to limit reviews to a single language.

This is partly because we probably don't have reviewers who speak all of the languages that you want to change, and mostly because we need a signoff from each language team that a PR touches before we can merge it. (The robot that decides on approval can't tell a code-only change from a change that affects the localized text).

Also, different localization teams use different branching strategies - see https://kubernetes.io/docs/contribute/start#choose-which-git-branch-to-use

Would you be willing to save the non-English changes for the future and revise this to just change the en localization?

@cwansart
Copy link
Contributor Author

Hey @sftim sure, I can do that.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 20, 2020
@cwansart
Copy link
Contributor Author

Done. The others will follow. I first need to check for their way of handling pull requests.

@gochist
Copy link
Member

gochist commented Mar 20, 2020

/remove-language de
/remove-language es
/remove-language fr
/remove-language ja
/remove-language ko
/remove-language ru
/remove-language vi
/remove-language zh

@k8s-ci-robot k8s-ci-robot removed language/de Issues or PRs related to German language language/es Issues or PRs related to Spanish language language/fr Issues or PRs related to French language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language labels Mar 20, 2020
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.

/approve
Needs a technical LGTM (I haven't checked this is accurate)

```
Minikube supports the following drivers:
{{< note >}}
See [DRIVERS](https://git.k8s.io/minikube/docs/drivers.md) for details on supported drivers and how to install
See [DRIVERS](https://minikube.sigs.k8s.io/docs/reference/drivers/) for details on supported drivers and how to install
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
See [DRIVERS](https://minikube.sigs.k8s.io/docs/reference/drivers/) for details on supported drivers and how to install
See [Drivers](https://minikube.sigs.k8s.io/docs/reference/drivers/) for details on supported drivers and how to install

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 21, 2020
@spurin
Copy link
Contributor

spurin commented Mar 23, 2020

Non-member feedback:

/lgtm

The minikube start --driver approach worked as per the advice, in my case I tested with docker

james@ubuntu-throwaway-2:~$ minikube start --driver=docker
* minikube v1.8.2 on Ubuntu 18.04
* Using the docker driver based on user configuration
* Downloading preloaded images tarball for k8s v1.17.3 ...
    > preloaded-images-k8s-v1-v1.17.3-docker-overlay2.tar.lz4: 499.26 MiB / 499
* Creating Kubernetes in docker container with (CPUs=2) (2 available), Memory=1993MB (1993MB available) ...
* Preparing Kubernetes v1.17.3 on Docker 19.03.2 ...
  - kubeadm.pod-network-cidr=10.244.0.0/16
* Launching Kubernetes ...
* Enabling addons: default-storageclass, storage-provisioner
* Waiting for cluster to come online ...
* Done! kubectl is now configured to use "minikube"

All of the updated links, resolve accordingly and take you to the expected target references.

On a mac, I can confirm that the step for checking VMX, worked as expected

$ sysctl -a | grep -E --color 'machdep.cpu.features|VMX'
machdep.cpu.features: FPU VME DE PSE TSC MSR PAE MCE CX8 APIC SEP MTRR PGE MCA CMOV PAT PSE36 CLFSH DS ACPI MMX FXSR SSE SSE2 SS HTT TM PBE SSE3 PCLMULQDQ DTES64 MON DSCPL VMX EST TM2 SSSE3 FMA CX16 TPR PDCM SSE4.1 SSE4.2 x2APIC MOVBE POPCNT AES PCID XSAVE OSXSAVE SEGLIM64 TSCTMR AVX1.0 RDRAND F16C

The guidance for using --driver=none also worked as expected -

james@ubuntu-throwaway-2:~$ sudo minikube start --driver=none
* minikube v1.8.2 on Ubuntu 18.04
* Using the none driver based on user configuration
* Running on localhost (CPUs=2, Memory=1993MB, Disk=63340MB) ...
* OS release is Ubuntu 18.04.2 LTS
* Preparing Kubernetes v1.17.3 on Docker 19.03.4 ...
  - kubelet.resolv-conf=/run/systemd/resolve/resolv.conf
    > kubectl.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
    > kubeadm.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
    > kubelet.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
    > kubeadm: 37.52 MiB / 37.52 MiB [---------------] 100.00% 18.59 MiB p/s 2s
    > kubectl: 41.48 MiB / 41.48 MiB [---------------] 100.00% 16.30 MiB p/s 3s
    > kubelet: 106.42 MiB / 106.42 MiB [-------------] 100.00% 26.08 MiB p/s 4s
* Launching Kubernetes ...
* Enabling addons: default-storageclass, storage-provisioner
* Configuring local host environment ...
*
! The 'none' driver provides limited isolation and may reduce system security and reliability.
! For more information, see:
  - https://minikube.sigs.k8s.io/docs/reference/drivers/none/
*
! kubectl and minikube configuration will be stored in /home/james
! To use kubectl or minikube commands as your own user, you may need to relocate them. For example, to overwrite your own settings, run:
*
  - sudo mv /home/james/.kube /home/james/.minikube $HOME
  - sudo chown -R $USER $HOME/.kube $HOME/.minikube
*
* This can also be done automatically by setting the env var CHANGE_MINIKUBE_NONE_USER=true
* Waiting for cluster to come online ...
* Done! kubectl is now configured to use "minikube"

Hope this helps the review process.

@k8s-ci-robot
Copy link
Contributor

@spurin: changing LGTM is restricted to collaborators

In response to this:

Non-member feedback:

/lgtm

The minikube start --driver approach worked as per the advice, in my case I tested with docker

james@ubuntu-throwaway-2:~$ minikube start --driver=docker
* minikube v1.8.2 on Ubuntu 18.04
* Using the docker driver based on user configuration
* Downloading preloaded images tarball for k8s v1.17.3 ...
   > preloaded-images-k8s-v1-v1.17.3-docker-overlay2.tar.lz4: 499.26 MiB / 499
* Creating Kubernetes in docker container with (CPUs=2) (2 available), Memory=1993MB (1993MB available) ...
* Preparing Kubernetes v1.17.3 on Docker 19.03.2 ...
 - kubeadm.pod-network-cidr=10.244.0.0/16
* Launching Kubernetes ...
* Enabling addons: default-storageclass, storage-provisioner
* Waiting for cluster to come online ...
* Done! kubectl is now configured to use "minikube"

All of the updated links, resolve accordingly and take you to the expected target references.

On a mac, I can confirm that the step for checking VMX, worked as expected

$ sysctl -a | grep -E --color 'machdep.cpu.features|VMX'
machdep.cpu.features: FPU VME DE PSE TSC MSR PAE MCE CX8 APIC SEP MTRR PGE MCA CMOV PAT PSE36 CLFSH DS ACPI MMX FXSR SSE SSE2 SS HTT TM PBE SSE3 PCLMULQDQ DTES64 MON DSCPL VMX EST TM2 SSSE3 FMA CX16 TPR PDCM SSE4.1 SSE4.2 x2APIC MOVBE POPCNT AES PCID XSAVE OSXSAVE SEGLIM64 TSCTMR AVX1.0 RDRAND F16C

The guidance for using --driver=none also worked as expected -

james@ubuntu-throwaway-2:~$ sudo minikube start --driver=none
* minikube v1.8.2 on Ubuntu 18.04
* Using the none driver based on user configuration
* Running on localhost (CPUs=2, Memory=1993MB, Disk=63340MB) ...
* OS release is Ubuntu 18.04.2 LTS
* Preparing Kubernetes v1.17.3 on Docker 19.03.4 ...
 - kubelet.resolv-conf=/run/systemd/resolve/resolv.conf
   > kubectl.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
   > kubeadm.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
   > kubelet.sha256: 65 B / 65 B [--------------------------] 100.00% ? p/s 0s
   > kubeadm: 37.52 MiB / 37.52 MiB [---------------] 100.00% 18.59 MiB p/s 2s
   > kubectl: 41.48 MiB / 41.48 MiB [---------------] 100.00% 16.30 MiB p/s 3s
   > kubelet: 106.42 MiB / 106.42 MiB [-------------] 100.00% 26.08 MiB p/s 4s
* Launching Kubernetes ...
* Enabling addons: default-storageclass, storage-provisioner
* Configuring local host environment ...
*
! The 'none' driver provides limited isolation and may reduce system security and reliability.
! For more information, see:
 - https://minikube.sigs.k8s.io/docs/reference/drivers/none/
*
! kubectl and minikube configuration will be stored in /home/james
! To use kubectl or minikube commands as your own user, you may need to relocate them. For example, to overwrite your own settings, run:
*
 - sudo mv /home/james/.kube /home/james/.minikube $HOME
 - sudo chown -R $USER $HOME/.kube $HOME/.minikube
*
* This can also be done automatically by setting the env var CHANGE_MINIKUBE_NONE_USER=true
* Waiting for cluster to come online ...
* Done! kubectl is now configured to use "minikube"

Hope this helps the review process.

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.

@spurin
Copy link
Contributor

spurin commented Mar 23, 2020

/approve
Needs a technical LGTM (I haven't checked this is accurate)

@sftim please see my recent comment, hopefully this assists on the technical review aspect.

@sftim
Copy link
Contributor

sftim commented Mar 24, 2020

/hold
pending v1.18 Kubernetes release

@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 Mar 24, 2020
@tengqm
Copy link
Contributor

tengqm commented Mar 26, 2020

/hold cancel
/lgtm
/approve

@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 Mar 26, 2020
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 26, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim, tengqm

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 merged commit fca1d58 into kubernetes:master Mar 26, 2020
fancc pushed a commit to fancc/website that referenced this pull request Apr 26, 2020
* Update vm-driver param and driver links

* Fix mistakes

* Fix spaces

* Revert "Fix spaces"

This reverts commit c08906d

* Revert "Fix mistakes"

This reverts commit c6c14b6

* Revert "Update vm-driver param and driver links"

This reverts commit 164729d

* Update vm-driver param and driver links
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