Remove Vagrantfile and remove it from all docs #4281

Merged
merged 1 commit into from Feb 24, 2014

Conversation

Projects
None yet
@unclejack
Contributor

unclejack commented Feb 21, 2014

This removes the Vagrantfile and updates the documentation to remove the steps which explain how to install Docker in a VM via Vagrant.

This PR also modifies the Windows install guide to use boot2docker.

There are a few reasons for removing the Vagrantfile and the docs which explain how to install Docker via virtual machines using Vagrant:

  • Vagrant and VirtualBox need to be downloaded and installed on the machine; Vagrant was an unnecessary dependency for the EC2 example
  • The Vagrant boxes aren't provided via HTTPS and they're large downloads. They'd still remain large downloads even if we made our own images available via HTTPS.
  • Vagrant relies on virtual box guest additions to set up the virtual machines. This is a problem because the guest additions need to be kept up to date when upgrading VirtualBox.
  • The VirtualBox guest additions ISO file isn't available via HTTPS.
  • Provisioning a new Vagrant virtual machine takes a long time and Vagrant's VirtualBox VM hangs at the boot prompt on OS X sometimes. This can be fixed, but this doesn't fix the other problems.
  • The user has to download Vagrant and VirtualBox. The vagrant box needs to be downloaded as well if the user didn't already have everything set up and didn't use the Vagrant box we require.
  • Windows really needs a simple and easy to set up package. The guide required more steps to follow and tools to be set up on Windows.
@tianon

This comment has been minimized.

Show comment
Hide comment
@tianon

tianon Feb 21, 2014

Member

LGTM

Member

tianon commented Feb 21, 2014

LGTM

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 Feb 21, 2014

Contributor
  1. I'd add some mention of boot2docker in the FAQ.
  2. It seems odd to totally remove Windows before we have a solution for it. I'd leave it there and then replace it with an actual Windows package when we have such a beast.
Contributor

jamtur01 commented Feb 21, 2014

  1. I'd add some mention of boot2docker in the FAQ.
  2. It seems odd to totally remove Windows before we have a solution for it. I'd leave it there and then replace it with an actual Windows package when we have such a beast.
@unclejack

This comment has been minimized.

Show comment
Hide comment
@unclejack

unclejack Feb 21, 2014

Contributor

@jamtur01 I'll prepare an alternative guide for Windows based on VirtualBox and boot2docker. Where do you think it'd be best to mention boot2docker in the FAQ?

Contributor

unclejack commented Feb 21, 2014

@jamtur01 I'll prepare an alternative guide for Windows based on VirtualBox and boot2docker. Where do you think it'd be best to mention boot2docker in the FAQ?

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 Feb 21, 2014

Contributor

The same question you updated. Although @SvenDowideit it'd be worth popping in an FAQ question or two on boot2docker as well.

Contributor

jamtur01 commented Feb 21, 2014

The same question you updated. Although @SvenDowideit it'd be worth popping in an FAQ question or two on boot2docker as well.

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 Feb 21, 2014

Contributor

Actually looking at the new Go based boot2docker we could probably write Windows install docs using that - @SvenDowideit?

Contributor

jamtur01 commented Feb 21, 2014

Actually looking at the new Go based boot2docker we could probably write Windows install docs using that - @SvenDowideit?

@unclejack

This comment has been minimized.

Show comment
Hide comment
@unclejack

unclejack Feb 21, 2014

Contributor

@jamtur01 I've made the changes you've suggested.

Contributor

unclejack commented Feb 21, 2014

@jamtur01 I've made the changes you've suggested.

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 Feb 21, 2014

Contributor

Broadly LGTM. /cc @metalivedev @SvenDowideit

Contributor

jamtur01 commented Feb 21, 2014

Broadly LGTM. /cc @metalivedev @SvenDowideit

@vieux

This comment has been minimized.

Show comment
Hide comment
@vieux

vieux Feb 21, 2014

Collaborator

I see vagrant in http://docs.docker.io/en/latest/contributing/devenvironment/

Collaborator

vieux commented Feb 21, 2014

