docs nav and content audit
This commit is contained in:
Jeff Escalante
parent
4cd87be905
commit
491a84af2a
@ -3,4 +3,18 @@
|
||||
# See the README file in this directory for documentation. Please do not
|
||||
# modify or delete existing redirects without first verifying internally.
|
||||
|
||||
/intro/index /intro
|
||||
/intro/index /intro
|
||||
/docs/index /docs
|
||||
/docs/boxes.html /docs/boxes
|
||||
/docs/experimental/index.html /docs/experimental
|
||||
/docs/experimental/ /docs/experimental
|
||||
/docs/multi-machine/index.html /docs/multi-machine
|
||||
/docs/multi-machine/ /docs/multi-machine
|
||||
/docs/virtualbox/index.html /docs/providers/virtualbox
|
||||
/docs/virtualbox/* /docs/providers/virtualbox/:splat
|
||||
/docs/vmware/index.html /docs/providers/vmware
|
||||
/docs/vmware/* /docs/providers/vmware/:splat
|
||||
/docs/docker/index.html /docs/providers/docker
|
||||
/docs/docker/* /docs/providers/docker/:splat
|
||||
/docs/hyperv/index.html /docs/providers/hyperv
|
||||
/docs/hyperv/* /docs/providers/hyperv/:splat
|
||||
|
||||
@ -6,4 +6,177 @@
|
||||
// the landing page for the category, or a "name" property to
|
||||
// serve as the category title in the sidebar
|
||||
|
||||
export default []
|
||||
export default [
|
||||
'index',
|
||||
{
|
||||
category: 'installation',
|
||||
content: [
|
||||
'backwards-compatibility',
|
||||
'upgrading',
|
||||
'upgrading-from-1-0',
|
||||
'source',
|
||||
'uninstallation',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'cli',
|
||||
content: [
|
||||
'box',
|
||||
'cloud',
|
||||
'connect',
|
||||
'destroy',
|
||||
'global-status',
|
||||
'halt',
|
||||
'init',
|
||||
'login',
|
||||
'package',
|
||||
'plugin',
|
||||
'port',
|
||||
'powershell',
|
||||
'provision',
|
||||
'rdp',
|
||||
'reload',
|
||||
'resume',
|
||||
'share',
|
||||
'snapshot',
|
||||
'ssh',
|
||||
'ssh_config',
|
||||
'status',
|
||||
'suspend',
|
||||
'up',
|
||||
'upload',
|
||||
'validate',
|
||||
'version',
|
||||
'non-primary',
|
||||
'aliases',
|
||||
'machine-readable',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'share',
|
||||
content: ['http', 'ssh', 'connect', 'security', 'provider'],
|
||||
},
|
||||
{
|
||||
category: 'vagrantfile',
|
||||
content: [
|
||||
'version',
|
||||
'vagrant_version',
|
||||
'tips',
|
||||
'machine_settings',
|
||||
'ssh_settings',
|
||||
'winrm_settings',
|
||||
'winssh_settings',
|
||||
'vagrant_settings',
|
||||
],
|
||||
},
|
||||
{ category: 'boxes', content: ['versioning', 'base', 'format', 'info'] },
|
||||
{
|
||||
category: 'provisioning',
|
||||
content: [
|
||||
'basic_usage',
|
||||
'file',
|
||||
'shell',
|
||||
'ansible_intro',
|
||||
'ansible',
|
||||
'ansible_local',
|
||||
'ansible_common',
|
||||
'cfengine',
|
||||
'chef_common',
|
||||
'chef_solo',
|
||||
'chef_zero',
|
||||
'chef_client',
|
||||
'chef_apply',
|
||||
'docker',
|
||||
'podman',
|
||||
'puppet_apply',
|
||||
'puppet_agent',
|
||||
'salt',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'networking',
|
||||
content: [
|
||||
'basic_usage',
|
||||
'forwarded_ports',
|
||||
'private_network',
|
||||
'public_network',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'synced-folders',
|
||||
content: ['basic_usage', 'nfs', 'rsync', 'smb', 'virtualbox'],
|
||||
},
|
||||
{
|
||||
category: 'disks',
|
||||
content: [
|
||||
'configuration',
|
||||
'usage',
|
||||
{ category: 'virtualbox', content: ['usage', 'common-issues'] },
|
||||
],
|
||||
},
|
||||
'multi-machine',
|
||||
{
|
||||
category: 'providers',
|
||||
content: [
|
||||
'installation',
|
||||
'basic_usage',
|
||||
'configuration',
|
||||
'default',
|
||||
{
|
||||
category: 'virtualbox',
|
||||
content: [
|
||||
'usage',
|
||||
'boxes',
|
||||
'configuration',
|
||||
'networking',
|
||||
'common-issues',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'vmware',
|
||||
content: [
|
||||
'installation',
|
||||
'vagrant-vmware-utility',
|
||||
'usage',
|
||||
'boxes',
|
||||
'configuration',
|
||||
'known-issues',
|
||||
'kernel-upgrade',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'docker',
|
||||
content: ['basics', 'commands', 'boxes', 'configuration', 'networking'],
|
||||
},
|
||||
{
|
||||
category: 'hyperv',
|
||||
content: ['usage', 'boxes', 'configuration', 'limitations'],
|
||||
},
|
||||
'custom',
|
||||
],
|
||||
},
|
||||
{
|
||||
category: 'plugins',
|
||||
content: [
|
||||
'usage',
|
||||
'development-basics',
|
||||
'action-hooks',
|
||||
'commands',
|
||||
'configuration',
|
||||
'guests',
|
||||
'guest-capabilities',
|
||||
'hosts',
|
||||
'host-capabilities',
|
||||
'providers',
|
||||
'provisioners',
|
||||
'packaging',
|
||||
],
|
||||
},
|
||||
{ category: 'push', content: ['ftp', 'heroku', 'local-exec'] },
|
||||
{ category: 'triggers', content: ['configuration', 'usage'] },
|
||||
'experimental',
|
||||
{
|
||||
category: 'other',
|
||||
content: ['debugging', 'environmental-variables', 'wsl'],
|
||||
},
|
||||
]
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
export default '2.2.8'
|
||||
export const VMWARE_UTILITY_VERSION = 'test'
|
||||
export const VMWARE_UTILITY_VERSION = '1.0.7'
|
||||
|
||||
@ -5,8 +5,9 @@ import { MDXProvider } from '@mdx-js/react'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
import Tabs, { Tab } from '../components/tabs'
|
||||
import Button from '@hashicorp/react-button'
|
||||
|
||||
const DEFAULT_COMPONENTS = { Tabs, Tab }
|
||||
const DEFAULT_COMPONENTS = { Tabs, Tab, Button }
|
||||
|
||||
function DocsLayoutWrapper(pageMeta) {
|
||||
function DocsLayout(props) {
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Creating a Base Box
|
||||
sidebar_title: 'Creating a Base Box'
|
||||
sidebar_current: boxes-base
|
||||
description: |-
|
||||
There are a special category of boxes known as "base boxes." These boxes
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Box File Format
|
||||
sidebar_title: 'Box File Format'
|
||||
sidebar_current: boxes-format
|
||||
description: |-
|
||||
The box file format for Vagrant has changed from only supporting VirtualBox to
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Boxes
|
||||
sidebar_title: 'Boxes'
|
||||
sidebar_current: boxes
|
||||
description: |-
|
||||
Boxes are the package format for Vagrant environments. A box can be used by
|
||||
@ -44,7 +45,7 @@ VirtualBox, VMware, AWS, etc. you should be able to find a box you need.
|
||||
Adding a box from the catalog is very easy. Each box shows you instructions
|
||||
with how to add it, but they all follow the same format:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant box add USER/BOX
|
||||
```
|
||||
|
||||
@ -62,7 +63,7 @@ with third-party published boxes.
|
||||
|
||||
HashiCorp (the makers of Vagrant) publish a basic Ubuntu 18.04 64-bit box that is available for minimal use cases. It is highly optimized, small in size, and includes support for Virtualbox, Hyper-V, and VMware. You can use it like this:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ vagrant init hashicorp/bionic64
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Box Info Format
|
||||
sidebar_title: 'Box Info Format'
|
||||
sidebar_current: boxes-info
|
||||
description: |-
|
||||
A box can provide additional information to the user by supplying an info.json
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Box Versioning
|
||||
sidebar_title: 'Box Versioning'
|
||||
sidebar_current: boxes-versioning
|
||||
description: |-
|
||||
Since Vagrant 1.5, boxes support versioning. This allows the people who
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Aliases - Command-Line Interface
|
||||
sidebar_title: 'Aliases'
|
||||
sidebar_current: cli-aliases
|
||||
description: |-
|
||||
Custom Vagrant commands can be defined using aliases, allowing for a simpler,
|
||||
@ -18,7 +19,7 @@ Aliases can be defined within `VAGRANT_HOME/aliases` file, or in a custom file
|
||||
defined using the `VAGRANT_ALIAS_FILE` environment variable, in the following
|
||||
format:
|
||||
|
||||
```
|
||||
```shell
|
||||
# basic command-level aliases
|
||||
start = up
|
||||
stop = halt
|
||||
@ -40,13 +41,13 @@ useful for creating commands that you think _should_ exist. For example,
|
||||
if `vagrant stop` feels more intuitive than `vagrant halt`, the following alias
|
||||
definitions would make that change possible:
|
||||
|
||||
```
|
||||
```shell
|
||||
stop = halt
|
||||
```
|
||||
|
||||
This makes the following commands equivalent:
|
||||
|
||||
```
|
||||
```shell
|
||||
vagrant stop
|
||||
vagrant halt
|
||||
```
|
||||
@ -62,13 +63,13 @@ and memory utilization of the active project's virtual machine. To do this, you
|
||||
could define a `vagrant metrics` command that returns the required information
|
||||
in an easy-to-read format, like so:
|
||||
|
||||
```
|
||||
```shell
|
||||
metrics = !ps aux | grep "[V]BoxHeadless" | grep $(cat .vagrant/machines/default/virtualbox/id) | awk '{ printf("CPU: %.02f%%, Memory: %.02f%%", $3, $4) }'
|
||||
```
|
||||
|
||||
The above alias, from within the context of an active Vagrant project, would
|
||||
print the CPU and memory utilization directly to the console:
|
||||
|
||||
```
|
||||
```text
|
||||
CPU: 4.20%, Memory: 11.00%
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant box - Command-Line Interface
|
||||
sidebar_title: 'box'
|
||||
sidebar_current: cli-box
|
||||
description: |-
|
||||
The "vagrant box" command is used to manage "vagrant box add", "vagrant box
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant cloud - Command-Line Interface
|
||||
sidebar_title: 'cloud'
|
||||
sidebar_current: cli-cloud
|
||||
description: |-
|
||||
The "vagrant cloud" command can be used for taking actions against
|
||||
@ -64,7 +65,7 @@ is available below.
|
||||
|
||||
Securely authenticate to Vagrant Cloud using a username and password:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant cloud auth login
|
||||
# ...
|
||||
Vagrant Cloud username:
|
||||
@ -73,14 +74,14 @@ Vagrant Cloud password:
|
||||
|
||||
Check if the current user is authenticated:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant cloud auth login --check
|
||||
You are already logged in.
|
||||
```
|
||||
|
||||
Securely authenticate with Vagrant Cloud using a token:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant cloud auth login --token ABCD1234
|
||||
The token was successfully saved.
|
||||
```
|
||||
@ -220,7 +221,7 @@ the information required before creating or updating a new box.
|
||||
|
||||
Creating a new box on Vagrant Cloud:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant cloud publish briancain/supertest 1.0.0 virtualbox boxes/my/virtualbox.box -d "A really cool box to download and use" --version-description "A cool version" --release --short-description "Download me!"
|
||||
You are about to create a box on Vagrant Cloud with the following options:
|
||||
briancain/supertest (1.0.0) for virtualbox
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant connect - Command-Line Interface
|
||||
sidebar_title: 'connect'
|
||||
sidebar_current: cli-connect
|
||||
description: |-
|
||||
The "vagrant connect" command compliments the "vagrant share" command to allow
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant destroy - Command-Line Interface
|
||||
sidebar_title: 'destroy'
|
||||
sidebar_current: cli-destroy
|
||||
description: |-
|
||||
The "vagrant destroy" command is used to stop the running virtual machine and
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant global-status - Command-Line Interface
|
||||
sidebar_title: 'global-status'
|
||||
sidebar_current: cli-globalstatus
|
||||
description: |-
|
||||
The "vagrant global-status" command is used to determine the state of all
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant halt - Command-Line Interface
|
||||
sidebar_title: 'halt'
|
||||
sidebar_current: cli-halt
|
||||
description: |-
|
||||
The "vagrant halt" command is used to shut down the virtual machine that
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Command-Line Interface
|
||||
sidebar_title: 'Commands (CLI)'
|
||||
sidebar_current: cli
|
||||
description: Almost all interaction with Vagrant is done via the command-line interface.
|
||||
---
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant init - Command-Line Interface
|
||||
sidebar_title: 'init'
|
||||
sidebar_current: cli-init
|
||||
description: |-
|
||||
The "vagrant init" command is used to initialize the current directory to be
|
||||
@ -42,30 +43,30 @@ setting in the created Vagrantfile.
|
||||
|
||||
Create a base Vagrantfile:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant init hashicorp/bionic64
|
||||
```
|
||||
|
||||
Create a minimal Vagrantfile (no comments or helpers):
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant init -m hashicorp/bionic64
|
||||
```
|
||||
|
||||
Create a new Vagrantfile, overwriting the one at the current path:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant init -f hashicorp/bionic64
|
||||
```
|
||||
|
||||
Create a Vagrantfile with the specific box, from the specific box URL:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant init my-company-box https://boxes.company.com/my-company.box
|
||||
```
|
||||
|
||||
Create a Vagrantfile, locking the box to a version constraint:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant init --box-version '> 0.1.5' hashicorp/bionic64
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant login - Command-Line Interface
|
||||
sidebar_title: 'login'
|
||||
sidebar_current: cli-login
|
||||
description: |-
|
||||
The "vagrant login" command is used to authenticate Vagrant with HashiCorp's
|
||||
@ -40,7 +41,7 @@ is available below.
|
||||
|
||||
Securely authenticate to Vagrant Cloud using a username and password:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant login
|
||||
# ...
|
||||
Vagrant Cloud username:
|
||||
@ -49,14 +50,14 @@ Vagrant Cloud password:
|
||||
|
||||
Check if the current user is authenticated:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant login --check
|
||||
You are already logged in.
|
||||
```
|
||||
|
||||
Securely authenticate with Vagrant Cloud using a token:
|
||||
|
||||
```text
|
||||
```shell-session
|
||||
$ vagrant login --token ABCD1234
|
||||
The token was successfully saved.
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Machine Readable Output - Command-Line Interface
|
||||
sidebar_title: 'Machine Readable Output'
|
||||
sidebar_current: cli-machinereadable
|
||||
description: |-
|
||||
Almost all commands in Vagrant accept a --machine-readable flag to enable
|
||||
@ -77,80 +78,14 @@ become a literal `\r`.
|
||||
This section documents all the available types that may be outputted
|
||||
with the machine-readable output.
|
||||
|
||||
<table class="table table-hover table-bordered mr-types">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="mr-type">Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tr>
|
||||
<td>box-name</td>
|
||||
<td>Name of a box installed into Vagrant.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>box-provider</td>
|
||||
<td>Provider for an installed box.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>cli-command</td>
|
||||
<td>
|
||||
A subcommand of <code>vagrant</code> that is available.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>error-exit</td>
|
||||
<td>
|
||||
An error occurred that caused Vagrant to exit. This contains that error.
|
||||
Contains two data elements: type of error, error message.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>provider-name</td>
|
||||
<td>
|
||||
The provider name of the target machine.
|
||||
<span class="label">targeted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>ssh-config</td>
|
||||
<td>
|
||||
The OpenSSH compatible SSH config for a machine. This is usually the result
|
||||
of the "ssh-config" command.
|
||||
<span class="label">targeted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state</td>
|
||||
<td>
|
||||
The state ID of the target machine.
|
||||
<span class="label">targeted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state-human-long</td>
|
||||
<td>
|
||||
Human-readable description of the state of the machine. This is the long
|
||||
version, and may be a paragraph or longer.
|
||||
<span class="label">targeted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state-human-short</td>
|
||||
<td>
|
||||
Human-readable description of the state of the machine. This is the short
|
||||
version, limited to at most a sentence.
|
||||
<span class="label">targeted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
| Type | Description |
|
||||
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| box-name | Name of a box installed into Vagrant. |
|
||||
| box-provider | Provider for an installed box. |
|
||||
| cli-command | A subcommand of vagrant that is available. |
|
||||
| error-exit | An error occurred that caused Vagrant to exit. This contains that error. Contains two data elements: type of error, error message. |
|
||||
| provider-name | The provider name of the target machine. `targeted` |
|
||||
| ssh-config | The OpenSSH compatible SSH config for a machine. This is usually the result of the "ssh-config" command. `targeted` |
|
||||
| state | The state ID of the target machine. `targeted` |
|
||||
| state-human-long | Human-readable description of the state of the machine. This is the long version, and may be a paragraph or longer. `targeted` |
|
||||
| state-human-short | Human-readable description of the state of the machine. This is the short version, limited to at most a sentence. `targeted` |
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: More Vagrant Commands - Command-Line Interface
|
||||
sidebar_title: 'More Commands'
|
||||
sidebar_current: cli-nonprimary
|
||||
description: |-
|
||||
In addition to the commands listed in the sidebar and shown in "vagrant -h",
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant package - Command-Line Interface
|
||||
sidebar_title: 'package'
|
||||
sidebar_current: cli-package
|
||||
description: |-
|
||||
The "vagrant package" command is used to package a currently-running
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant plugin - Command-Line Interface
|
||||
sidebar_title: 'plugin'
|
||||
sidebar_current: cli-plugin
|
||||
description: |-
|
||||
The "vagrant plugin" command is used to manage Vagrant plugins including
|
||||
@ -37,7 +38,7 @@ an internal incompatibility. The expunge command can help make that process
|
||||
easier by attempting to automatically reinstall currently configured
|
||||
plugins:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
# Delete all plugins and reinstall
|
||||
$ vagrant plugin expunge --reinstall
|
||||
```
|
||||
@ -60,7 +61,7 @@ repositories, usually [RubyGems](https://rubygems.org). This command will
|
||||
also update a plugin if it is already installed, but you can also use
|
||||
`vagrant plugin update` for that.
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
# Installing a plugin from a known gem source
|
||||
$ vagrant plugin install my-plugin
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant port - Command-Line Interface
|
||||
sidebar_title: 'port'
|
||||
sidebar_current: cli-port
|
||||
description: |-
|
||||
The "vagrant port" command is used to display the full list of guest ports
|
||||
@ -14,7 +15,7 @@ description: |-
|
||||
The port command displays the full list of guest ports mapped to the host
|
||||
machine ports:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant port
|
||||
22 (guest) => 2222 (host)
|
||||
80 (guest) => 8080 (host)
|
||||
@ -22,7 +23,7 @@ $ vagrant port
|
||||
|
||||
In a multi-machine Vagrantfile, the name of the machine must be specified:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant port my-machine
|
||||
```
|
||||
|
||||
@ -32,7 +33,9 @@ $ vagrant port my-machine
|
||||
given guest port. If the guest is not forwarding that port, an error is
|
||||
returned. This is useful for quick scripting, for example:
|
||||
|
||||
$ ssh -p $(vagrant port --guest 22)
|
||||
```shell-session
|
||||
$ ssh -p $(vagrant port --guest 22)
|
||||
```
|
||||
|
||||
- `--machine-readable` - This tells Vagrant to display machine-readable output
|
||||
instead of the human-friendly output. More information is available in the
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant powershell - Command-Line Interface
|
||||
sidebar_title: 'powershell'
|
||||
sidebar_current: cli-powershell
|
||||
description: |-
|
||||
The "vagrant powershell" command is used to open a powershell prompt running
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant provision - Command-Line Interface
|
||||
sidebar_title: 'provision'
|
||||
sidebar_current: cli-provision
|
||||
description: |-
|
||||
The "vagrant provision" command is used to run any provisioners configured
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant rdp - Command-Line Interface
|
||||
sidebar_title: 'rdp'
|
||||
sidebar_current: cli-rdp
|
||||
description: |-
|
||||
The "vagrant rdp" command is used to start an RDP client for a remote desktop
|
||||
@ -21,7 +22,7 @@ You can pass raw arguments through to your RDP client on the
|
||||
command-line by appending it after a `--`. Vagrant just passes
|
||||
these through. For example:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant rdp -- /span
|
||||
```
|
||||
|
||||
@ -32,7 +33,7 @@ On Darwin hosts, such as Mac OS X, the additional arguments are added to the
|
||||
generated RDP configuration file. Since these files can contain multiple options
|
||||
with different spacing, you _must_ quote multiple arguments. For example:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant rdp -- "screen mode id:i:0" "other config:s:value"
|
||||
```
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant reload - Command-Line Interface
|
||||
sidebar_title: 'reload'
|
||||
sidebar_current: cli-reload
|
||||
description: |-
|
||||
The "vagrant reload" command is the equivalent of running "vagrant halt"
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant resume - Command-Line Interface
|
||||
sidebar_title: 'resume'
|
||||
sidebar_current: cli-resume
|
||||
description: |-
|
||||
The "vagrant resume" command is used to bring a machine back into the "up"
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant share - Command-Line Interface
|
||||
sidebar_title: 'share'
|
||||
sidebar_current: cli-share
|
||||
description: |-
|
||||
The "vagrant share" command initializes a new Vagrant share session, which
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant snapshot - Command-Line Interface
|
||||
sidebar_title: 'snapshot'
|
||||
sidebar_current: cli-snapshot
|
||||
description: |-
|
||||
The "vagrant snapshot" command is used to manage snapshots of the guest
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant ssh - Command-Line Interface
|
||||
sidebar_title: 'ssh'
|
||||
sidebar_current: cli-ssh
|
||||
description: |-
|
||||
The "vagrant ssh" command is used to establish an SSH session into a running
|
||||
@ -17,7 +18,7 @@ On a simple vagrant project, the instance created will be named default.
|
||||
|
||||
Vagrant will ssh into this instance without the instance name:
|
||||
|
||||
```bash
|
||||
```shell-session
|
||||
$ vagrant ssh
|
||||
|
||||
Welcome to your Vagrant-built virtual machine.
|
||||
@ -28,7 +29,7 @@ Connection to 127.0.0.1 closed.
|
||||
|
||||
Or you could use the name:
|
||||
|
||||
```bash
|
||||
```shell-session
|
||||
$ vagrant ssh default
|
||||
|
||||
|
||||
@ -42,8 +43,8 @@ $
|
||||
On multi-machine setups, you can login to each vm using the name as displayed
|
||||
on `vagrant status`
|
||||
|
||||
```bash
|
||||
$ vagrant status
|
||||
```shell-session
|
||||
$ vagrant status
|
||||
Current machine states:
|
||||
|
||||
node1 running (virtualbox)
|
||||
@ -69,7 +70,7 @@ $
|
||||
On a system with machines running from different projects, you could use the id
|
||||
as listed in `vagrant global-status`
|
||||
|
||||
```bash
|
||||
```shell-session
|
||||
$ vagrant global-status
|
||||
id name provider state directory
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant ssh-config - Command-Line Interface
|
||||
sidebar_title: 'ssh-config'
|
||||
sidebar_current: cli-ssh_config
|
||||
description: |-
|
||||
The "vagrant ssh-config" command is used to output a valid SSH configuration
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant status - Command-Line Interface
|
||||
sidebar_title: 'status'
|
||||
sidebar_current: cli-status
|
||||
description: |-
|
||||
The "vagrant status" command is used to tell you the status of the virtual
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant suspend - Command-Line Interface
|
||||
sidebar_title: 'suspend'
|
||||
sidebar_current: cli-suspend
|
||||
description: |-
|
||||
The "vagrant suspend" command is used to suspend the guest machine Vagrant is
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant up - Command-Line Interface
|
||||
sidebar_title: 'up'
|
||||
sidebar_current: cli-up
|
||||
description: |-
|
||||
The "vagrant up" command is used to create, configuration, and provision a
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant upload - Command-Line Interface
|
||||
sidebar_title: 'upload'
|
||||
sidebar_current: cli-upload
|
||||
description: |-
|
||||
The "vagrant upload" command is used to upload files from the host
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant validate - Command-Line Interface
|
||||
sidebar_title: 'validate'
|
||||
sidebar_current: cli-validate
|
||||
description: The "vagrant validate" command is used to validate your Vagrantfile.
|
||||
---
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: vagrant version - Command-Line Interface
|
||||
sidebar_title: 'version'
|
||||
sidebar_current: cli-version
|
||||
description: |-
|
||||
The "vagrant version" command is used to output the version of Vagrant
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Vagrant Disks Configuration
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: disks-configuration
|
||||
description: Documentation of various configuration options for Vagrant Disks
|
||||
---
|
||||
@ -24,12 +25,12 @@ Vagrant Disks has several options that allow users to define and attach disks to
|
||||
- `provider_config` (hash) - Additional provider specific options for managing a given disk. Please refer to
|
||||
the provider specific documentation to see any available provider_config options.
|
||||
|
||||
Generally, the disk option accepts two kinds of ways to define a provider config:
|
||||
Generally, the disk option accepts two kinds of ways to define a provider config:
|
||||
|
||||
+ `providername__diskoption: value`
|
||||
- The provider name followed by a double underscore, and then the provider specific option for that disk
|
||||
+ `{providername: {diskoption: value}, otherprovidername: {diskoption: value}`
|
||||
- A hash where the top level key(s) are one or more providers, and each provider keys values are a hash of options and their values.
|
||||
- `providername__diskoption: value`
|
||||
- The provider name followed by a double underscore, and then the provider specific option for that disk
|
||||
- `{providername: {diskoption: value}, otherprovidername: {diskoption: value}`
|
||||
- A hash where the top level key(s) are one or more providers, and each provider keys values are a hash of options and their values.
|
||||
|
||||
- `size` (String) - The size of the disk to create. For example, `"10GB"`.
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Vagrant Disks
|
||||
sidebar_title: 'Disks'
|
||||
sidebar_current: disks
|
||||
description: Introduction to Vagrant Disks
|
||||
---
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Vagrant Disk Usage
|
||||
sidebar_title: 'Usage'
|
||||
sidebar_current: disks-usage
|
||||
description: Various Vagrant Disk examples
|
||||
---
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Common Issues - Disks VirtualBox Provider
|
||||
sidebar_title: 'Common Issues'
|
||||
sidebar_current: disks-providers-virtualbox-issues
|
||||
description: |-
|
||||
This page lists some common issues people run into with Vagrant and VirtualBox
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Disks for VirtualBox Provider
|
||||
sidebar_title: 'VirtualBox'
|
||||
sidebar_current: disks-providers-virtualbox
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for VirtualBox, a free,
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Usage - Disks VirtualBox Provider
|
||||
sidebar_title: 'Usage'
|
||||
sidebar_current: disks-providers-virtualbox-usage
|
||||
description: |-
|
||||
The Vagrant VirtualBox provider is used just like any other provider. Please
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Vagrant Experimental Feature Flag
|
||||
sidebar_title: 'Experimental'
|
||||
sidebar_current: experimental
|
||||
description: Introduction to Vagrants Experimental Feature Flag
|
||||
---
|
||||
@ -2,6 +2,7 @@
|
||||
layout: docs
|
||||
sidebar_current: overview
|
||||
page_title: Documentation
|
||||
sidebar_title: 'Overview'
|
||||
description: |-
|
||||
Welcome to the documentation for Vagrant - the command line utility for
|
||||
managing the lifecycle of virtual machines. This website aims to document
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Backwards Compatibility
|
||||
sidebar_title: 'Backwards Compatibility'
|
||||
sidebar_current: installation-backwards-compatibility
|
||||
description: Vagrant makes a very strict backwards-compatibility promise.
|
||||
---
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Installing Vagrant
|
||||
sidebar_title: 'Installation'
|
||||
sidebar_current: installation
|
||||
description: |-
|
||||
Installing Vagrant is extremely easy. Head over to the Vagrant downloads page
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Installing Vagrant from Source
|
||||
sidebar_title: 'From Source'
|
||||
sidebar_current: installation-source
|
||||
description: |-
|
||||
Installing Vagrant from source is an advanced topic and is only recommended
|
||||
@ -30,19 +31,19 @@ However, beware of the following pitfalls:
|
||||
|
||||
Clone Vagrant's repository from GitHub into the directory where you keep code on your machine:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ git clone https://github.com/hashicorp/vagrant.git
|
||||
```
|
||||
|
||||
Next, `cd` into that path. All commands will be run from this path:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ cd /path/to/your/vagrant/clone
|
||||
```
|
||||
|
||||
Run the `bundle` command with a required version\* to install the requirements:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ bundle install
|
||||
```
|
||||
|
||||
@ -55,14 +56,14 @@ In order to use your locally-installed version of Vagrant in other projects, you
|
||||
|
||||
First, run the following command from the Vagrant repo:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ bundle --binstubs exec
|
||||
```
|
||||
|
||||
This will generate files in `exec/`, including `vagrant`. You can now specify
|
||||
the full path to the `exec/vagrant` anywhere on your operating system:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ /path/to/vagrant/exec/vagrant init -m hashicorp/bionic64
|
||||
```
|
||||
|
||||
@ -72,7 +73,7 @@ supported. It's true. It's not. You should listen to those warnings.
|
||||
If you do not want to specify the full path to Vagrant (i.e. you just want to
|
||||
run `vagrant`), you can create a symbolic link to your exec:
|
||||
|
||||
```shell
|
||||
```shell-session
|
||||
$ ln -sf /path/to/vagrant/exec/vagrant /usr/local/bin/vagrant
|
||||
```
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Uninstalling Vagrant
|
||||
sidebar_title: 'Uninstallation'
|
||||
sidebar_current: installation-uninstallation
|
||||
description: |-
|
||||
Uninstalling Vagrant is easy and straightforward. You can either uninstall
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Upgrading from Vagrant 1.0
|
||||
sidebar_title: 'Upgrading from 1.0.x'
|
||||
sidebar_current: installation-1-0-upgrading
|
||||
description: |-
|
||||
The upgrade process from 1.0.x to 1.x is straightforward. Vagrant is
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Upgrading Vagrant
|
||||
sidebar_title: 'Upgrading'
|
||||
sidebar_current: installation-upgrading
|
||||
description: |-
|
||||
If you are upgrading from Vagrant 1.0.x, please read the specific page
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Multi-Machine
|
||||
sidebar_title: 'Multi-Machine'
|
||||
sidebar_current: multimachine
|
||||
description: |-
|
||||
Vagrant is able to define and control multiple guest machines per
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Basic Usage - Networking
|
||||
sidebar_title: 'Basic Usage'
|
||||
sidebar_current: networking-basic
|
||||
description: |-
|
||||
Vagrant offers multiple options for how you are able to connect your
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Forwarded Ports - Networking
|
||||
sidebar_title: 'Forwarded Ports'
|
||||
sidebar_current: networking-fp
|
||||
description: |-
|
||||
Vagrant forwarded ports allow you to access a port on your host machine and
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Networking
|
||||
sidebar_title: 'Networking'
|
||||
sidebar_current: networking
|
||||
description: |-
|
||||
In order to access the Vagrant environment created, Vagrant exposes
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Private Networks - Networking
|
||||
sidebar_title: 'Private Network'
|
||||
sidebar_current: networking-private
|
||||
description: |-
|
||||
Vagrant private networks allow you to access your guest machine by some
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Public Networks - Networking
|
||||
sidebar_title: 'Public Network'
|
||||
sidebar_current: networking-public
|
||||
description: |-
|
||||
Vagrant public networks are less private than private networks, and the exact
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Debugging and Troubleshooting
|
||||
sidebar_title: 'Debugging'
|
||||
sidebar_current: other-debugging
|
||||
description: |-
|
||||
As much as we try to keep Vagrant stable and bug free, it is inevitable
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Environmental Variables
|
||||
sidebar_title: 'Environmental Variables'
|
||||
sidebar_current: other-envvars
|
||||
description: |-
|
||||
Vagrant has a set of environmental variables that can be used to
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Other
|
||||
sidebar_title: 'Other'
|
||||
sidebar_current: other
|
||||
description: |-
|
||||
This page covers Vagrant information that does not quite fit under the other
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Vagrant and Windows Subsystem for Linux
|
||||
sidebar_title: 'WSL'
|
||||
sidebar_current: other-wsl
|
||||
description: |-
|
||||
An overview of using Vagrant on Windows within the Windows Subsystem
|
||||
@ -40,7 +41,7 @@ not be available. To enable Windows access, which will also enable the
|
||||
VirtualBox and Hyper-V providers, set the `VAGRANT_WSL_ENABLE_WINDOWS_ACCESS`
|
||||
environment variable:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"
|
||||
```
|
||||
|
||||
@ -59,7 +60,7 @@ Vagrant to access them.
|
||||
|
||||
For example, when using the VirtualBox provider:
|
||||
|
||||
```
|
||||
```shell
|
||||
export PATH="$PATH:/mnt/c/Program Files/Oracle/VirtualBox"
|
||||
```
|
||||
|
||||
@ -84,7 +85,7 @@ this environment variable is set, Vagrant will access the Windows system
|
||||
to run executables and enable things like synced folders. When running
|
||||
in a bash shell within WSL, the environment variable can be setup like so:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ export VAGRANT_WSL_ENABLE_WINDOWS_ACCESS="1"
|
||||
```
|
||||
|
||||
@ -114,7 +115,7 @@ in the `VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH` environment variable. For
|
||||
example, if a user wants to run a Vagrant project from the WSL that is located
|
||||
at `C:\TestDir\vagrant-project`:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
C:\Users\vagrant> cd C:\TestDir\vagrant-project
|
||||
C:\TestDir\vagrant-project> bash
|
||||
vagrant@vagrant-10:/mnt/c/TestDir/vagrant-project$ export VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH="/mnt/c/TestDir"
|
||||
@ -128,6 +129,6 @@ the daemon _can_ be run on Windows and accessed by Vagrant while running in the
|
||||
WSL. Once docker is installed and running on Windows, export the following
|
||||
environment variable to give Vagrant access:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
vagrant@vagrant-10:/mnt/c/Users/vagrant$ export DOCKER_HOST=tcp://127.0.0.1:2375
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Plugin Development Basics - Action Hooks
|
||||
sidebar_title: 'Action Hooks'
|
||||
sidebar_current: plugins-action-hooks
|
||||
description: |-
|
||||
Action hooks provide ways to interact with Vagrant at a very low level by
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Command Plugins - Plugin Development
|
||||
sidebar_title: 'Commands'
|
||||
sidebar_current: plugins-commands
|
||||
description: |-
|
||||
This page documents how to add new commands to Vagrant, invocable
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Configuration - Plugin Development
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: plugins-configuration
|
||||
description: |-
|
||||
This page documents how to add new configuration options to Vagrant,
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Plugin Development Basics - Plugins
|
||||
sidebar_title: 'Plugin Development Basics'
|
||||
sidebar_current: plugins-development-basics
|
||||
description: |-
|
||||
Plugins are a great way to augment or change the behavior and functionality
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Guest Capabilities - Plugin Development
|
||||
sidebar_title: 'Guest Capabilities'
|
||||
sidebar_current: plugins-guestcapabilities
|
||||
description: |-
|
||||
This page documents how to add new capabilities for guests to Vagrant,
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Guests - Plugin Development
|
||||
sidebar_title: 'Guests'
|
||||
sidebar_current: plugins-guests
|
||||
description: |-
|
||||
This page documents how to add new guest OS detection to Vagrant, allowing
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Host Capabilities - Plugin Development
|
||||
sidebar_title: 'Host Capabilities'
|
||||
sidebar_current: plugins-hostcapabilities
|
||||
description: >-
|
||||
This page documents how to add new capabilities for hosts to Vagrant, allowing
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Hosts - Plugin Development
|
||||
sidebar_title: 'Hosts'
|
||||
sidebar_current: plugins-hosts
|
||||
description: |-
|
||||
This page documents how to add new host OS detection to Vagrant, allowing
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Plugins
|
||||
sidebar_title: 'Plugins'
|
||||
sidebar_current: plugins
|
||||
description: |-
|
||||
Vagrant comes with many great features out of the box to get your environments
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Packaging and Distribution - Plugin Development
|
||||
sidebar_title: 'Packaging & Distribution'
|
||||
sidebar_current: plugins-packaging
|
||||
description: |-
|
||||
This page documents how to organize the file structure of your plugin
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Providers - Plugin Development
|
||||
sidebar_title: 'Providers'
|
||||
sidebar_current: plugins-providers
|
||||
description: |-
|
||||
This page documents how to add support for new providers to Vagrant, allowing
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Provisioners - Plugin Development
|
||||
sidebar_title: 'Provisioners'
|
||||
sidebar_current: plugins-provisioners
|
||||
script: |-
|
||||
This page documents how to add new provisioners to Vagrant, allowing Vagrant
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Plugin Usage - Plugins
|
||||
sidebar_title: 'Usage'
|
||||
sidebar_current: plugins-usage
|
||||
description: |-
|
||||
Installing a Vagrant plugin is easy, and should not take more than a few
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Basic Usage - Providers
|
||||
sidebar_title: 'Basic Usage'
|
||||
sidebar_current: providers-basic-usage
|
||||
description: |-
|
||||
Vagrant boxes are all provider-specific. A box for VirtualBox is incompatible
|
||||
@ -22,7 +23,7 @@ as the providers differ. So you can have both a VirtualBox and VMware Fusion
|
||||
|
||||
Installing boxes has not changed at all:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant box add hashicorp/bionic64
|
||||
```
|
||||
|
||||
@ -30,7 +31,7 @@ Vagrant now automatically detects what provider a box is for. This is
|
||||
visible when listing boxes. Vagrant puts the provider in parentheses next
|
||||
to the name, as can be seen below.
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant box list
|
||||
bionic64 (virtualbox)
|
||||
bionic64 (vmware_fusion)
|
||||
@ -46,7 +47,7 @@ In normal day-to-day usage, the `--provider` flag is not necessary
|
||||
since Vagrant can usually pick the right provider for you. More details
|
||||
on how it does this is below.
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vagrant up --provider=vmware_fusion
|
||||
```
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Configuration - Providers
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: providers-configuration
|
||||
description: |-
|
||||
While well-behaved Vagrant providers should work with any Vagrantfile with
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Custom Provider - Providers
|
||||
sidebar_title: 'Custom Provider'
|
||||
sidebar_current: providers-custom
|
||||
description: |-
|
||||
To learn how to make your own custom Vagrant providers, read the Vagrant
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Default Provider - Providers
|
||||
sidebar_title: 'Default Provider'
|
||||
sidebar_current: providers-default
|
||||
description: |-
|
||||
By default, VirtualBox is the default provider for Vagrant. VirtualBox is
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Basic Usage - Docker Provider
|
||||
sidebar_title: 'Basic Usage'
|
||||
sidebar_current: providers-docker-basics
|
||||
description: |-
|
||||
The Docker provider in Vagrant behaves just like any other provider.
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Boxes - Docker Provider
|
||||
sidebar_title: 'Boxes'
|
||||
sidebar_current: providers-docker-boxes
|
||||
description: |-
|
||||
The Docker provider does not require a Vagrant box. The "config.vm.box"
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Commands - Docker Provider
|
||||
sidebar_title: 'Commands'
|
||||
sidebar_current: providers-docker-commands
|
||||
description: |-
|
||||
The Docker provider exposes some additional Vagrant commands that are
|
||||
@ -22,7 +23,7 @@ underneath.
|
||||
a Docker container that is currently running. If the container is not running,
|
||||
an error will be returned.
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-exec app -- rake db:migrate
|
||||
```
|
||||
|
||||
@ -42,13 +43,13 @@ end
|
||||
This Vagrantfile will start the official Docker Consul image. However, the
|
||||
associated Vagrant command to `docker-exec` into this instance is:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-exec -it -- /bin/sh
|
||||
```
|
||||
|
||||
In particular, the command is actually:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-exec default -it -- /bin/sh
|
||||
```
|
||||
|
||||
@ -74,14 +75,14 @@ end
|
||||
|
||||
The following command is invalid:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
# Not valid
|
||||
$ vagrant docker-exec -it nginx -- /bin/sh
|
||||
```
|
||||
|
||||
This is because the "name" of the VM is "web", so the command is actually:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-exec -it web -- /bin/sh
|
||||
```
|
||||
|
||||
@ -89,7 +90,7 @@ For this reason, it is recommended that you name the VM the same as the
|
||||
container. In the above example, it is unambiguous that the command to enter
|
||||
the Consul container is:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-exec -it consul -- /bin/sh
|
||||
```
|
||||
|
||||
@ -106,7 +107,7 @@ a Docker container. The one-off Docker container that is started shares
|
||||
all the volumes, links, etc. of the original Docker container. An
|
||||
example is shown below:
|
||||
|
||||
```sh
|
||||
```shell-session
|
||||
$ vagrant docker-run app -- rake db:migrate
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Configuration- Docker Provider
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: providers-docker-configuration
|
||||
description: |-
|
||||
The Docker provider has some provider-specific configuration options
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Docker Provider
|
||||
sidebar_title: 'Docker'
|
||||
sidebar_current: providers-docker
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Networking - Docker Provider
|
||||
sidebar_title: 'Networking'
|
||||
sidebar_current: providers-docker-networking
|
||||
description: |-
|
||||
The Vagrant Docker provider supports using the private network using the
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Creating a Base Box - Hyper-V Provider
|
||||
sidebar_title: 'Creating a Base Box'
|
||||
sidebar_current: providers-hyperv-boxes
|
||||
description: |-
|
||||
As with every Vagrant provider, the Vagrant Hyper-V provider has a custom box
|
||||
@ -54,7 +55,7 @@ are reproduced here in case similar steps are needed with other distributions.
|
||||
Without these commands, Ubuntu 12.04 will not report an IP address to
|
||||
Hyper-V:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ sudo apt-get install linux-tools-3.11.0-15-generic
|
||||
$ sudo apt-get install hv-kvp-daemon-init
|
||||
$ sudo cp /usr/lib/linux-tools/3.11.0-15/hv_* /usr/sbin/
|
||||
@ -84,7 +85,7 @@ provider value to use for the metadata is "hyperv".
|
||||
Finally, create an archive of those contents (but _not_ the parent folder)
|
||||
using a tool such as `tar`:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ tar cvzf ~/custom.box ./*
|
||||
```
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Configuration- Hyper-V Provider
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: providers-hyperv-configuration
|
||||
description: |-
|
||||
The Vagrant Hyper-V provider has some provider-specific configuration options
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Hyper-V Provider
|
||||
sidebar_title: 'Hyper-V'
|
||||
sidebar_current: providers-hyperv
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for Hyper-V, a native hypervisor
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Limitations - Hyper-V Provider
|
||||
sidebar_title: 'Limitations'
|
||||
sidebar_current: providers-hyperv-limitations
|
||||
description: |-
|
||||
The Hyper-V provider works in almost every way like the VirtualBox
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Usage - Hyper-V Provider
|
||||
sidebar_title: 'Usage'
|
||||
sidebar_current: providers-hyperv-usage
|
||||
description: |-
|
||||
The Hyper-V provider is used just like any other provider. Please read the
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Providers
|
||||
sidebar_title: 'Providers'
|
||||
sidebar_current: providers
|
||||
description: |-
|
||||
While Vagrant ships out of the box with support for VirtualBox, Hyper-V, and
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Installation - Providers
|
||||
sidebar_title: 'Installation'
|
||||
sidebar_current: providers-installation
|
||||
description: |-
|
||||
Providers are distributed as Vagrant plugins, and are therefore installed
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Creating a Base Box - VirtualBox Provider
|
||||
sidebar_title: 'Creating a Base Box'
|
||||
sidebar_current: providers-virtualbox-boxes
|
||||
description: |-
|
||||
As with every Vagrant provider, the Vagrant VirtualBox provider has a custom
|
||||
@ -62,7 +63,7 @@ Before installing the guest additions, you will need the linux kernel headers
|
||||
and the basic developer tools. On Ubuntu, you can easily install these like
|
||||
so:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ sudo apt-get install linux-headers-$(uname -r) build-essential dkms
|
||||
```
|
||||
|
||||
@ -73,14 +74,14 @@ GUI and clicking on "Devices" followed by "Install Guest Additions".
|
||||
Then mount the CD-ROM to some location. On Ubuntu, this usually looks like
|
||||
this:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ sudo mount /dev/cdrom /media/cdrom
|
||||
```
|
||||
|
||||
Finally, run the shell script that matches your system to install the
|
||||
guest additions. For example, for Linux on x86, it is the following:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ sudo sh /media/cdrom/VBoxLinuxAdditions.run
|
||||
```
|
||||
|
||||
@ -93,7 +94,7 @@ version by selecting the appropriate version
|
||||
[here](http://download.virtualbox.org/virtualbox/). The examples below use
|
||||
4.3.8, which was the latest VirtualBox version at the time of writing.
|
||||
|
||||
```
|
||||
```text
|
||||
wget http://download.virtualbox.org/virtualbox/4.3.8/VBoxGuestAdditions_4.3.8.iso
|
||||
sudo mkdir /media/VBoxGuestAdditions
|
||||
sudo mount -o loop,ro VBoxGuestAdditions_4.3.8.iso /media/VBoxGuestAdditions
|
||||
@ -137,7 +138,7 @@ A VirtualBox base box is an archive of the resulting files of
|
||||
a VirtualBox virtual machine. Here is an example of what is contained
|
||||
in such a box:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ tree
|
||||
.
|
||||
|-- Vagrantfile
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Common Issues - VirtualBox Provider
|
||||
sidebar_title: 'Common Issues'
|
||||
sidebar_current: providers-virtualbox-issues
|
||||
description: |-
|
||||
This page lists some common issues people run into with Vagrant and VirtualBox
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Configuration - VirtualBox Provider
|
||||
sidebar_title: 'Configuration'
|
||||
sidebar_current: providers-virtualbox-configuration
|
||||
description: |-
|
||||
The VirtualBox provider exposes some additional configuration options
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: VirtualBox Provider
|
||||
sidebar_title: 'VirtualBox'
|
||||
sidebar_current: providers-virtualbox
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for VirtualBox, a free,
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Networking - VirtualBox Provider
|
||||
sidebar_title: 'Networking'
|
||||
sidebar_current: providers-virtualbox-networking
|
||||
description: |-
|
||||
The Vagrant VirtualBox provider supports using the private network as a
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Usage - VirtualBox Provider
|
||||
sidebar_title: 'Usage'
|
||||
sidebar_current: providers-virtualbox-usage
|
||||
description: |-
|
||||
The Vagrant VirtualBox provider is used just like any other provider. Please
|
||||
@ -1,6 +1,7 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Box Format - VMware Provider
|
||||
sidebar_title: 'Boxes'
|
||||
sidebar_current: providers-vmware-boxes
|
||||
description: |-
|
||||
As with every Vagrant provider, the Vagrant VMware providers have a custom box
|
||||
@ -32,7 +33,7 @@ A VMware base box is a compressed archive of the necessary contents
|
||||
of a VMware "vmwarevm" file. Here is an example of what is contained
|
||||
in such a box:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ tree
|
||||
.
|
||||
|-- disk-s001.vmdk
|
||||
@ -121,7 +122,7 @@ possible. This can be done with `vmware-vdiskmanager` which is usually
|
||||
found in `/Applications/VMware Fusion.app/Contents/Library` for VMware Fusion. You first
|
||||
want to defragment then shrink the drive. Usage shown below:
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ vmware-vdiskmanager -d /path/to/main.vmdk
|
||||
...
|
||||
$ vmware-vdiskmanager -k /path/to/main.vmdk
|
||||
@ -134,7 +135,7 @@ Remove any extraneous files from the "vmwarevm" folder
|
||||
and package it. Be sure to compress the tar with gzip (done below in a
|
||||
single command) since VMware hard disks are not compressed by default.
|
||||
|
||||
```
|
||||
```shell-session
|
||||
$ cd /path/to/my/vm.vmwarevm
|
||||
$ tar cvzf custom.box ./*
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user