website/docs: page titles on everything, cover more info
This commit is contained in:
parent
31d964ec70
commit
b5fd021694
|
@ -158,6 +158,7 @@
|
|||
<li<%= sidebar_current("providers-installation") %>><a href="/v2/providers/installation.html">Installation</a></li>
|
||||
<li<%= sidebar_current("providers-basic-usage") %>><a href="/v2/providers/basic_usage.html">Basic Usage</a></li>
|
||||
<li<%= sidebar_current("providers-configuration") %>><a href="/v2/providers/configuration.html">Configuration</a></li>
|
||||
<li<%= sidebar_current("providers-default") %>><a href="/v2/providers/default.html">Default Provider</a></li>
|
||||
<li<%= sidebar_current("providers-custom") %>><a href="/v2/providers/custom.html">Custom Provider</a></li>
|
||||
</ul> <!-- /.sub -->
|
||||
<% end %>
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Boxes"
|
||||
sidebar_current: "boxes"
|
||||
---
|
||||
|
||||
|
@ -72,14 +73,6 @@ $ vagrant box remove precise64 virtualbox
|
|||
```
|
||||
|
||||
The two arguments are the logical name of the box and the provider of the
|
||||
box.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<h3>Optional Provider Parameter?</h3>
|
||||
<p>
|
||||
A future release of Vagrant will make the provider parameter optional
|
||||
when removing a box. In this case, Vagrant will show a list of
|
||||
boxes that can be removed and ask the user which they want to remove.
|
||||
This is not currently implemented.
|
||||
</p>
|
||||
</div>
|
||||
box. The second argument (the provider) is optional. If you have only a single
|
||||
provider backing that box, it doesn't need to be specified. If you have multiple
|
||||
providers backing a box and it isn't specified, Vagrant will show an error.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Box File Format"
|
||||
sidebar_current: "boxes-format"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant box - Command-Line Interface"
|
||||
sidebar_current: "cli-box"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant destroy - Command-Line Interface"
|
||||
sidebar_current: "cli-destroy"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant halt - Command-Line Interface"
|
||||
sidebar_current: "cli-halt"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Command-Line Interface"
|
||||
sidebar_current: "cli"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant init - Command-Line Interface"
|
||||
sidebar_current: "cli-init"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant package - Command-Line Interface"
|
||||
sidebar_current: "cli-package"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant plugin - Command-Line Interface"
|
||||
sidebar_current: "cli-plugin"
|
||||
---
|
||||
|
||||
|
@ -15,6 +16,7 @@ of subcommands:
|
|||
* `license`
|
||||
* `list`
|
||||
* `uninstall`
|
||||
* `update`
|
||||
|
||||
# Plugin Install
|
||||
|
||||
|
@ -22,7 +24,9 @@ of subcommands:
|
|||
|
||||
This installs a plugin with the given name or file path. If the name
|
||||
is not a path to a file, then the plugin is installed from remote
|
||||
repositories, usually [RubyGems](http://rubygems.org).
|
||||
repositories, usually [RubyGems](http://rubygems.org). This command will
|
||||
also update a plugin if it is already installed, but you can also use
|
||||
`vagrant plugin update` for that.
|
||||
|
||||
# Plugin License
|
||||
|
||||
|
@ -43,3 +47,10 @@ This lists all installed plugins and their respective versions.
|
|||
|
||||
This uninstalls the plugin with the given name. Any dependencies of the
|
||||
plugin will also be uninstalled assuming no other plugin needs them.
|
||||
|
||||
# Plugin Update
|
||||
|
||||
**Command: `vagrant plugin update <name>`**
|
||||
|
||||
This updates the plugin with the given name. If the plugin isn't already
|
||||
installed, this will not install it.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant provision - Command-Line Interface"
|
||||
sidebar_current: "cli-provision"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant reload - Command-Line Interface"
|
||||
sidebar_current: "cli-reload"
|
||||
---
|
||||
|
||||
|
@ -13,9 +14,12 @@ This command is usually required for changes made in the Vagrantfile to
|
|||
take effect. After making any modifications to the Vagrantfile, a `reload`
|
||||
should be called.
|
||||
|
||||
The configured provisioners will not run again, by default. You can force
|
||||
the provisioners to re-run by specifying the `--provision` flag.
|
||||
|
||||
# Options
|
||||
|
||||
* `--no-provision` - The provisioners will not run.
|
||||
* `--provision` - Force the provisioners to run.
|
||||
|
||||
* `--provision-with x,y,z` - This will only run the given provisioners. For
|
||||
example, if you have a `:shell` and `:chef_solo` provisioner and run
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant resume - Command-Line Interface"
|
||||
sidebar_current: "cli-resume"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant ssh - Command-Line Interface"
|
||||
sidebar_current: "cli-ssh"
|
||||
---
|
||||
|
||||
|
@ -16,7 +17,8 @@ any abitrary commands to do things such as reverse tunneling down into the
|
|||
## Options
|
||||
|
||||
* `-c COMMAND` or `--command COMMAND` - This executes a single SSH command, prints
|
||||
out the stdout and stderr, and exits.
|
||||
out the stdout and stderr, and exits. stdin will not be functional on this
|
||||
executed command.
|
||||
|
||||
* `-p` or `--plain` - This does an SSH without authentication, leaving
|
||||
authentication up to the user.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant ssh-config - Command-Line Interface"
|
||||
sidebar_current: "cli-ssh_config"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant status - Command-Line Interface"
|
||||
sidebar_current: "cli-status"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant suspend - Command-Line Interface"
|
||||
sidebar_current: "cli-suspend"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "vagrant up - Command-Line Interface"
|
||||
sidebar_current: "cli-up"
|
||||
---
|
||||
|
||||
|
@ -12,3 +13,22 @@ This command creates and configures guest machines according to your
|
|||
This is the single most important command in Vagrant, since it is how
|
||||
any Vagrant machine is created. Anyone using Vagrant must use this command
|
||||
on a day-to-day basis.
|
||||
|
||||
# Options
|
||||
|
||||
* `--[no-]destroy-on-error` - Destroy the newly created machine if a fatal,
|
||||
unexpected error occurs. This will only happen on the first `vagrant up`.
|
||||
By default this is set.
|
||||
|
||||
* `--[no-]parallel` - Bring multiple machines up in parallel if the provider
|
||||
supports it.
|
||||
|
||||
* `--provider x` - Bring the machine up with the given
|
||||
[provider](/v2/providers/index.html). By default this is "virtualbox".
|
||||
|
||||
* `--provision` - Force the provisioners to run.
|
||||
|
||||
* `--provision-with x,y,z` - This will only run the given provisioners. For
|
||||
example, if you have a `:shell` and `:chef_solo` provisioner and run
|
||||
`vagrant provision --provision-with shell`, only the shell provisioner will
|
||||
be run.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Debugging and Troubleshooting"
|
||||
sidebar_current: "debugging"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Boxes - Getting Started"
|
||||
sidebar_current: "gettingstarted-boxes"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Getting Started"
|
||||
sidebar_current: "gettingstarted"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Networking - Getting Started"
|
||||
sidebar_current: "gettingstarted-networking"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Project Setup - Getting Started"
|
||||
sidebar_current: "gettingstarted-projectsetup"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Providers - Getting Started"
|
||||
sidebar_current: "gettingstarted-providers"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Provisioning - Getting Started"
|
||||
sidebar_current: "gettingstarted-provisioning"
|
||||
---
|
||||
|
||||
|
@ -49,9 +50,11 @@ to the location of the project root (where the Vagrantfile is).
|
|||
After everything is configured, just run `vagrant up` to create your
|
||||
machine and Vagrant will automatically provision it. You should see
|
||||
the output from the shell script appear in your terminal. If the guest
|
||||
machine is already running from a previous step, run `vagrant reload`,
|
||||
machine is already running from a previous step, run `vagrant reload --provision`,
|
||||
which will quickly restart your virtual machine, skipping the initial
|
||||
import step.
|
||||
import step. The provision flag on the reload command instructs Vagrant to
|
||||
run the provisioners, since usually Vagrant will only do this on the first
|
||||
`vagrant up`.
|
||||
|
||||
After Vagrant completes running, the web server will be up and running.
|
||||
You can't see the website from your own browser (yet), but you can verify
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Rebuild - Getting Started"
|
||||
sidebar_current: "gettingstarted-rebuild"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Synced Folders - Getting Started"
|
||||
sidebar_current: "gettingstarted-syncedfolders"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Teardown - Getting Started"
|
||||
sidebar_current: "gettingstarted-teardown"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Up and SSH - Getting Started"
|
||||
sidebar_current: "gettingstarted-up"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Uninstalling Vagrant"
|
||||
sidebar_current: "installation-uninstallation"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Multi-Machine"
|
||||
sidebar_current: "multimachine"
|
||||
---
|
||||
|
||||
|
@ -35,13 +36,13 @@ configuration. An example shows this best:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :shell, :inline => "echo Hello"
|
||||
config.vm.provision "shell", inline: "echo Hello"
|
||||
|
||||
config.vm.define :web do |web|
|
||||
config.vm.define "web" do |web|
|
||||
web.vm.box = "apache"
|
||||
end
|
||||
|
||||
config.vm.define :db do |db|
|
||||
config.vm.define "db" do |db|
|
||||
db.vm.box = "mysql"
|
||||
end
|
||||
end
|
||||
|
@ -51,7 +52,7 @@ As you can see, `config.vm.define` takes a block with another variable. This
|
|||
variable, such as `web` above, is the _exact_ same as the `config` variable,
|
||||
except any configuration of the inner variable applies only to the machine
|
||||
being defined. Therefore, any configuration on `web` will only affect the
|
||||
`:web` machine.
|
||||
`web` machine.
|
||||
|
||||
And importantly, you can continue to use the `config` object as well. The
|
||||
configuration object is loaded and merged before the machine-specific configuration,
|
||||
|
@ -87,3 +88,18 @@ In order to faciliate communication within machines in a multi-machine setup,
|
|||
the various [networking](/v2/networking/index.html) options should be used.
|
||||
In particular, the [private network](/v2/networking/private_network.html) can
|
||||
be used to make a private network between multiple machines and the host.
|
||||
|
||||
## Specifying a Primary Machine
|
||||
|
||||
You can also specify a _primary machine_. The primary machine will be the
|
||||
default machine used when a specific machine in a multi-machine environment
|
||||
is not specified.
|
||||
|
||||
To specify a default, machine, just mark it primary when defining it. Only
|
||||
one primary machine may be specified.
|
||||
|
||||
```ruby
|
||||
config.vm.define "web", primary: true do |web|
|
||||
# ...
|
||||
end
|
||||
```
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Basic Usage - Networking"
|
||||
sidebar_current: "networking-basic"
|
||||
---
|
||||
|
||||
|
@ -19,7 +20,7 @@ below defines some port forwarding:
|
|||
Vagrant.configure("2") do |config|
|
||||
# other config here
|
||||
|
||||
config.vm.network :forwarded_port, guest: 80, host: 8080
|
||||
config.vm.network "forwarded_port", guest: 80, host: 8080
|
||||
end
|
||||
```
|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Forwarded Ports - Networking"
|
||||
sidebar_current: "networking-fp"
|
||||
---
|
||||
|
||||
# Forwarded Ports
|
||||
|
||||
**Network identifier: `:forwarded_port`**
|
||||
**Network identifier: `forwarded_port`**
|
||||
|
||||
Forwarded ports allow you to access a port on your host machine and have
|
||||
all data forwarded to a port on the guest machine, over either TCP or UDP.
|
||||
|
@ -21,7 +22,7 @@ guest and the port on the host. Example:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.network :forwarded_port, guest: 80, host: 8080
|
||||
config.vm.network "forwarded_port", guest: 80, host: 8080
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -45,7 +46,7 @@ is easy:
|
|||
|
||||
```
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.network :forwarded_port, guest: 80, host: 8080,
|
||||
config.vm.network "forwarded_port", guest: 80, host: 8080,
|
||||
auto_correct: true
|
||||
end
|
||||
```
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Networking"
|
||||
sidebar_current: "networking"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Private Networks - Networking"
|
||||
sidebar_current: "networking-private"
|
||||
---
|
||||
|
||||
# Private Networks
|
||||
|
||||
**Network identifier: `:private_network`**
|
||||
**Network identifier: `private_network`**
|
||||
|
||||
Private networks allow you to access your guest machine by some address
|
||||
that is not publicly accessible from the global internet. In general, this
|
||||
|
@ -34,7 +35,7 @@ IP. The Vagrantfile for a static IP looks like this:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.network :private_network, ip: "192.168.50.4"
|
||||
config.vm.network "private_network", ip: "192.168.50.4"
|
||||
end
|
||||
```
|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Public Networks - Networking"
|
||||
sidebar_current: "networking-public"
|
||||
---
|
||||
|
||||
# Public Networks
|
||||
|
||||
**Network identifier: `:public_network`**
|
||||
**Network identifier: `public_network`**
|
||||
|
||||
Public networks are less private than private networks, and the exact
|
||||
meaning actually varies from [provider to provider](/v2/providers/index.html),
|
||||
|
@ -29,7 +30,7 @@ via DHCP. In this case, defining a public network is trivially easy:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.network :public_network
|
||||
config.vm.network "public_network"
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -39,14 +40,14 @@ the IP, such as `ifconfig`.
|
|||
|
||||
## Default Network Interface
|
||||
|
||||
If more than one network interface is available on the host machine, Vagrant will
|
||||
If more than one network interface is available on the host machine, Vagrant will
|
||||
ask you to choose which interface the virtual machine should bridge to. A default
|
||||
interface can be specified by adding a `:bridge` clause to the network definition.
|
||||
|
||||
```ruby
|
||||
config.vm.network :public_network, :bridge => 'en1: Wi-Fi (AirPort)'
|
||||
config.vm.network "public_network", :bridge => 'en1: Wi-Fi (AirPort)'
|
||||
```
|
||||
|
||||
The string identifying the desired interface must exactly match the name of an
|
||||
available interface. If it can't be found, Vagrant will ask you to pick
|
||||
available interface. If it can't be found, Vagrant will ask you to pick
|
||||
from a list of available network interfaces.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Command Plugins - Plugin Development"
|
||||
sidebar_current: "plugins-commands"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Configuration - Plugin Development"
|
||||
sidebar_current: "plugins-configuration"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Plugin Development Basics - Plugins"
|
||||
sidebar_current: "plugins-development-basics"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Guest Capabilities - Plugin Development"
|
||||
sidebar_current: "plugins-guestcapabilities"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Guests - Plugin Development"
|
||||
sidebar_current: "plugins-guests"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Hosts - Plugin Development"
|
||||
sidebar_current: "plugins-hosts"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Plugins"
|
||||
sidebar_current: "plugins"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Packaging and Distribution - Plugin Development"
|
||||
sidebar_current: "plugins-packaging"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Providers - Plugin Development"
|
||||
sidebar_current: "plugins-providers"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Provisioners - Plugin Development"
|
||||
sidebar_current: "plugins-provisioners"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Plugin Usage - Plugins"
|
||||
sidebar_current: "plugins-usage"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Basic Usage - Providers"
|
||||
sidebar_current: "providers-basic-usage"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Configuration - Providers"
|
||||
sidebar_current: "providers-configuration"
|
||||
---
|
||||
|
||||
|
@ -29,7 +30,7 @@ Configuring a specific provider looks like this:
|
|||
Vagrant.configure("2") do |config|
|
||||
# ... (other config)
|
||||
|
||||
config.vm.provider :virtualbox do |vb|
|
||||
config.vm.provider "virtualbox" do |vb|
|
||||
vb.customize ["modifyvm", :id, "--cpuexecutioncap", "50"]
|
||||
end
|
||||
end
|
||||
|
@ -67,7 +68,7 @@ Example:
|
|||
Vagrant.configure("2") do |config|
|
||||
config.vm.box = "precise64"
|
||||
|
||||
config.vm.provider :vmware_fusion do |v, override|
|
||||
config.vm.provider "vmware_fusion" do |v, override|
|
||||
override.vm.box = "precise64_fusion"
|
||||
end
|
||||
end
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Custom Provider - Providers"
|
||||
sidebar_current: "providers-custom"
|
||||
---
|
||||
|
||||
|
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
page_title: "Default Provider - Providers"
|
||||
sidebar_current: "providers-default"
|
||||
---
|
||||
|
||||
# Default Provider
|
||||
|
||||
By default, VirtualBox is the default provider for Vagrant. VirtualBox is
|
||||
still the most accessible platform to use Vagrant: it is free, cross-platform,
|
||||
and has been supported by Vagrant for years. With VirtualBox as the default
|
||||
provider, it provides the lowest friction for new users to get started with
|
||||
Vagrant.
|
||||
|
||||
However, you may find after using Vagrant for some time that you prefer
|
||||
to use another provider as your default. In fact, this is quite common.
|
||||
To make this experience better, Vagrant allows specifying the default
|
||||
provider to use by setting the `VAGRANT_DEFAULT_PROVIDER` environmental
|
||||
variable.
|
||||
|
||||
Just set `VAGRANT_DEFAULT_PROVIDER` to the provider you wish to be the
|
||||
default. For example, if you use Vagrant with VMware Fusion, you can set
|
||||
the environmental variable to `vmware_fusion` and it will be your default.
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Providers"
|
||||
sidebar_current: "providers"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Installation - Providers"
|
||||
sidebar_current: "providers-installation"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Ansible - Provisioning"
|
||||
sidebar_current: "provisioning-ansible"
|
||||
---
|
||||
|
||||
# Ansible Provisioner
|
||||
|
||||
**Provisioner name: `:ansible`**
|
||||
**Provisioner name: `"ansible"`**
|
||||
|
||||
The ansible provisioner allows you to provision the guest using
|
||||
[Ansible](http://ansible.cc) playbooks.
|
||||
|
@ -48,7 +49,7 @@ which contains the steps that should be run on the guest. Ansible's
|
|||
[playbook documentation](http://ansible.cc/docs/playbooks.html) goes into great
|
||||
detail on how to author playbooks, and there are a number of
|
||||
[best practices](http://ansible.cc/docs/bestpractices.html) that can be applied to use
|
||||
Ansible's powerful features effectively. A playbook that installs and starts (or restarts
|
||||
Ansible's powerful features effectively. A playbook that installs and starts (or restarts
|
||||
if it was updated) the NTP daemon via YUM looks like:
|
||||
|
||||
```
|
||||
|
@ -74,7 +75,7 @@ To run Ansible against your Vagrant guest, the basic Vagrantfile configuration l
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :ansible do |ansible|
|
||||
config.vm.provision "ansible" do |ansible|
|
||||
ansible.playbook = "playbook.yml"
|
||||
end
|
||||
end
|
||||
|
@ -98,7 +99,7 @@ In such an arrangement, the `ansible.playbook` path should be adjusted according
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :ansible do |ansible|
|
||||
config.vm.provision "ansible" do |ansible|
|
||||
ansible.playbook = "provisioning/playbook.yml"
|
||||
end
|
||||
end
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Basic Usage - Provisioning"
|
||||
sidebar_current: "provisioning-basic"
|
||||
---
|
||||
|
||||
|
@ -18,11 +19,11 @@ below enables shell provisioning:
|
|||
Vagrant.configure("2") do |config|
|
||||
# ... other configuration
|
||||
|
||||
config.vm.provision :shell, :inline => "echo hello"
|
||||
config.vm.provision "shell", inline: "echo hello"
|
||||
end
|
||||
```
|
||||
|
||||
Every provisioner has an identifier, such as `:shell`, used as the first
|
||||
Every provisioner has an identifier, such as `"shell", used as the first
|
||||
parameter to the provisioning configuration. Following that is basic key/value
|
||||
for configuring that specific provisioner. Instead of basic key/value, you
|
||||
can also use a Ruby block for a syntax that is more like variable assignment.
|
||||
|
@ -32,7 +33,7 @@ The following is effectively the same as the prior example:
|
|||
Vagrant.configure("2") do |config|
|
||||
# ... other configuration
|
||||
|
||||
config.vm.provision :shell do |s|
|
||||
config.vm.provision "shell" do |s|
|
||||
s.inline = "echo hello"
|
||||
end
|
||||
end
|
||||
|
@ -57,7 +58,8 @@ Provisioners are run in three cases: `vagrant up`, `vagrant reload`, and
|
|||
`vagrant provision`.
|
||||
|
||||
A `--no-provision` flag can be passed to `up` and `reload` if you don't
|
||||
want to run provisioners.
|
||||
want to run provisioners. Likewise, you can pass `--provision` to force
|
||||
provisioning.
|
||||
|
||||
The `--provision-with` flag can be used if you only want to run a
|
||||
specific provisioner if you have multiple provisioners specified. For
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Chef Client - Provisioning"
|
||||
sidebar_current: "provisioning-chefclient"
|
||||
---
|
||||
|
||||
|
@ -31,7 +32,7 @@ that the node can register with the Chef server:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :chef_client do |chef|
|
||||
config.vm.provision "chef_client" do |chef|
|
||||
chef.chef_server_url = "http://mychefserver.com:4000/"
|
||||
chef.validation_key_path = "validation.pem"
|
||||
end
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Chef Solo - Provisioning"
|
||||
sidebar_current: "provisioning-chefsolo"
|
||||
---
|
||||
|
||||
|
@ -97,7 +98,7 @@ end
|
|||
Just like the cookbooks path, the roles path is relative to the project
|
||||
root if a relative path is given.
|
||||
|
||||
**Note:** The name of the role file must be the same as the role name.
|
||||
**Note:** The name of the role file must be the same as the role name.
|
||||
For example the `web` role must be in the `roles_path` as web.json or web.rb.
|
||||
This is required by Chef itself, and isn't a limitation imposed by
|
||||
Vagrant.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Provisioning"
|
||||
sidebar_current: "provisioning"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Puppet Agent - Provisioning"
|
||||
sidebar_current: "provisioning-puppetagent"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Puppet Apply - Provisioning"
|
||||
sidebar_current: "provisioning-puppetapply"
|
||||
---
|
||||
|
||||
# Puppet Apply Provisioner
|
||||
|
||||
**Provisioner name: `:puppet`**
|
||||
**Provisioner name: `puppet`**
|
||||
|
||||
The Puppet provisioner allows you to provision the guest using
|
||||
[Puppet](http://www.puppetlabs.com/puppet), specifically by
|
||||
|
@ -26,7 +27,7 @@ enable it:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :puppet
|
||||
config.vm.provision "puppet"
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -53,7 +54,7 @@ entry-point with `manifest_file`:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :puppet do |puppet|
|
||||
config.vm.provision "puppet" do |puppet|
|
||||
puppet.manifests_path = "my_manifests"
|
||||
puppet.manifest_file = "default.pp"
|
||||
end
|
||||
|
@ -71,7 +72,7 @@ The manifest file is still used as an entry-point.
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :puppet do |puppet|
|
||||
config.vm.provision "puppet" do |puppet|
|
||||
puppet.module_path = "modules"
|
||||
end
|
||||
end
|
||||
|
@ -87,7 +88,7 @@ can be specified as well:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :puppet do |puppet|
|
||||
config.vm.provision "puppet" do |puppet|
|
||||
puppet.facter = {
|
||||
"vagrant" => "1"
|
||||
}
|
||||
|
@ -106,7 +107,7 @@ flags to use:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :puppet do |puppet|
|
||||
config.vm.provision "puppet" do |puppet|
|
||||
puppet.options = "--verbose --debug"
|
||||
end
|
||||
end
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
page_title: "Shell Scripts - Provisioning"
|
||||
sidebar_current: "provisioning-shell"
|
||||
---
|
||||
|
||||
# Shell Provisioner
|
||||
|
||||
**Provisioner name: `:shell`**
|
||||
**Provisioner name: `"shell"`**
|
||||
|
||||
The shell provisioner allows you to upload and execute a script as
|
||||
the root user within the guest machine.
|
||||
|
@ -22,8 +23,8 @@ the Vagrantfile. An example is best:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :shell,
|
||||
:inline => "echo Hello, World"
|
||||
config.vm.provision "shell",
|
||||
inline: "echo Hello, World"
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -40,7 +41,7 @@ date > /etc/vagrant_provisioned_at
|
|||
SCRIPT
|
||||
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :shell, :inline => $script
|
||||
config.vm.provision "shell", inline: $script
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -62,7 +63,7 @@ into the guest and execute it. An example:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :shell, :path => "script.sh"
|
||||
config.vm.provision "shell", path: "script.sh"
|
||||
end
|
||||
```
|
||||
|
||||
|
@ -79,7 +80,7 @@ be sure to properly escape anything:
|
|||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
config.vm.provision :shell do |s|
|
||||
config.vm.provision "shell" do |s|
|
||||
s.inline = "echo $1"
|
||||
s.args = "'hello, world!'"
|
||||
end
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
page_title: "Basic Usage - Synced Folders"
|
||||
sidebar_current: "syncedfolder-basic"
|
||||
page_title: "Synced Folders - Basic Usage"
|
||||
---
|
||||
|
||||
# Basic Usage
|
||||
|
@ -48,5 +48,6 @@ to the SSH user. Sometimes it is preferable to mount folders with a different
|
|||
owner and group. It is possible to set these options:
|
||||
|
||||
```ruby
|
||||
config.vm.synced_folder "src/", "/srv/website", owner: "root", group: "root"
|
||||
config.vm.synced_folder "src/", "/srv/website",
|
||||
owner: "root", group: "root"
|
||||
```
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Synced Folders"
|
||||
sidebar_current: "syncedfolder"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "NFS - Synced Folders"
|
||||
sidebar_current: "syncedfolder-nfs"
|
||||
---
|
||||
|
||||
|
@ -38,13 +39,13 @@ stop the NFS server daemon.
|
|||
|
||||
## Enabling NFS Synced Folders
|
||||
|
||||
To enable NFS, just add the `:nfs => true` flag onto your synced folder:
|
||||
To enable NFS, just add the `nfs: true` flag onto your synced folder:
|
||||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
# ...
|
||||
|
||||
config.vm.synced_folder ".", "/vagrant", :nfs => true
|
||||
config.vm.synced_folder ".", "/vagrant", nfs: true
|
||||
end
|
||||
```
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Vagrantfile"
|
||||
sidebar_current: "vagrantfile"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "config.vm - Vagrantfile"
|
||||
sidebar_current: "vagrantfile-machine"
|
||||
---
|
||||
|
||||
|
@ -11,6 +12,11 @@ machine that Vagrant manages.
|
|||
|
||||
## Available Settings
|
||||
|
||||
`config.vm.boot_timeout` - The time in seconds that Vagrant will wait
|
||||
for the machine to boot and be accessible. By default this is 300 seconds.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.vm.box` - This configures what [box](/v2/boxes/index.html) the
|
||||
machine will be brought up against. The value here should match one of
|
||||
the installed boxes on the system.
|
||||
|
@ -23,14 +29,9 @@ URL when `vagrant up` is run.
|
|||
|
||||
<hr>
|
||||
|
||||
`config.vm.graceful_halt_retry_count` - The number of times to retry
|
||||
gracefully shutting down the system when `vagrant halt` is called. Defaults
|
||||
to 3.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.vm.graceful_halt_retry_interval` - The amount of time in between
|
||||
each retry of attempting to shut down, in seconds. Defaults to 1 second.
|
||||
`config.vm.graceful_halt_timeout` - The time in seconds that Vagrant will
|
||||
wait for the machine to gracefully halt when `vagrant halt` is called.
|
||||
Defaults to 300 seconds.
|
||||
|
||||
<hr>
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "config.ssh - Vagrantfile"
|
||||
sidebar_current: "vagrantfile-ssh"
|
||||
---
|
||||
|
||||
|
@ -36,16 +37,6 @@ to use port 4567 to talk to the guest if there is no other option.
|
|||
|
||||
<hr>
|
||||
|
||||
`config.ssh.max_tries` - Maximum attempts to SSH while waiting for the
|
||||
machine to boot. Default is 100.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.ssh.timeout` - Maximum time to wait while attempting to make
|
||||
a single connection via SSH before timing out. Default is 30 seconds.
|
||||
|
||||
<hr>
|
||||
|
||||
`config.ssh.private_key_path` - The path to the private key to use to
|
||||
SSH into the guest machine. By default this is the insecure private key
|
||||
that ships with Vagrant, since that is what public boxes use. If you make
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "config.vagrant - Vagrantfile"
|
||||
sidebar_current: "vagrantfile-vagrant"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Configuration Version - Vagrantfile"
|
||||
sidebar_current: "vagrantfile-version"
|
||||
---
|
||||
|
||||
|
@ -13,7 +14,9 @@ If you run `vagrant init` today, the Vagranfile will be in roughly the
|
|||
following format:
|
||||
|
||||
```ruby
|
||||
Vagrant.configure("2") do |config|
|
||||
VAGRANTFILE_API_VERSION = "2"
|
||||
|
||||
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
|
||||
# ...
|
||||
end
|
||||
```
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Box Format - VirtualBox Provider"
|
||||
sidebar_current: "virtualbox-boxes"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Configuration - VirtualBox Provider"
|
||||
sidebar_current: "virtualbox-configuration"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "VirtualBox Provider"
|
||||
sidebar_current: "virtualbox"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Usage - VirtualBox Provider"
|
||||
sidebar_current: "virtualbox-usage"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Box Format - VMware Provider"
|
||||
sidebar_current: "vmware-boxes"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Configuration- VMware Provider"
|
||||
sidebar_current: "vmware-configuration"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "VMware Provider"
|
||||
sidebar_current: "vmware"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Installation - VMware Provider"
|
||||
sidebar_current: "vmware-installation"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Known Issues - VMware Provider"
|
||||
sidebar_current: "vmware-known-issues"
|
||||
---
|
||||
|
||||
|
@ -8,23 +9,6 @@ This page tracks some known issues or limitations of the VMware providers.
|
|||
Note that none of these are generally blockers to using the provider, but
|
||||
are good to know.
|
||||
|
||||
## vmnet Device Cleanup
|
||||
|
||||
When creating a private network with VMware, the Vagrant provider will
|
||||
create a new `vmnet` device for your IP/subnet if one doesn't already exist.
|
||||
Vagrant currently never cleans up unused `vmnet` devices. This must be
|
||||
done manually via the VMware network editor.
|
||||
|
||||
In practice, this is not an issue because there are really only
|
||||
[three IPv4 address spaces](http://en.wikipedia.org/wiki/Private_network#Private_IPv4_address_spaces)
|
||||
that can be used for these networks, so not many extraneous vmnet devices
|
||||
are left lying around.
|
||||
|
||||
However, if you use automatically generated IP addresses that use many
|
||||
subnets, you may find that there are many extra vmnet devices. Manually
|
||||
remove these for now. A future release of the provider will address this
|
||||
limitation in some way.
|
||||
|
||||
## Forwarded Ports Failing in Workstation on Windows
|
||||
|
||||
VMware Workstation has a bug on Windows where forwarded ports don't work
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
---
|
||||
page_title: "Usage - VMware Provider"
|
||||
sidebar_current: "vmware-usage"
|
||||
---
|
||||
|
||||
|
|
Loading…
Reference in New Issue