I see vagrant in http://docs.docker.io/en/latest/contributing/devenvironment/

@vieux

This comment has been minimized.

Show comment
Hide comment
@vieux

vieux Feb 21, 2014

Collaborator

and in http://docs.docker.io/en/latest/

Collaborator

vieux commented Feb 21, 2014

and in http://docs.docker.io/en/latest/

@vieux

This comment has been minimized.

Show comment
Hide comment
@vieux

vieux Feb 21, 2014

Collaborator

Shoud we grep the docs and remove completely each mention of vagrant ?

Collaborator

vieux commented Feb 21, 2014

Shoud we grep the docs and remove completely each mention of vagrant ?

docs/sources/installation/windows.rst
Installation
------------
.. include:: install_header.inc
-.. include:: install_unofficial.inc
+1. Install virtualbox from https://www.virtualbox.org - or follow this tutorial: http://www.slideshare.net/julienbarbier42/install-virtualbox-on-windows-7

This comment has been minimized.

@metalivedev

metalivedev Feb 21, 2014

Contributor

I think www.virtualbox.org is short enough to keep in the text, but Julien's tutorial URL is a bit long and would look better as a link to this tutorial by Julien Barbier

Same comment about links/URLs in the steps below.

@metalivedev

metalivedev Feb 21, 2014

Contributor

I think www.virtualbox.org is short enough to keep in the text, but Julien's tutorial URL is a bit long and would look better as a link to this tutorial by Julien Barbier

Same comment about links/URLs in the steps below.

docs/sources/installation/windows.rst
-2. Install vagrant from http://www.vagrantup.com - or follow this tutorial__
+4. Create a new Virtual machine with the following settings: `Name: boot2docker`, `Type: Linux`, `Version: Linux 2.6 (64 bit)`, `Memory size: 1024 MB`, `Hard drive: Do not add a virtual hard drive`.

This comment has been minimized.

@metalivedev

metalivedev Feb 21, 2014

Contributor

This list of settings would scan better as a bulleted list:

  • Name: boot2docker
  • Type: Linux
  • Version: `Linux 2.6 (64 bit)

... etc.

Also, why do we limit this VM with no hard drive?

@metalivedev

metalivedev Feb 21, 2014

Contributor

This list of settings would scan better as a bulleted list:

  • Name: boot2docker
  • Type: Linux
  • Version: `Linux 2.6 (64 bit)

... etc.

Also, why do we limit this VM with no hard drive?

docs/sources/installation/windows.rst
-.. __: http://www.slideshare.net/julienbarbier42/install-vagrant-on-windows-7
+5. Open the settings of the virtual machines, go to Storage, click the empty slot below `Controller: IDE`, click the disc icon on the right of `IDE Secondary Master` and click `Choose a virtual CD/DVD disk file`.

This comment has been minimized.

@metalivedev

metalivedev Feb 21, 2014

Contributor

I'm tempted to say this should also be a list, but its a sequence of steps in a GUI. We don't have a great style for that in text. Suggestions?

@metalivedev

metalivedev Feb 21, 2014

Contributor

I'm tempted to say this should also be a list, but its a sequence of steps in a GUI. We don't have a great style for that in text. Suggestions?

docs/sources/installation/windows.rst
- :align: center
-
-All done!
+This will download the small busybox image and print hellow world.

This comment has been minimized.

@metalivedev

metalivedev Feb 21, 2014

Contributor

hello :-)

@metalivedev

metalivedev Feb 21, 2014

Contributor

hello :-)

@@ -24,6 +24,6 @@ For a high-level overview of Docker, please see the `Introduction
Docker, we have a `quick start <http://www.docker.io/gettingstarted>`_
and a more in-depth guide to :ref:`ubuntu_linux` and other
:ref:`installation_list` paths including prebuilt binaries,
-Vagrant-created VMs, Rackspace and Amazon instances.
+Rackspace and Amazon instances.

This comment has been minimized.

@thaJeztah

thaJeztah Feb 21, 2014

Member

