Browse code

Updated documentation and fixed Vagrantfile

Thatcher Peskens authored on 2013/04/20 12:57:50
Showing 6 changed files
... ...
@@ -2,19 +2,13 @@
2 2
 # vi: set ft=ruby :
3 3
 
4 4
 def v10(config)
5
-  config.vm.box = "quantal64_3.5.0-25"
6
-  config.vm.box_url = "http://get.docker.io/vbox/ubuntu/12.10/quantal64_3.5.0-25.box"
5
+  config.vm.box = 'precise64'
6
+  config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
7 7
 
8
-  config.vm.share_folder "v-data", "/opt/go/src/github.com/dotcloud/docker", File.dirname(__FILE__)
8
+  # Install ubuntu packaging dependencies and create ubuntu packages
9
+  config.vm.provision :shell, :inline => "echo 'deb http://ppa.launchpad.net/dotcloud/lxc-docker/ubuntu precise main' >>/etc/apt/sources.list"
10
+  config.vm.provision :shell, :inline => 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -qq -y --force-yes lxc-docker'
9 11
 
10
-  # Ensure puppet is installed on the instance
11
-  config.vm.provision :shell, :inline => "apt-get -qq update; apt-get install -y puppet"
12
-
13
-  config.vm.provision :puppet do |puppet|
14
-    puppet.manifests_path = "puppet/manifests"
15
-    puppet.manifest_file  = "quantal64.pp"
16
-    puppet.module_path = "puppet/modules"
17
-  end
18 12
 end
19 13
 
20 14
 Vagrant::VERSION < "1.1.0" and Vagrant::Config.run do |config|
... ...
@@ -30,11 +24,11 @@ Vagrant::VERSION >= "1.1.0" and Vagrant.configure("2") do |config|
30 30
     config.vm.box = "dummy"
31 31
     config.vm.box_url = "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box"
32 32
     aws.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
33
-    aws.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
33
+    aws.secret_access_key =     ENV["AWS_SECRET_ACCESS_KEY"]
34 34
     aws.keypair_name = ENV["AWS_KEYPAIR_NAME"]
35 35
     aws.ssh_private_key_path = ENV["AWS_SSH_PRIVKEY"]
36 36
     aws.region = "us-east-1"
37
-    aws.ami = "ami-ae9806c7"
37
+    aws.ami = "ami-d0f89fb9"
38 38
     aws.ssh_username = "ubuntu"
39 39
     aws.instance_type = "t1.micro"
40 40
   end
... ...
@@ -55,3 +49,34 @@ Vagrant::VERSION >= "1.1.0" and Vagrant.configure("2") do |config|
55 55
     config.vm.box_url = "http://get.docker.io/vbox/ubuntu/12.10/quantal64_3.5.0-25.box"
56 56
   end
57 57
 end
58
+
59
+Vagrant::VERSION >= "1.2.0" and Vagrant.configure("2") do |config|
60
+  config.vm.provider :aws do |aws, override|
61
+    config.vm.box = "dummy"
62
+    config.vm.box_url = "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box"
63
+    aws.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
64
+    aws.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
65
+    aws.keypair_name = ENV["AWS_KEYPAIR_NAME"]
66
+    override.ssh.private_key_path = ENV["AWS_SSH_PRIVKEY"]
67
+    override.ssh.username = "ubuntu"
68
+    aws.region = "us-east-1"
69
+    aws.ami = "ami-d0f89fb9"
70
+    aws.instance_type = "t1.micro"
71
+  end
72
+
73
+  config.vm.provider :rackspace do |rs|
74
+    config.vm.box = "dummy"
75
+    config.vm.box_url = "https://github.com/mitchellh/vagrant-rackspace/raw/master/dummy.box"
76
+    config.ssh.private_key_path = ENV["RS_PRIVATE_KEY"]
77
+    rs.username = ENV["RS_USERNAME"]
78
+    rs.api_key  = ENV["RS_API_KEY"]
79
+    rs.public_key_path = ENV["RS_PUBLIC_KEY"]
80
+    rs.flavor   = /512MB/
81
+    rs.image    = /Ubuntu/
82
+  end
83
+
84
+  config.vm.provider :virtualbox do |vb|
85
+    config.vm.box = "quantal64_3.5.0-25"
86
+    config.vm.box_url = "http://get.docker.io/vbox/ubuntu/12.10/quantal64_3.5.0-25.box"
87
+  end
88
+end
58 89
new file mode 100644
... ...
@@ -0,0 +1,56 @@
0
+.. _ubuntu_linux:
1
+
2
+Ubuntu Linux
3
+============
4
+
5
+  **Please note this project is currently under heavy development. It should not be used in production.**
6
+
7
+
8
+
9
+Installing on Ubuntu 12.04 and 12.10
10
+
11
+Right now, the officially supported distributions are:
12
+
13
+Ubuntu 12.04 (precise LTS)
14
+Ubuntu 12.10 (quantal)
15
+Docker probably works on other distributions featuring a recent kernel, the AUFS patch, and up-to-date lxc. However this has not been tested.
16
+
17
+Install dependencies:
18
+---------------------
19
+
20
+::
21
+
22
+    sudo apt-get install lxc wget bsdtar curl
23
+    sudo apt-get install linux-image-extra-`uname -r`
24
+
25
+The linux-image-extra package is needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module.
26
+
27
+Install the latest docker binary:
28
+
29
+::
30
+
31
+    wget http://get.docker.io/builds/$(uname -s)/$(uname -m)/docker-master.tgz
32
+    tar -xf docker-master.tgz
33
+
34
+Run your first container!
35
+
36
+::
37
+
38
+    cd docker-master
39
+
40
+::
41
+
42
+    sudo ./docker run -i -t base /bin/bash
43
+
44
+
45
+To run docker as a daemon, in the background, and allow non-root users to run ``docker`` start
46
+docker -d
47
+
48
+::
49
+
50
+    sudo ./docker -d &
51
+
52
+
53
+Consider adding docker to your PATH for simplicity.
54
+
55
+Continue with the :ref:`hello_world` example.
0 56
\ No newline at end of file
... ...
@@ -13,7 +13,7 @@ Contents:
13 13
    :maxdepth: 1
