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

Add some Docker Machine documentation #4829

Closed
afbjorklund opened this issue Jul 20, 2019 · 14 comments
Closed

Add some Docker Machine documentation #4829

afbjorklund opened this issue Jul 20, 2019 · 14 comments
Assignees
Labels
co/generic-driver co/hyperkit Hyperkit related issues co/hyperv HyperV related issues co/kvm2-driver KVM2 driver related issues co/none-driver co/virtualbox kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@afbjorklund
Copy link
Collaborator

Since Minikube uses Docker Machine to create and provision the VM,
it could be nice to have some more "advanced" docs on (lib)machine ?

We used to have a reference to https://github.com/docker/machine,
but it's not posted anymore on our new website (for some reason).

Also, some of the user docs are available on https://docs.docker.com/

And some non-official drivers live on https://github.com/machine-drivers


I think these are quite nice, and could serve as "inspiration" for minikube docs:

https://docs.docker.com/toolbox/overview/

https://docs.docker.com/machine/overview/

It also needs some technical documentation, but most of that is yet to be written...

The focus will be on these drivers:

  • virtualbox (default) - all
  • generic (remote) - all
  • none (local) - linux

And on these future-proof drivers:

  • kvm2 (libvirt) - linux
  • hyperkit - darwin
  • hyperv - windows
@afbjorklund afbjorklund added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 20, 2019
@afbjorklund afbjorklund self-assigned this Jul 20, 2019
@afbjorklund afbjorklund added co/virtualbox co/kvm2-driver KVM2 driver related issues co/hyperkit Hyperkit related issues co/hyperv HyperV related issues co/none-driver co/generic-driver labels Jul 23, 2019
@RA489
Copy link

RA489 commented Jul 25, 2019

@afbjorklund can we create separate documentation on Docker Machine?

@RA489
Copy link

RA489 commented Jul 25, 2019

we can place docker_machine.md file here wdyt?
https://github.com/kubernetes/minikube/tree/master/docs

@afbjorklund
Copy link
Collaborator Author

It's mostly about writing, I don't think we lack a place to put it (in the README and the docs)

The upstream docs live in this monster repository: https://github.com/docker/docker.github.io

@tstromberg tstromberg added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Aug 8, 2019
@afbjorklund
Copy link
Collaborator Author

@tstromberg : this was the issue were we can clear up things about "generic" and "none".

As long as we are using libmachine we should keep the upstream driver names in the code, but we can of course introduce some aliases and start referring to them with different names in minikube ?

https://docs.docker.com/machine/drivers/ (basically: virtualbox, hyper-v)

I did some initial attempts at describing these, will see if I can find those lines and add them here. Both drivers are really small, and the Driver API isn't all that big to start with (slightly unfortunately).

https://godoc.org/github.com/docker/machine/libmachine/drivers#Driver

Since github.com/docker/machine is frozen, it's very unlikely that anything will change there. 😔

@nanikjava
Copy link
Contributor

@afbjorklund Happy to help out in writing documentation for this. Do you have any idea what specifically will be needed ? as there are few URL that was discussed here so bit lost and will need bit of direction on this.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 7, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 6, 2020
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

@afbjorklund
Copy link
Collaborator Author

/remove-lifecycle rotten

More and more of libmachine is getting rewritten now, but still useful to have it documented...

@afbjorklund afbjorklund reopened this Mar 27, 2020
@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 27, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 25, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 25, 2020
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
co/generic-driver co/hyperkit Hyperkit related issues co/hyperv HyperV related issues co/kvm2-driver KVM2 driver related issues co/none-driver co/virtualbox kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests

6 participants