Reading this, I noticed that DigitalOceans' Docker pre-built image is not mentioned anywhere in the dockumentation. Would it be worthwhile to include that somewhere? I don't have any experience with AWS and Rackspace to compare, but am currently fiddling with Docker on DigitalOcean and found it to be a quick way to get a Docker host running in no time.

Their tutorial can be found here (other, more in-depth tutorials exist as well);
How To Use the DigitalOcean Docker Application

@thaJeztah

thaJeztah Feb 21, 2014

Member

Reading this, I noticed that DigitalOceans' Docker pre-built image is not mentioned anywhere in the dockumentation. Would it be worthwhile to include that somewhere? I don't have any experience with AWS and Rackspace to compare, but am currently fiddling with Docker on DigitalOcean and found it to be a quick way to get a Docker host running in no time.

Their tutorial can be found here (other, more in-depth tutorials exist as well);
How To Use the DigitalOcean Docker Application

This comment has been minimized.

@shykes

shykes Feb 21, 2014

Collaborator

I think it would be great to have first-class Digital Ocean install
instructions in the official docs. I suggest opening a new issue or pull
request for that.

On Fri, Feb 21, 2014 at 3:11 PM, Sebastiaan van Stijn <
notifications@github.com> wrote:

In docs/sources/index.rst:

@@ -24,6 +24,6 @@ For a high-level overview of Docker, please see the Introduction Docker, we have aquick start http://www.docker.io/gettingstarted`_
and a more in-depth guide to :ref:ubuntu_linuxand other
:ref:installation_list paths including prebuilt binaries,
-Vagrant-created VMs, Rackspace and Amazon instances.
+Rackspace and Amazon instances.

Reading this, I noticed that DigitalOceans' Docker pre-built image is not
mentioned anywhere in the dockumentation. Would it be worthwhile to include
that somewhere? I don't have any experience with AWS and Rackspace to
compare, but am currently fiddling with Docker on DigitalOcean and found it
to be a quick way to get a Docker host running in no time.

Their tutorial can be found here (other, more in-depth tutorials exist as
well);
How To Use the DigitalOcean Docker Applicationhttps://www.digitalocean.com/community/articles/how-to-use-the-digitalocean-docker-application

Reply to this email directly or view it on GitHubhttps://github.com/dotcloud/docker/pull/4281/files#r9966225
.

@shykes

shykes Feb 21, 2014

Collaborator

I think it would be great to have first-class Digital Ocean install
instructions in the official docs. I suggest opening a new issue or pull
request for that.

On Fri, Feb 21, 2014 at 3:11 PM, Sebastiaan van Stijn <
notifications@github.com> wrote:

In docs/sources/index.rst:

@@ -24,6 +24,6 @@ For a high-level overview of Docker, please see the Introduction Docker, we have aquick start http://www.docker.io/gettingstarted`_
and a more in-depth guide to :ref:ubuntu_linuxand other
:ref:installation_list paths including prebuilt binaries,
-Vagrant-created VMs, Rackspace and Amazon instances.
+Rackspace and Amazon instances.

Reading this, I noticed that DigitalOceans' Docker pre-built image is not
mentioned anywhere in the dockumentation. Would it be worthwhile to include
that somewhere? I don't have any experience with AWS and Rackspace to
compare, but am currently fiddling with Docker on DigitalOcean and found it
to be a quick way to get a Docker host running in no time.

Their tutorial can be found here (other, more in-depth tutorials exist as
well);
How To Use the DigitalOcean Docker Applicationhttps://www.digitalocean.com/community/articles/how-to-use-the-digitalocean-docker-application

Reply to this email directly or view it on GitHubhttps://github.com/dotcloud/docker/pull/4281/files#r9966225
.

This comment has been minimized.

@thaJeztah

thaJeztah Feb 21, 2014

Member

I'll open an issue for adding DigitalOcean docs. Currently I'm focussing on learning Docker for setting up an in-house development server and haven't really gotten around learning GIT enough to feel confident enough to create pull request without messing up (LOL)

However, maybe adding an issue will attract some attention to have somebody do that. If not (and I find the time to do so), I will try to write-up something.