14 14
 
15 15
    ubuntulinux
16
-   macos
16
+   vagrant
17 17
    windows
18 18
    amazon
19 19
    upgrading
20 20
new file mode 100644
... ...
@@ -0,0 +1,73 @@
0
+
1
+.. _install_using_vagrant:
2
+
3
+Install using Vagrant
4
+=====================
5
+
6
+  Please note this is a community contributed installation path. The only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version
7
+  may be out of date because it depends on some binaries to be updated and published
8
+
9
+**requirements**
10
+This guide will setup a new virtual machine on your computer. This works on most operating systems,
11
+including MacOX, Windows, Linux, FreeBSD and others. If you can
12
+install these and have at least 400Mb RAM to spare you should be good.
13
+
14
+
15
+Install Vagrant, Virtualbox and Git
16
+-----------------------------------
17
+
18
+We currently rely on some Ubuntu-linux specific packages, this will change in the future, but for now we provide a
19
+streamlined path to install Virtualbox with a Ubuntu 12.10 image using Vagrant.
20
+
21
+1. Install virtualbox from https://www.virtualbox.org/ (or use your package manager)
22
+2. Install vagrant from http://www.vagrantup.com/ (or use your package manager)
23
+3. Install git if you had not installed it before, check if it is installed by running
24
+   ``git`` in a terminal window
25
+
26
+We recommend having at least about 2Gb of free disk space and 2Gb RAM (or more).
27
+
28
+Spin up your machine
29
+--------------------
30
+
31
+1. Fetch the docker sources
32
+
33
+.. code-block:: bash
34
+
35
+   git clone https://github.com/dotcloud/docker.git
36
+
37
+2. Run vagrant from the sources directory
38
+
39
+.. code-block:: bash
40
+
41
+    vagrant up
42
+
43
+Vagrant will:
44
+
45
+* Download the Quantal64 base ubuntu virtual machine image from get.docker.io/
46
+* Boot this image in virtualbox
47
+
48
+Then it will use Puppet to perform an initial setup in this machine:
49
+
50
+* Download & untar the most recent docker binary tarball to vagrant homedir.
51
+* Debootstrap to /var/lib/docker/images/ubuntu.
52
+* Install & run dockerd as service.
53
+* Put docker in /usr/local/bin.
54
+* Put latest Go toolchain in /usr/local/go.
55
+
56
+You now have a Ubuntu Virtual Machine running with docker pre-installed.
57
+
58
+To access the VM and use Docker, Run ``vagrant ssh`` from the same directory as where you ran
59
+``vagrant up``. Vagrant will make sure to connect you to the correct VM.
60
+
61
+.. code-block:: bash
62
+
63
+    vagrant ssh
64
+
65
+Now you are in the VM, run docker
66
+
67
+.. code-block:: bash
68
+
69
+    docker
70
+
71
+
72
+Continue with the :ref:`hello_world` example.
... ...
@@ -3,8 +3,8 @@
3 3
 :keywords: Docker, Docker documentation, Windows, requirements, virtualbox, vagrant, git, ssh, putty, cygwin
4 4
 
5 5
 
6
-Windows
7
-=========
6
+Windows (with Vagrant)
7
+======================
8 8
 
9 9
   Please note this is a community contributed installation path. The only 'official' installation is using the :ref:`ubuntu_linux` installation path. This version
10 10
   may be out of date because it depends on some binaries to be updated and published
... ...
@@ -2,3 +2,5 @@
2 2
 # rule to redirect original links created when hosted on github pages
3 3
 rewrite ^/documentation/(.*).html http://docs.docker.io/en/latest/$1/ permanent;
4 4
 
5
+# rewrite the stuff which was on the current page
6
+rewrite ^/gettingstarted.html$ /gettingstarted/ permanent;