Keep up the good work! Even though there are still loads of rough edges, Docker is really awesome. I will try to help any way I can :)

@thaJeztah

thaJeztah Feb 21, 2014

Member

I'll open an issue for adding DigitalOcean docs. Currently I'm focussing on learning Docker for setting up an in-house development server and haven't really gotten around learning GIT enough to feel confident enough to create pull request without messing up (LOL)

However, maybe adding an issue will attract some attention to have somebody do that. If not (and I find the time to do so), I will try to write-up something.

Keep up the good work! Even though there are still loads of rough edges, Docker is really awesome. I will try to help any way I can :)

This comment has been minimized.

@shykes

shykes Feb 22, 2014

Collaborator

Thanks Sebastiaan, any help and feedback is appreciated! Don't hesitate to
ask for help at any time, we are very active on IRC and twitter.

On Fri, Feb 21, 2014 at 3:40 PM, Sebastiaan van Stijn <
notifications@github.com> wrote:

In docs/sources/index.rst:

@@ -24,6 +24,6 @@ For a high-level overview of Docker, please see the Introduction Docker, we have aquick start http://www.docker.io/gettingstarted`_
and a more in-depth guide to :ref:ubuntu_linuxand other
:ref:installation_list paths including prebuilt binaries,
-Vagrant-created VMs, Rackspace and Amazon instances.
+Rackspace and Amazon instances.

I'll open an issue for adding DigitalOcean docs. Currently I'm focussing
on learning Docker for setting up an in-house development server and
haven't really gotten around learning GIT enough to feel confident enough
to create pull request without messing up (LOL)

However, maybe adding an issue will attract some attention to have
somebody do that. If not (and I find the time to do so), I will try to
write-up something.

Keep up the good work! Even though there are still loads of rough edges,
Docker is really awesome. I will try to help any way I can :)

Reply to this email directly or view it on GitHubhttps://github.com/dotcloud/docker/pull/4281/files#r9967043
.

@shykes

shykes Feb 22, 2014

Collaborator

Thanks Sebastiaan, any help and feedback is appreciated! Don't hesitate to
ask for help at any time, we are very active on IRC and twitter.

On Fri, Feb 21, 2014 at 3:40 PM, Sebastiaan van Stijn <
notifications@github.com> wrote:

In docs/sources/index.rst:

@@ -24,6 +24,6 @@ For a high-level overview of Docker, please see the Introduction Docker, we have aquick start http://www.docker.io/gettingstarted`_
and a more in-depth guide to :ref:ubuntu_linuxand other
:ref:installation_list paths including prebuilt binaries,
-Vagrant-created VMs, Rackspace and Amazon instances.
+Rackspace and Amazon instances.

I'll open an issue for adding DigitalOcean docs. Currently I'm focussing
on learning Docker for setting up an in-house development server and
haven't really gotten around learning GIT enough to feel confident enough
to create pull request without messing up (LOL)

However, maybe adding an issue will attract some attention to have
somebody do that. If not (and I find the time to do so), I will try to
write-up something.

Keep up the good work! Even though there are still loads of rough edges,
Docker is really awesome. I will try to help any way I can :)

Reply to this email directly or view it on GitHubhttps://github.com/dotcloud/docker/pull/4281/files#r9967043
.

This comment has been minimized.

@thaJeztah

thaJeztah Feb 22, 2014

Member

Will do! I'm writing up my findings regarding Docker (in general) for my 'project'. Since I'm still having a 'fresh eye' on Docker, I'll see if there's anything in there that may assist in lifting Docker to the next level.

Biggest issues so far is offering a user-friendly way to orchestrate multiple dockers in a way that it's usable for the less-techy developers/members in our company. Although some projects exist, there's (to my knowledge) not a clear winner or 'de-facto' way to do this. For the time being, I may end up using a combination of Shipyard and some in-house tool for simple tasks. The docker roadmap does mention orchestration, but I couldn't find when this is scheduled for implementation. Since Docker is encouraging users to 'compartmentalise', proper orchestration will be very important to have Docker gain momentum for a wider (non-experimental) audience.

Anyway, heading of now. Enjoy the weekend!

@thaJeztah

thaJeztah Feb 22, 2014

Member

Will do! I'm writing up my findings regarding Docker (in general) for my 'project'. Since I'm still having a 'fresh eye' on Docker, I'll see if there's anything in there that may assist in lifting Docker to the next level.

Biggest issues so far is offering a user-friendly way to orchestrate multiple dockers in a way that it's usable for the less-techy developers/members in our company. Although some projects exist, there's (to my knowledge) not a clear winner or 'de-facto' way to do this. For the time being, I may end up using a combination of Shipyard and some in-house tool for simple tasks. The docker roadmap does mention orchestration, but I couldn't find when this is scheduled for implementation. Since Docker is encouraging users to 'compartmentalise', proper orchestration will be very important to have Docker gain momentum for a wider (non-experimental) audience.

Anyway, heading of now. Enjoy the weekend!

@SvenDowideit

This comment has been minimized.

Show comment
Hide comment
@SvenDowideit

SvenDowideit Feb 22, 2014

Contributor

Yes, it looks like I'll be writing a boot2docker (go based) install document for windows - I'm looking for windows install disks to add to the other install-fest i'm doing on my new notebook ssd today

Contributor

SvenDowideit commented Feb 22, 2014

Yes, it looks like I'll be writing a boot2docker (go based) install document for windows - I'm looking for windows install disks to add to the other install-fest i'm doing on my new notebook ssd today

Remove Vagrantfile and remove it from all docs
This removes the Vagrantfile and updates the documentation to remove
the steps which explain how to install Docker in a VM via Vagrant.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
@unclejack

This comment has been minimized.

Show comment
Hide comment
@unclejack

unclejack Feb 22, 2014

Contributor

@metalivedev I've updated the PR and I've tried to make all the changes you've suggested. I've decided to try nested enumerated lists for the steps to be done in that dialog box.

@SvenDowideit This should be ready for you to review as well.

Contributor

unclejack commented Feb 22, 2014

@metalivedev I've updated the PR and I've tried to make all the changes you've suggested. I've decided to try nested enumerated lists for the steps to be done in that dialog box.

@SvenDowideit This should be ready for you to review as well.

@SvenDowideit

This comment has been minimized.

Show comment
Hide comment
@SvenDowideit

SvenDowideit Feb 22, 2014

Contributor

very LGTM :)

Contributor

SvenDowideit commented Feb 22, 2014

very LGTM :)

@pandrew

This comment has been minimized.

Show comment
Hide comment
@pandrew

pandrew Feb 22, 2014

Contributor

Im interested how this will affect the current build environment. Convert the makefile to regular shellscript?

Contributor

pandrew commented Feb 22, 2014

Im interested how this will affect the current build environment. Convert the makefile to regular shellscript?

@unclejack

This comment has been minimized.

Show comment
Hide comment
@unclejack

unclejack Feb 22, 2014

Contributor

@pandrew The Makefile isn't going to be affected by this change, it'll work just like before.
Vagrant isn't going to be used any more. This is only a problem if you were running OS X or Windows and didn't set up boot2docker yet.

Contributor

unclejack commented Feb 22, 2014

@pandrew The Makefile isn't going to be affected by this change, it'll work just like before.
Vagrant isn't going to be used any more. This is only a problem if you were running OS X or Windows and didn't set up boot2docker yet.

@crosbymichael

This comment has been minimized.

Show comment
Hide comment
@crosbymichael

crosbymichael Feb 24, 2014

Contributor

LGTM

Contributor

crosbymichael commented Feb 24, 2014

LGTM

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 Feb 24, 2014

Contributor

LGTM

Contributor

jamtur01 commented Feb 24, 2014

LGTM

@creack

This comment has been minimized.

Show comment
Hide comment
@creack

creack Feb 24, 2014

Contributor

LGTM

Contributor

creack commented Feb 24, 2014

LGTM

creack added a commit that referenced this pull request Feb 24, 2014

Merge pull request #4281 from unclejack/remove_vagrantfile
Remove Vagrantfile and remove it from all docs

@creack creack merged commit 8cfa771 into moby:master Feb 24, 2014

1 check passed

default The Travis CI build passed
Details
@lbustelo

This comment has been minimized.

Show comment
Hide comment
@lbustelo

lbustelo Feb 25, 2014

In the interest of being OPEN, why are you doing this?

In the interest of being OPEN, why are you doing this?

This comment has been minimized.

Show comment
Hide comment
@unclejack

unclejack Feb 25, 2014

Contributor

@lbustelo You can find out more about particular commits by finding the pull request which brought that commit. Please take a look at the pull request which brought this commit: #4281

If you have questions or comments, please comment on PR #4281.

Contributor

unclejack replied Feb 25, 2014

@lbustelo You can find out more about particular commits by finding the pull request which brought that commit. Please take a look at the pull request which brought this commit: #4281

If you have questions or comments, please comment on PR #4281.

@valentinedwv

This comment has been minimized.

Show comment
Hide comment
@valentinedwv

valentinedwv Feb 26, 2014

Future docs should not to clone the master branch if breaking changes are going to happen... please.

Future docs should not to clone the master branch if breaking changes are going to happen... please.

@unclejack unclejack deleted the unclejack:remove_vagrantfile branch Feb 26, 2014

@inthecloud247

This comment has been minimized.

Show comment
Hide comment
@inthecloud247

inthecloud247 Mar 27, 2014

I'm really surprised that Vagrant was completely removed here. I'm on Ubuntu, yet I still find it useful sometimes to develop docker containers using docker running within Vagrant. I think that it should still be an option...

this uses vagrant, for example: https://github.com/phusion/baseimage-docker

I'm really surprised that Vagrant was completely removed here. I'm on Ubuntu, yet I still find it useful sometimes to develop docker containers using docker running within Vagrant. I think that it should still be an option...

this uses vagrant, for example: https://github.com/phusion/baseimage-docker

@fgrehm fgrehm referenced this pull request in fgrehm/ventriloquist Apr 30, 2014

Closed

working with vagrant & docker in windows #58

@gavioto

This comment has been minimized.

Show comment
Hide comment
@gavioto

gavioto May 8, 2014

I like Vagrant, but reasons presented here seems consistent. On the other hand, the comunity could develop third party tools to work with vagrant.

Could I suggest to create http://chocolatey.org/ script to install docker, and all necesary stuff in windows? Yes, chocolatey should be installed before, but it could be installed automatically from command line. So, in fact, it could be possible to insatll docker from a bat, and the sell, including Chocolatey and the Docker nuget package.

UPDATE: I have seen #1567 and continue writing on it. Sorry

gavioto commented May 8, 2014

I like Vagrant, but reasons presented here seems consistent. On the other hand, the comunity could develop third party tools to work with vagrant.

Could I suggest to create http://chocolatey.org/ script to install docker, and all necesary stuff in windows? Yes, chocolatey should be installed before, but it could be installed automatically from command line. So, in fact, it could be possible to insatll docker from a bat, and the sell, including Chocolatey and the Docker nuget package.

UPDATE: I have seen #1567 and continue writing on it. Sorry

@jamtur01

This comment has been minimized.

Show comment
Hide comment
@jamtur01

jamtur01 May 8, 2014

Contributor

@gavioto We're building a boot2docker installer for Windows right now. Should be out by DockerCon (June 8th). Will wrap VirtualBox, Docker and other needed bits.

Contributor

jamtur01 commented May 8, 2014

@gavioto We're building a boot2docker installer for Windows right now. Should be out by DockerCon (June 8th). Will wrap VirtualBox, Docker and other needed bits.

@gavioto

This comment has been minimized.

Show comment
Hide comment
@gavioto

gavioto May 8, 2014

Thanks for the info @jamtur01. DockerCon seems very interesting...

gavioto commented May 8, 2014

Thanks for the info @jamtur01. DockerCon seems very interesting...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment