mirror of
https://github.com/hashicorp/vagrant.git
synced 2026-05-28 04:36:05 -04:00
initial content port
This commit is contained in:
parent
d0bc21cb07
commit
6efbb011bc
209 changed files with 2692 additions and 2747 deletions
61
website/components/tabs/README.md
Normal file
61
website/components/tabs/README.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# Tabs Component
|
||||
|
||||
> An MDX-compatible Tabs component
|
||||
|
||||
This React component renders tabbed content.
|
||||
|
||||
## Usage
|
||||
|
||||
- Use the `<Tabs>` tag in your markdown file to begin a tabbed content section.
|
||||
- Use the `<Tab>` tag with a `heading` prop to separate your markdown
|
||||
|
||||
### Important
|
||||
|
||||
A line must be skipped between the `<Tab>` and your markdown (for both above and below said markdown). [This is a limitation of MDX also pointed out by the Docusaurus folks 🔗 ](https://v2.docusaurus.io/docs/markdown-features/#multi-language-support-code-blocks)
|
||||
|
||||
### Example
|
||||
|
||||
```mdx
|
||||
<Tabs>
|
||||
<Tab heading="CLI command">
|
||||
<!-- Intentionally skipped line.. -->
|
||||
### Content
|
||||
<!-- Intentionally skipped line.. -->
|
||||
</Tab>
|
||||
<Tab heading="API call using cURL">
|
||||
|
||||
### Content
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
### Component Props
|
||||
|
||||
`<Tabs>` can be provided any arbitrary `children` so long as the `heading` prop is present the React or HTML tag used to wrap markdown, that said, we provide the `<Tab>` component to separate your tab content without rendering extra, unnecessary markup.
|
||||
|
||||
This works:
|
||||
|
||||
```mdx
|
||||
<Tabs>
|
||||
<Tab heading="CLI command">
|
||||
|
||||
### Content
|
||||
|
||||
</Tab>
|
||||
....
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
This _does not_ work:
|
||||
|
||||
```mdx
|
||||
<Tabs>
|
||||
<Tab> <!-- missing the `heading` prop to provide a tab heading -->
|
||||
|
||||
### Content
|
||||
|
||||
</Tab>
|
||||
....
|
||||
</Tabs>
|
||||
```
|
||||
17
website/components/tabs/index.jsx
Normal file
17
website/components/tabs/index.jsx
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
import ReactTabs from '@hashicorp/react-tabs'
|
||||
|
||||
export default function Tabs({ children }) {
|
||||
return (
|
||||
<ReactTabs
|
||||
items={children.map((Block) => ({
|
||||
heading: Block.props.heading,
|
||||
// eslint-disable-next-line react/display-name
|
||||
tabChildren: () => Block,
|
||||
}))}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
export function Tab({ children }) {
|
||||
return <>{children}</>
|
||||
}
|
||||
8
website/components/tabs/style.css
Normal file
8
website/components/tabs/style.css
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
/* This is a CSS overwrite on top of the existing component styles to accommodate the Learn layout */
|
||||
.g-tabs {
|
||||
& .g-grid-container,
|
||||
& > .g-grid-container {
|
||||
padding-left: 0;
|
||||
padding-right: 0;
|
||||
}
|
||||
}
|
||||
9
website/data/cloud-navigation.js
Normal file
9
website/data/cloud-navigation.js
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
// The root folder for this documentation category is `pages/docs`
|
||||
//
|
||||
// - A string refers to the name of a file
|
||||
// - A "category" value refers to the name of a directory
|
||||
// - All directories must have an "index.mdx" file to serve as
|
||||
// the landing page for the category, or a "name" property to
|
||||
// serve as the category title in the sidebar
|
||||
|
||||
export default []
|
||||
|
|
@ -1 +1,2 @@
|
|||
export default '2.2.8'
|
||||
export const VMWARE_UTILITY_VERSION = 'test'
|
||||
|
|
|
|||
|
|
@ -4,8 +4,9 @@ import { frontMatter as data } from '../pages/docs/**/*.mdx'
|
|||
import { MDXProvider } from '@mdx-js/react'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
import Tabs, { Tab } from '../components/tabs'
|
||||
|
||||
const DEFAULT_COMPONENTS = {}
|
||||
const DEFAULT_COMPONENTS = { Tabs, Tab }
|
||||
|
||||
function DocsLayoutWrapper(pageMeta) {
|
||||
function DocsLayout(props) {
|
||||
|
|
|
|||
43
website/layouts/vagrant-cloud.jsx
Normal file
43
website/layouts/vagrant-cloud.jsx
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
import DocsPage from '@hashicorp/react-docs-page'
|
||||
import order from '../data/cloud-navigation.js'
|
||||
import { frontMatter as data } from '../pages/vagrant-cloud/**/*.mdx'
|
||||
import { MDXProvider } from '@mdx-js/react'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
import Button from '@hashicorp/react-button'
|
||||
import Tabs, { Tab } from '../components/tabs'
|
||||
|
||||
const DEFAULT_COMPONENTS = { Button, Tabs, Tab }
|
||||
|
||||
function CloudLayoutWrapper(pageMeta) {
|
||||
function CloudLayout(props) {
|
||||
return (
|
||||
<MDXProvider components={DEFAULT_COMPONENTS}>
|
||||
<DocsPage
|
||||
{...props}
|
||||
product="vagrant"
|
||||
head={{
|
||||
is: Head,
|
||||
title: `${pageMeta.page_title} | Vagrant by HashiCorp`,
|
||||
description: pageMeta.description,
|
||||
siteName: 'Vagrant by HashiCorp',
|
||||
}}
|
||||
sidenav={{
|
||||
Link,
|
||||
category: 'Cloud',
|
||||
currentPage: props.path,
|
||||
data,
|
||||
order,
|
||||
}}
|
||||
resourceURL={`https://github.com/hashicorp/vagrant/blob/master/website/pages/${pageMeta.__resourcePath}`}
|
||||
/>
|
||||
</MDXProvider>
|
||||
)
|
||||
}
|
||||
|
||||
CloudLayout.getInitialProps = ({ asPath }) => ({ path: asPath })
|
||||
|
||||
return CloudLayout
|
||||
}
|
||||
|
||||
export default CloudLayoutWrapper
|
||||
|
|
@ -4,8 +4,9 @@ import { frontMatter as data } from '../pages/vmware/**/*.mdx'
|
|||
import { MDXProvider } from '@mdx-js/react'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
import Button from '@hashicorp/react-button'
|
||||
|
||||
const DEFAULT_COMPONENTS = {}
|
||||
const DEFAULT_COMPONENTS = { Button }
|
||||
|
||||
function VMWareLayoutWrapper(pageMeta) {
|
||||
function VMWareLayout(props) {
|
||||
|
|
|
|||
39
website/package-lock.json
generated
39
website/package-lock.json
generated
|
|
@ -1300,6 +1300,23 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"@hashicorp/react-tabs": {
|
||||
"version": "0.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@hashicorp/react-tabs/-/react-tabs-0.4.0.tgz",
|
||||
"integrity": "sha512-KSkd3akWC9843ybMEw1Ahga/yCfiG2BWLvjb1Hl1qVWrYIHPAYQ+W+mLvMRKJrGPlCMCTqpiNR5bK8iBvcDC/Q==",
|
||||
"requires": {
|
||||
"@hashicorp/react-global-styles": "^4.4.0",
|
||||
"@hashicorp/react-inline-svg": "^1.0.0",
|
||||
"@tippy.js/react": "^3.1.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@hashicorp/react-global-styles": {
|
||||
"version": "4.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@hashicorp/react-global-styles/-/react-global-styles-4.4.0.tgz",
|
||||
"integrity": "sha512-lv6XR2plm2m3+qO6VE+RYquTzOODIt3mQ/1fBT1bn7wsR0qxFiuryW4JfsF94oCGk++LkDkRt/8V742HiT+fHw=="
|
||||
}
|
||||
}
|
||||
},
|
||||
"@hashicorp/react-toggle": {
|
||||
"version": "1.0.1",
|
||||
"resolved": "https://registry.npmjs.org/@hashicorp/react-toggle/-/react-toggle-1.0.1.tgz",
|
||||
|
|
@ -1524,6 +1541,15 @@
|
|||
"defer-to-connect": "^1.0.1"
|
||||
}
|
||||
},
|
||||
"@tippy.js/react": {
|
||||
"version": "3.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@tippy.js/react/-/react-3.1.1.tgz",
|
||||
"integrity": "sha512-KF45vW/jKh/nBXk/2zzTFslv/T46zOMkIoDJ56ymZ+M00yHttk58J5wZ29oqGqDIUnobWSZD+cFpbR4u/UUvgw==",
|
||||
"requires": {
|
||||
"prop-types": "^15.6.2",
|
||||
"tippy.js": "^5.1.1"
|
||||
}
|
||||
},
|
||||
"@types/color-name": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
|
||||
|
|
@ -10015,6 +10041,11 @@
|
|||
"ts-pnp": "^1.1.2"
|
||||
}
|
||||
},
|
||||
"popper.js": {
|
||||
"version": "1.16.1",
|
||||
"resolved": "https://registry.npmjs.org/popper.js/-/popper.js-1.16.1.tgz",
|
||||
"integrity": "sha512-Wb4p1J4zyFTbM+u6WuO4XstYx4Ky9Cewe4DWrel7B0w6VVICvPwdOpotjzcf6eD8TsckVnIMNONQyPIUFOUbCQ=="
|
||||
},
|
||||
"posix-character-classes": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz",
|
||||
|
|
@ -15939,6 +15970,14 @@
|
|||
"resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz",
|
||||
"integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q="
|
||||
},
|
||||
"tippy.js": {
|
||||
"version": "5.2.1",
|
||||
"resolved": "https://registry.npmjs.org/tippy.js/-/tippy.js-5.2.1.tgz",
|
||||
"integrity": "sha512-66UT6JRVn3dXNCORE+0UvUK3JZqV/VhLlU6HTDm3FmrweUUFUxUGvT8tUQ7ycMp+uhuLAwQw6dBabyC+iKf/MA==",
|
||||
"requires": {
|
||||
"popper.js": "^1.16.0"
|
||||
}
|
||||
},
|
||||
"tmp": {
|
||||
"version": "0.0.33",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@
|
|||
"@hashicorp/react-product-downloader": "^3.1.2",
|
||||
"@hashicorp/react-section-header": "^2.0.0",
|
||||
"@hashicorp/react-subnav": "^3.1.1",
|
||||
"@hashicorp/react-tabs": "^0.4.0",
|
||||
"@hashicorp/react-vertical-text-block-list": "^2.0.1",
|
||||
"babel-plugin-import-glob-array": "^0.2.0",
|
||||
"imagemin-mozjpeg": "^8.0.0",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Boxes'
|
||||
sidebar_current: 'boxes'
|
||||
layout: docs
|
||||
page_title: Boxes
|
||||
sidebar_current: boxes
|
||||
description: |-
|
||||
Boxes are the package format for Vagrant environments. A box can be used by
|
||||
anyone on any platform that Vagrant supports to bring up an identical
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Creating a Base Box'
|
||||
sidebar_current: 'boxes-base'
|
||||
layout: docs
|
||||
page_title: Creating a Base Box
|
||||
sidebar_current: boxes-base
|
||||
description: |-
|
||||
There are a special category of boxes known as "base boxes." These boxes
|
||||
contain the bare minimum required for Vagrant to function, are generally
|
||||
|
|
@ -25,12 +25,10 @@ which to build future development environments. The Vagrant project hopes
|
|||
in the future to be able to provide base boxes for many more operating systems.
|
||||
Until then, this page documents how you can create your own base box.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Advanced topic!</strong> Creating a base box can be a time consuming
|
||||
and tedious process, and is not recommended for new Vagrant users. If you are
|
||||
just getting started with Vagrant, we recommend trying to find existing
|
||||
base boxes to use first.
|
||||
</div>
|
||||
~> **Advanced topic!** Creating a base box can be a time consuming
|
||||
and tedious process, and is not recommended for new Vagrant users. If you are
|
||||
just getting started with Vagrant, we recommend trying to find existing
|
||||
base boxes to use first.
|
||||
|
||||
## What's in a Base Box?
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Box File Format'
|
||||
sidebar_current: 'boxes-format'
|
||||
layout: docs
|
||||
page_title: Box File Format
|
||||
sidebar_current: boxes-format
|
||||
description: |-
|
||||
The box file format for Vagrant has changed from only supporting VirtualBox to
|
||||
supporting a number different providers and box formats.
|
||||
|
|
@ -84,12 +84,10 @@ The metadata is an optional component for a box (but highly recommended)
|
|||
that enables [versioning](/docs/boxes/versioning.html), updating, multiple
|
||||
providers from a single file, and more.
|
||||
|
||||
<div class="alert alert-block alert-info">
|
||||
<strong>You do not need to manually make the metadata.</strong> If you
|
||||
have an account with <a href="/docs/vagrant-cloud">HashiCorp's Vagrant Cloud</a>, you
|
||||
can create boxes there, and HashiCorp's Vagrant Cloud automatically creates
|
||||
the metadata for you. The format is still documented here.
|
||||
</div>
|
||||
-> **You do not need to manually make the metadata.** If you
|
||||
have an account with [HashiCorp's Vagrant Cloud](/docs/vagrant-cloud), you
|
||||
can create boxes there, and HashiCorp's Vagrant Cloud automatically creates
|
||||
the metadata for you. The format is still documented here.
|
||||
|
||||
It is a JSON document, structured in the following way:
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Box Info Format'
|
||||
sidebar_current: 'boxes-info'
|
||||
layout: docs
|
||||
page_title: Box Info Format
|
||||
sidebar_current: boxes-info
|
||||
description: |-
|
||||
A box can provide additional information to the user by supplying an info.json
|
||||
file within the box.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Box Versioning'
|
||||
sidebar_current: 'boxes-versioning'
|
||||
layout: docs
|
||||
page_title: Box Versioning
|
||||
sidebar_current: boxes-versioning
|
||||
description: |-
|
||||
Since Vagrant 1.5, boxes support versioning. This allows the people who
|
||||
make boxes to push updates to the box, and the people who use the box
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Aliases - Command-Line Interface'
|
||||
sidebar_current: 'cli-aliases'
|
||||
layout: docs
|
||||
page_title: Aliases - Command-Line Interface
|
||||
sidebar_current: cli-aliases
|
||||
description: |-
|
||||
Custom Vagrant commands can be defined using aliases, allowing for a simpler,
|
||||
easier, and more familiar command line interface.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant box - Command-Line Interface'
|
||||
sidebar_current: 'cli-box'
|
||||
layout: docs
|
||||
page_title: vagrant box - Command-Line Interface
|
||||
sidebar_current: cli-box
|
||||
description: |-
|
||||
The "vagrant box" command is used to manage "vagrant box add", "vagrant box
|
||||
remove", and other box-related commands such as "outdated", "list", and
|
||||
|
|
@ -99,11 +99,9 @@ you are not using a catalog).
|
|||
a catalog, the name is included in the catalog entry and does not have
|
||||
to be specified.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Checksums for versioned boxes or boxes from HashiCorp's Vagrant Cloud:</strong>
|
||||
For boxes from HashiCorp's Vagrant Cloud, the checksums are embedded in the metadata
|
||||
of the box. The metadata itself is served over TLS and its format is validated.
|
||||
</div>
|
||||
~> **Checksums for versioned boxes or boxes from HashiCorp's Vagrant Cloud:**
|
||||
For boxes from HashiCorp's Vagrant Cloud, the checksums are embedded in the metadata
|
||||
of the box. The metadata itself is served over TLS and its format is validated.
|
||||
|
||||
# Box List
|
||||
|
||||
|
|
@ -198,9 +196,9 @@ This command updates the box for the current Vagrant environment if there
|
|||
are updates available. The command can also update a specific box (outside
|
||||
of an active Vagrant environment), by specifying the `--box` flag.
|
||||
|
||||
<small><i>Note that updating the box will not update an already-running Vagrant
|
||||
-> Note that updating the box will not update an already-running Vagrant
|
||||
machine. To reflect the changes in the box, you will have to destroy and
|
||||
bring back up the Vagrant machine.</i></small>
|
||||
bring back up the Vagrant machine.
|
||||
|
||||
If you just want to check if there are updates available, use the
|
||||
`vagrant box outdated` command.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant cloud - Command-Line Interface'
|
||||
sidebar_current: 'cli-cloud'
|
||||
layout: docs
|
||||
page_title: vagrant cloud - Command-Line Interface
|
||||
sidebar_current: cli-cloud
|
||||
description: |-
|
||||
The "vagrant cloud" command can be used for taking actions against
|
||||
Vagrant Cloud like searching or uploading a Vagrant Box
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant connect - Command-Line Interface'
|
||||
sidebar_current: 'cli-connect'
|
||||
layout: docs
|
||||
page_title: vagrant connect - Command-Line Interface
|
||||
sidebar_current: cli-connect
|
||||
description: |-
|
||||
The "vagrant connect" command compliments the "vagrant share" command to allow
|
||||
a user to remotely connect to your Vagrant environment.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant destroy - Command-Line Interface'
|
||||
sidebar_current: 'cli-destroy'
|
||||
layout: docs
|
||||
page_title: vagrant destroy - Command-Line Interface
|
||||
sidebar_current: cli-destroy
|
||||
description: |-
|
||||
The "vagrant destroy" command is used to stop the running virtual machine and
|
||||
terminate use of all resources that were in use by that machine.
|
||||
|
|
@ -29,14 +29,10 @@ directory containing the `shutdown` command.
|
|||
supports it. Please consult the provider documentation to see if this feature
|
||||
is supported.
|
||||
|
||||
<div class="alert alert-info">
|
||||
The `destroy` command does not remove a box that may have been installed on
|
||||
your computer during `vagrant up`. Thus, even if you run `vagrant destroy`,
|
||||
the box installed in the system will still be present on the hard drive. To
|
||||
return your computer to the state as it was before `vagrant up` command, you
|
||||
need to use `vagrant box remove`.
|
||||
-> The `destroy` command does not remove a box that may have been installed on
|
||||
your computer during `vagrant up`. Thus, even if you run `vagrant destroy`,
|
||||
the box installed in the system will still be present on the hard drive. To
|
||||
return your computer to the state as it was before `vagrant up` command, you
|
||||
need to use `vagrant box remove`.
|
||||
|
||||
For more information, read about the
|
||||
<a href="/docs/cli/box.html">`vagrant box remove`</a> command.
|
||||
|
||||
</div>
|
||||
For more information, read about the [`vagrant box remove`](/docs/cli/box.html) command.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant global-status - Command-Line Interface'
|
||||
sidebar_current: 'cli-globalstatus'
|
||||
layout: docs
|
||||
page_title: vagrant global-status - Command-Line Interface
|
||||
sidebar_current: cli-globalstatus
|
||||
description: |-
|
||||
The "vagrant global-status" command is used to determine the state of all
|
||||
active Vagrant environments on the system for the currently logged in user.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant halt - Command-Line Interface'
|
||||
sidebar_current: 'cli-halt'
|
||||
layout: docs
|
||||
page_title: vagrant halt - Command-Line Interface
|
||||
sidebar_current: cli-halt
|
||||
description: |-
|
||||
The "vagrant halt" command is used to shut down the virtual machine that
|
||||
Vagrant is currently managing.
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Command-Line Interface'
|
||||
sidebar_current: 'cli'
|
||||
description: |-
|
||||
Almost all interaction with Vagrant is done via the command-line interface.
|
||||
layout: docs
|
||||
page_title: Command-Line Interface
|
||||
sidebar_current: cli
|
||||
description: Almost all interaction with Vagrant is done via the command-line interface.
|
||||
---
|
||||
|
||||
# Command-Line Interface
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant init - Command-Line Interface'
|
||||
sidebar_current: 'cli-init'
|
||||
layout: docs
|
||||
page_title: vagrant init - Command-Line Interface
|
||||
sidebar_current: cli-init
|
||||
description: |-
|
||||
The "vagrant init" command is used to initialize the current directory to be
|
||||
a Vagrant environment by creating an initial Vagrantfile.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant login - Command-Line Interface'
|
||||
sidebar_current: 'cli-login'
|
||||
layout: docs
|
||||
page_title: vagrant login - Command-Line Interface
|
||||
sidebar_current: cli-login
|
||||
description: |-
|
||||
The "vagrant login" command is used to authenticate Vagrant with HashiCorp's
|
||||
Vagrant Cloud service to use features like private boxes and "vagrant push".
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Machine Readable Output - Command-Line Interface'
|
||||
sidebar_current: 'cli-machinereadable'
|
||||
layout: docs
|
||||
page_title: Machine Readable Output - Command-Line Interface
|
||||
sidebar_current: cli-machinereadable
|
||||
description: |-
|
||||
Almost all commands in Vagrant accept a --machine-readable flag to enable
|
||||
machine-readable output mode.
|
||||
|
|
@ -21,11 +21,9 @@ may change as we determine more use cases for it. But the backwards
|
|||
compatibility promise should make it safe to write client libraries to
|
||||
parse the output format.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Advanced topic!</strong> This is an advanced topic for use only if
|
||||
you want to programmatically execute Vagrant. If you are just getting started
|
||||
with Vagrant, you may safely skip this section.
|
||||
</div>
|
||||
~> **Advanced topic!** This is an advanced topic for use only if
|
||||
you want to programmatically execute Vagrant. If you are just getting started
|
||||
with Vagrant, you may safely skip this section.
|
||||
|
||||
## Work-In-Progress
|
||||
|
||||
|
|
@ -88,75 +86,71 @@ with the machine-readable output.
|
|||
</thead>
|
||||
|
||||
<tr>
|
||||
<td>box-name</td>
|
||||
<td>
|
||||
Name of a box installed into Vagrant.
|
||||
</td>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'More Vagrant Commands - Command-Line Interface'
|
||||
sidebar_current: 'cli-nonprimary'
|
||||
layout: docs
|
||||
page_title: More Vagrant Commands - Command-Line Interface
|
||||
sidebar_current: cli-nonprimary
|
||||
description: |-
|
||||
In addition to the commands listed in the sidebar and shown in "vagrant -h",
|
||||
Vagrant comes with some more commands that are hidden from basic help output.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant package - Command-Line Interface'
|
||||
sidebar_current: 'cli-package'
|
||||
layout: docs
|
||||
page_title: vagrant package - Command-Line Interface
|
||||
sidebar_current: cli-package
|
||||
description: |-
|
||||
The "vagrant package" command is used to package a currently-running
|
||||
VirtualBox or Hyper-V vagrant environment into a reusable Vagrant box.
|
||||
|
|
@ -34,11 +34,8 @@ and if the provider supports it.
|
|||
as part of the [Vagrantfile load order](/docs/vagrantfile/#load-order)
|
||||
when the resulting box is used.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>A common misconception</strong> is that the <code>--vagrantfile</code>
|
||||
option will package a Vagrantfile that is used when <code>vagrant init</code>
|
||||
is used with this box. This is not the case. Instead, a Vagrantfile
|
||||
is loaded and read as part of the Vagrant load process when the box is
|
||||
used. For more information, read about the
|
||||
<a href="/docs/vagrantfile/#load-order">Vagrantfile load order</a>.
|
||||
</div>
|
||||
-> **A common misconception** is that the `--vagrantfile`
|
||||
option will package a Vagrantfile that is used when `vagrant init`
|
||||
is used with this box. This is not the case. Instead, a Vagrantfile
|
||||
is loaded and read as part of the Vagrant load process when the box is
|
||||
used. For more information, read about the [Vagrantfile load order](/docs/vagrantfile/#load-order).
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant plugin - Command-Line Interface'
|
||||
sidebar_current: 'cli-plugin'
|
||||
layout: docs
|
||||
page_title: vagrant plugin - Command-Line Interface
|
||||
sidebar_current: cli-plugin
|
||||
description: |-
|
||||
The "vagrant plugin" command is used to manage Vagrant plugins including
|
||||
installing, uninstalling, and license management.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant port - Command-Line Interface'
|
||||
sidebar_current: 'cli-port'
|
||||
layout: docs
|
||||
page_title: vagrant port - Command-Line Interface
|
||||
sidebar_current: cli-port
|
||||
description: |-
|
||||
The "vagrant port" command is used to display the full list of guest ports
|
||||
mapped to the host machine ports.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant powershell - Command-Line Interface'
|
||||
sidebar_current: 'cli-powershell'
|
||||
layout: docs
|
||||
page_title: vagrant powershell - Command-Line Interface
|
||||
sidebar_current: cli-powershell
|
||||
description: |-
|
||||
The "vagrant powershell" command is used to open a powershell prompt running
|
||||
inside the guest machine.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant provision - Command-Line Interface'
|
||||
sidebar_current: 'cli-provision'
|
||||
layout: docs
|
||||
page_title: vagrant provision - Command-Line Interface
|
||||
sidebar_current: cli-provision
|
||||
description: |-
|
||||
The "vagrant provision" command is used to run any provisioners configured
|
||||
for the guest machine, such as Puppet, Chef, Ansible, Salt, or Shell.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant rdp - Command-Line Interface'
|
||||
sidebar_current: 'cli-rdp'
|
||||
layout: docs
|
||||
page_title: vagrant rdp - Command-Line Interface
|
||||
sidebar_current: cli-rdp
|
||||
description: |-
|
||||
The "vagrant rdp" command is used to start an RDP client for a remote desktop
|
||||
session with the guest machine.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant reload - Command-Line Interface'
|
||||
sidebar_current: 'cli-reload'
|
||||
layout: docs
|
||||
page_title: vagrant reload - Command-Line Interface
|
||||
sidebar_current: cli-reload
|
||||
description: |-
|
||||
The "vagrant reload" command is the equivalent of running "vagrant halt"
|
||||
followed by "vagrant up".
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant resume - Command-Line Interface'
|
||||
sidebar_current: 'cli-resume'
|
||||
layout: docs
|
||||
page_title: vagrant resume - Command-Line Interface
|
||||
sidebar_current: cli-resume
|
||||
description: |-
|
||||
The "vagrant resume" command is used to bring a machine back into the "up"
|
||||
state, perhaps if it was previously suspended via "vagrant halt" or "vagrant
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant rsync-auto - Command-Line Interface'
|
||||
sidebar_current: 'cli-rsyncauto'
|
||||
layout: docs
|
||||
page_title: vagrant rsync-auto - Command-Line Interface
|
||||
sidebar_current: cli-rsyncauto
|
||||
description: |-
|
||||
The "vagrant rsync-auto" command watches all local directories of any rsync
|
||||
configured synced folders and automatically initiates an rsync transfer when
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant rsync - Command-Line Interface'
|
||||
sidebar_current: 'cli-rsync'
|
||||
description: |-
|
||||
The "vagrant rsync" command forces a re-sync of any rsync synced folders.
|
||||
layout: docs
|
||||
page_title: vagrant rsync - Command-Line Interface
|
||||
sidebar_current: cli-rsync
|
||||
description: The "vagrant rsync" command forces a re-sync of any rsync synced folders.
|
||||
---
|
||||
|
||||
# Rsync
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant share - Command-Line Interface'
|
||||
sidebar_current: 'cli-share'
|
||||
layout: docs
|
||||
page_title: vagrant share - Command-Line Interface
|
||||
sidebar_current: cli-share
|
||||
description: |-
|
||||
The "vagrant share" command initializes a new Vagrant share session, which
|
||||
allows you to share your virtual machine with the public Internet.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant snapshot - Command-Line Interface'
|
||||
sidebar_current: 'cli-snapshot'
|
||||
layout: docs
|
||||
page_title: vagrant snapshot - Command-Line Interface
|
||||
sidebar_current: cli-snapshot
|
||||
description: |-
|
||||
The "vagrant snapshot" command is used to manage snapshots of the guest
|
||||
machine.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant ssh - Command-Line Interface'
|
||||
sidebar_current: 'cli-ssh'
|
||||
layout: docs
|
||||
page_title: vagrant ssh - Command-Line Interface
|
||||
sidebar_current: cli-ssh
|
||||
description: |-
|
||||
The "vagrant ssh" command is used to establish an SSH session into a running
|
||||
virtual machine to give you shell access.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant ssh-config - Command-Line Interface'
|
||||
sidebar_current: 'cli-ssh_config'
|
||||
layout: docs
|
||||
page_title: vagrant ssh-config - Command-Line Interface
|
||||
sidebar_current: cli-ssh_config
|
||||
description: |-
|
||||
The "vagrant ssh-config" command is used to output a valid SSH configuration
|
||||
file capable of SSHing into the guest machine directly.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant status - Command-Line Interface'
|
||||
sidebar_current: 'cli-status'
|
||||
layout: docs
|
||||
page_title: vagrant status - Command-Line Interface
|
||||
sidebar_current: cli-status
|
||||
description: |-
|
||||
The "vagrant status" command is used to tell you the status of the virtual
|
||||
machines in the current Vagrant environment.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant suspend - Command-Line Interface'
|
||||
sidebar_current: 'cli-suspend'
|
||||
layout: docs
|
||||
page_title: vagrant suspend - Command-Line Interface
|
||||
sidebar_current: cli-suspend
|
||||
description: |-
|
||||
The "vagrant suspend" command is used to suspend the guest machine Vagrant is
|
||||
currently managing.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant up - Command-Line Interface'
|
||||
sidebar_current: 'cli-up'
|
||||
layout: docs
|
||||
page_title: vagrant up - Command-Line Interface
|
||||
sidebar_current: cli-up
|
||||
description: |-
|
||||
The "vagrant up" command is used to create, configuration, and provision a
|
||||
guest machine according to your Vagrantfile.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant upload - Command-Line Interface'
|
||||
sidebar_current: 'cli-upload'
|
||||
layout: docs
|
||||
page_title: vagrant upload - Command-Line Interface
|
||||
sidebar_current: cli-upload
|
||||
description: |-
|
||||
The "vagrant upload" command is used to upload files from the host
|
||||
to a guest machine.
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant validate - Command-Line Interface'
|
||||
sidebar_current: 'cli-validate'
|
||||
description: |-
|
||||
The "vagrant validate" command is used to validate your Vagrantfile.
|
||||
layout: docs
|
||||
page_title: vagrant validate - Command-Line Interface
|
||||
sidebar_current: cli-validate
|
||||
description: The "vagrant validate" command is used to validate your Vagrantfile.
|
||||
---
|
||||
|
||||
# Validate
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant version - Command-Line Interface'
|
||||
sidebar_current: 'cli-version'
|
||||
layout: docs
|
||||
page_title: vagrant version - Command-Line Interface
|
||||
sidebar_current: cli-version
|
||||
description: |-
|
||||
The "vagrant version" command is used to output the version of Vagrant
|
||||
currently installed on the system.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant winrm - Command-Line Interface'
|
||||
sidebar_current: 'cli-winrm'
|
||||
layout: docs
|
||||
page_title: vagrant winrm - Command-Line Interface
|
||||
sidebar_current: cli-winrm
|
||||
description: |-
|
||||
The "vagrant winrm" command is used execute commands on the remote
|
||||
machine via WinRM
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'vagrant winrm-config - Command-Line Interface'
|
||||
sidebar_current: 'cli-winrm_config'
|
||||
layout: docs
|
||||
page_title: vagrant winrm-config - Command-Line Interface
|
||||
sidebar_current: cli-winrm_config
|
||||
description: |-
|
||||
The "vagrant winrm-config" command is used to output the WinRM configuration
|
||||
used to connect to the guest machine.
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant Disks Configuration'
|
||||
sidebar_current: 'disks-configuration'
|
||||
description: |-
|
||||
Documentation of various configuration options for Vagrant Disks
|
||||
layout: docs
|
||||
page_title: Vagrant Disks Configuration
|
||||
sidebar_current: disks-configuration
|
||||
description: Documentation of various configuration options for Vagrant Disks
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
|
@ -61,11 +60,9 @@ config.vm.disk :floppy, name: "cool_files"
|
|||
|
||||
If you are a vagrant plugin author who maintains a provider for Vagrant, this short guide will hopefully give some information on how to use the internal disk config object.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This guide is still being written as we develop this
|
||||
new feature for Vagrant. Is something missing, or could this be improved? Please
|
||||
let us know on GitHub by opening an issue or open a pull request directly.
|
||||
</div>
|
||||
~> **Warning!** This guide is still being written as we develop this
|
||||
new feature for Vagrant. Is something missing, or could this be improved? Please
|
||||
let us know on GitHub by opening an issue or open a pull request directly.
|
||||
|
||||
All providers must implement the capability `configure_disks`, and `cleanup_disks`.
|
||||
These methods are responsible for the following:
|
||||
|
|
@ -1,19 +1,16 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant Disks'
|
||||
sidebar_current: 'disks'
|
||||
description: |-
|
||||
Introduction to Vagrant Disks
|
||||
layout: docs
|
||||
page_title: Vagrant Disks
|
||||
sidebar_current: disks
|
||||
description: Introduction to Vagrant Disks
|
||||
---
|
||||
|
||||
# Vagrant Disks
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional. Please refer to the providier specific disk documentation
|
||||
for more information on how to use and enable this feature.
|
||||
</div>
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional. Please refer to the providier specific disk documentation
|
||||
for more information on how to use and enable this feature.
|
||||
|
||||
Vagrant Disks is a feature that allows users to define what mediums should be attached
|
||||
to their guests, as well as allowing users to resize their primary disk.
|
||||
|
|
@ -1,17 +1,15 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant Disk Usage'
|
||||
sidebar_current: 'disks-usage'
|
||||
description: |-
|
||||
Various Vagrant Disk examples
|
||||
layout: docs
|
||||
page_title: Vagrant Disk Usage
|
||||
sidebar_current: disks-usage
|
||||
description: Various Vagrant Disk examples
|
||||
---
|
||||
|
||||
# Basic Usage
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
|
|
@ -26,8 +24,6 @@ for more info. Without this flag enabled, any disks defined will not be configur
|
|||
Also note that the examples below use the VirtualBox provider, which is the current
|
||||
supported providier for this feature.
|
||||
|
||||
</div>
|
||||
|
||||
Below are some very simple examples of how to use Vagrant Disks with the VirtualBox provider.
|
||||
|
||||
## Basic Examples
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Common Issues - Disks VirtualBox Provider'
|
||||
sidebar_current: 'disks-providers-virtualbox-issues'
|
||||
layout: docs
|
||||
page_title: Common Issues - Disks VirtualBox Provider
|
||||
sidebar_current: disks-providers-virtualbox-issues
|
||||
description: |-
|
||||
This page lists some common issues people run into with Vagrant and VirtualBox
|
||||
as well as solutions for those issues.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Disks for VirtualBox Provider'
|
||||
sidebar_current: 'disks-providers-virtualbox'
|
||||
layout: docs
|
||||
page_title: Disks for VirtualBox Provider
|
||||
sidebar_current: disks-providers-virtualbox
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for VirtualBox, a free,
|
||||
cross-platform consumer virtualization product.
|
||||
|
|
@ -9,10 +9,9 @@ description: |-
|
|||
|
||||
# VirtualBox
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
|
|
@ -24,8 +23,6 @@ Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more
|
|||
information about this flag visit the [Experimental docs page](/docs/experimental/)
|
||||
for more info. Without this flag enabled, any disks defined will not be configured.
|
||||
|
||||
</div>
|
||||
|
||||
**Vagrant currently only supports VirtualBox version 5.x and newer for configuring and
|
||||
attaching disks.**
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Usage - Disks VirtualBox Provider'
|
||||
sidebar_current: 'disks-providers-virtualbox-usage'
|
||||
layout: docs
|
||||
page_title: Usage - Disks VirtualBox Provider
|
||||
sidebar_current: disks-providers-virtualbox-usage
|
||||
description: |-
|
||||
The Vagrant VirtualBox provider is used just like any other provider. Please
|
||||
read the general basic usage page for providers.
|
||||
|
|
@ -9,10 +9,9 @@ description: |-
|
|||
|
||||
# Usage
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
|
|
@ -24,8 +23,6 @@ Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more
|
|||
information about this flag visit the [Experimental docs page](/docs/experimental/)
|
||||
for more info. Without this flag enabled, any disks defined will not be configured.
|
||||
|
||||
</div>
|
||||
|
||||
For examples of how to use the disk feature with VirtualBox, please refer to the
|
||||
[general disk usage guide](/docs/disks/usage.html) for more examples.
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Basic Usage - Docker Provider'
|
||||
sidebar_current: 'providers-docker-basics'
|
||||
layout: docs
|
||||
page_title: Basic Usage - Docker Provider
|
||||
sidebar_current: providers-docker-basics
|
||||
description: |-
|
||||
The Docker provider in Vagrant behaves just like any other provider.
|
||||
If you are familiar with Vagrant already, then using the Docker provider
|
||||
|
|
@ -102,13 +102,11 @@ can be customized to point to _any_ Vagrantfile. This allows the host VM
|
|||
to more closely match production by running a VM running Ubuntu, RHEL,
|
||||
etc. It can run any operating system supported by Vagrant.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Synced folder note:</strong> Vagrant will attempt to use the
|
||||
"best" synced folder implementation it can. For boot2docker, this is
|
||||
often rsync. In this case, make sure you have rsync installed on your
|
||||
host machine. Vagrant will give you a human-friendly error message if
|
||||
it is not.
|
||||
</div>
|
||||
-> **Synced folder note:** Vagrant will attempt to use the
|
||||
"best" synced folder implementation it can. For boot2docker, this is
|
||||
often rsync. In this case, make sure you have rsync installed on your
|
||||
host machine. Vagrant will give you a human-friendly error message if
|
||||
it is not.
|
||||
|
||||
An example of changing the host VM is shown below. Remember that this
|
||||
is optional, and Vagrant will spin up a default host VM if it is not
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Boxes - Docker Provider'
|
||||
sidebar_current: 'providers-docker-boxes'
|
||||
layout: docs
|
||||
page_title: Boxes - Docker Provider
|
||||
sidebar_current: providers-docker-boxes
|
||||
description: |-
|
||||
The Docker provider does not require a Vagrant box. The "config.vm.box"
|
||||
setting is completely optional.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Commands - Docker Provider'
|
||||
sidebar_current: 'providers-docker-commands'
|
||||
layout: docs
|
||||
page_title: Commands - Docker Provider
|
||||
sidebar_current: providers-docker-commands
|
||||
description: |-
|
||||
The Docker provider exposes some additional Vagrant commands that are
|
||||
useful for interacting with Docker containers. This helps with your
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Configuration- Docker Provider'
|
||||
sidebar_current: 'providers-docker-configuration'
|
||||
layout: docs
|
||||
page_title: Configuration- Docker Provider
|
||||
sidebar_current: providers-docker-configuration
|
||||
description: |-
|
||||
The Docker provider has some provider-specific configuration options
|
||||
you may set. A complete reference is shown on this page.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Docker Provider'
|
||||
sidebar_current: 'providers-docker'
|
||||
layout: docs
|
||||
page_title: Docker Provider
|
||||
sidebar_current: providers-docker
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for
|
||||
using Docker as a provider. This allows for your development environments
|
||||
|
|
@ -16,12 +16,10 @@ using Docker as a provider. This allows for your development environments
|
|||
to be backed by Docker containers rather than virtual machines. Additionally,
|
||||
it provides for a good workflow for developing Dockerfiles.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Docker knowledge assumed.</strong> We assume that
|
||||
you know what Docker is and that you are comfortable with the basics
|
||||
of Docker. If not, we recommend starting with another provider such
|
||||
as <a href="/docs/virtualbox/">VirtualBox</a>.
|
||||
</div>
|
||||
~> **Warning: Docker knowledge assumed.** We assume that
|
||||
you know what Docker is and that you are comfortable with the basics
|
||||
of Docker. If not, we recommend starting with another provider such
|
||||
as [VirtualBox](/docs/virtualbox).
|
||||
|
||||
Use the navigation to the left to find a specific Docker topic
|
||||
to read more about.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Networking - Docker Provider'
|
||||
sidebar_current: 'providers-docker-networking'
|
||||
layout: docs
|
||||
page_title: Networking - Docker Provider
|
||||
sidebar_current: providers-docker-networking
|
||||
description: |-
|
||||
The Vagrant Docker provider supports using the private network using the
|
||||
`docker network` commands.
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant Experimental Feature Flag'
|
||||
sidebar_current: 'experimental'
|
||||
description: |-
|
||||
Introduction to Vagrants Experimental Feature Flag
|
||||
layout: docs
|
||||
page_title: Vagrant Experimental Feature Flag
|
||||
sidebar_current: experimental
|
||||
description: Introduction to Vagrants Experimental Feature Flag
|
||||
---
|
||||
|
||||
# Experimental Feature Flag
|
||||
|
|
@ -35,11 +34,9 @@ export VAGRANT_EXPERIMENTAL="feature_one,feature_two"
|
|||
|
||||
## Valid experimental features
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Advanced topic!</strong> This is an advanced topic for use only if
|
||||
you want to use new Vagrant features. If you are just getting
|
||||
started with Vagrant, you may safely skip this section.
|
||||
</div>
|
||||
~> **Advanced topic!** This is an advanced topic for use only if
|
||||
you want to use new Vagrant features. If you are just getting
|
||||
started with Vagrant, you may safely skip this section.
|
||||
|
||||
This is a list of all the valid experimental features that Vagrant recognizes:
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Creating a Base Box - Hyper-V Provider'
|
||||
sidebar_current: 'providers-hyperv-boxes'
|
||||
layout: docs
|
||||
page_title: Creating a Base Box - Hyper-V Provider
|
||||
sidebar_current: providers-hyperv-boxes
|
||||
description: |-
|
||||
As with every Vagrant provider, the Vagrant Hyper-V provider has a custom box
|
||||
format that affects how base boxes are made.
|
||||
|
|
@ -22,13 +22,11 @@ on the box.
|
|||
Additionally, it is helpful to understand the
|
||||
[basics of the box file format](/docs/boxes/format.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Advanced topic!</strong> This is a reasonably advanced topic that
|
||||
a beginning user of Vagrant does not need to understand. If you are
|
||||
just getting started with Vagrant, skip this and use an available
|
||||
box. If you are an experienced user of Vagrant and want to create
|
||||
your own custom boxes, this is for you.
|
||||
</div>
|
||||
~> **Advanced topic!** This is a reasonably advanced topic that
|
||||
a beginning user of Vagrant does not need to understand. If you are
|
||||
just getting started with Vagrant, skip this and use an available
|
||||
box. If you are an experienced user of Vagrant and want to create
|
||||
your own custom boxes, this is for you.
|
||||
|
||||
## Additional Software
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Configuration- Hyper-V Provider'
|
||||
sidebar_current: 'providers-hyperv-configuration'
|
||||
layout: docs
|
||||
page_title: Configuration- Hyper-V Provider
|
||||
sidebar_current: providers-hyperv-configuration
|
||||
description: |-
|
||||
The Vagrant Hyper-V provider has some provider-specific configuration options
|
||||
you may set.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Hyper-V Provider'
|
||||
sidebar_current: 'providers-hyperv'
|
||||
layout: docs
|
||||
page_title: Hyper-V Provider
|
||||
sidebar_current: providers-hyperv
|
||||
description: |-
|
||||
Vagrant comes with support out of the box for Hyper-V, a native hypervisor
|
||||
written by Microsoft. Hyper-V is available by default for almost all
|
||||
|
|
@ -24,14 +24,14 @@ To enable Hyper-V, go to "Programs and Features", click on "Turn Windows
|
|||
features on or off" and check the box next to "Hyper-V". Or install via
|
||||
PowerShell with:
|
||||
|
||||
<code>Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All</code>
|
||||
```powershell
|
||||
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All
|
||||
```
|
||||
|
||||
See official documentation [here](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning:</strong> Enabling Hyper-V will cause VirtualBox, VMware,
|
||||
and any other virtualization technology to no longer work. See
|
||||
<a href="http://www.hanselman.com/blog/SwitchEasilyBetweenVirtualBoxAndHyperVWithABCDEditBootEntryInWindows81.aspx">this blog post</a>
|
||||
for an easy way to create a boot entry to boot Windows without Hyper-V
|
||||
enabled, if there will be times you will need other hypervisors.
|
||||
</div>
|
||||
~> **Warning:** Enabling Hyper-V will cause VirtualBox, VMware,
|
||||
and any other virtualization technology to no longer work. See
|
||||
[this blog post](http://www.hanselman.com/blog/SwitchEasilyBetweenVirtualBoxAndHyperVWithABCDEditBootEntryInWindows81.aspx)
|
||||
for an easy way to create a boot entry to boot Windows without Hyper-V enabled, if
|
||||
there will be times you will need other hypervisors.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Limitations - Hyper-V Provider'
|
||||
sidebar_current: 'providers-hyperv-limitations'
|
||||
layout: docs
|
||||
page_title: Limitations - Hyper-V Provider
|
||||
sidebar_current: providers-hyperv-limitations
|
||||
description: |-
|
||||
The Hyper-V provider works in almost every way like the VirtualBox
|
||||
or VMware provider would, but has some limitations that are inherent to
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Usage - Hyper-V Provider'
|
||||
sidebar_current: 'providers-hyperv-usage'
|
||||
layout: docs
|
||||
page_title: Usage - Hyper-V Provider
|
||||
sidebar_current: providers-hyperv-usage
|
||||
description: |-
|
||||
The Hyper-V provider is used just like any other provider. Please read the
|
||||
general basic usage page for providers.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
sidebar_current: 'overview'
|
||||
page_title: 'Documentation'
|
||||
layout: docs
|
||||
sidebar_current: overview
|
||||
page_title: Documentation
|
||||
description: |-
|
||||
Welcome to the documentation for Vagrant - the command line utility for
|
||||
managing the lifecycle of virtual machines. This website aims to document
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Backwards Compatibility'
|
||||
sidebar_current: 'installation-backwards-compatibility'
|
||||
description: |-
|
||||
Vagrant makes a very strict backwards-compatibility promise.
|
||||
layout: docs
|
||||
page_title: Backwards Compatibility
|
||||
sidebar_current: installation-backwards-compatibility
|
||||
description: Vagrant makes a very strict backwards-compatibility promise.
|
||||
---
|
||||
|
||||
# Backwards Compatibility
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Installing Vagrant'
|
||||
sidebar_current: 'installation'
|
||||
layout: docs
|
||||
page_title: Installing Vagrant
|
||||
sidebar_current: installation
|
||||
description: |-
|
||||
Installing Vagrant is extremely easy. Head over to the Vagrant downloads page
|
||||
and get the appropriate installer or package for your platform. Install the
|
||||
|
|
@ -20,22 +20,18 @@ so that it is available in terminals. If it is not found, please try
|
|||
logging out and logging back in to your system (this is particularly
|
||||
necessary sometimes for Windows).
|
||||
|
||||
<div class="alert alert-warning" role="alert">
|
||||
<strong>Looking for the gem install?</strong> Vagrant 1.0.x had the option to
|
||||
be installed as a <a href="https://en.wikipedia.org/wiki/RubyGems">RubyGem</a>.
|
||||
This installation method is no longer supported. If you have an old version
|
||||
of Vagrant installed via Rubygems, please remove it prior to installing newer
|
||||
versions of Vagrant.
|
||||
</div>
|
||||
~> **Looking for the gem install?** Vagrant 1.0.x had the option to
|
||||
be installed as a [RubyGem](https://en.wikipedia.org/wiki/RubyGems).
|
||||
This installation method is no longer supported. If you have an old version
|
||||
of Vagrant installed via Rubygems, please remove it prior to installing newer
|
||||
versions of Vagrant.
|
||||
|
||||
<div class="alert alert-warning" role="alert">
|
||||
<strong>Beware of system package managers!</strong> Some operating system
|
||||
distributions include a vagrant package in their upstream package repos.
|
||||
Please do not install Vagrant in this manner. Typically these packages are
|
||||
missing dependencies or include very outdated versions of Vagrant. If you
|
||||
install via your system's package manager, it is very likely that you will
|
||||
experience issues. Please use the official installers on the downloads page.
|
||||
</div>
|
||||
~> **Beware of system package managers!** Some operating system
|
||||
distributions include a vagrant package in their upstream package repos.
|
||||
Please do not install Vagrant in this manner. Typically these packages are
|
||||
missing dependencies or include very outdated versions of Vagrant. If you
|
||||
install via your system's package manager, it is very likely that you will
|
||||
experience issues. Please use the official installers on the downloads page.
|
||||
|
||||
## Running Multiple Hypervisors
|
||||
|
||||
|
|
@ -44,14 +40,16 @@ if more than one hypervisor is in use. If you are lucky, you might see the follo
|
|||
error message come up when trying to bring up a virtual machine with Vagrant and
|
||||
VirtualBox:
|
||||
|
||||
There was an error while executing `VBoxManage`, a CLI used by Vagrant for controlling VirtualBox. The command and stderr is shown below.
|
||||
```text
|
||||
There was an error while executing `VBoxManage`, a CLI used by Vagrant for controlling VirtualBox. The command and stderr is shown below.
|
||||
|
||||
Command: ["startvm", <ID of the VM>, "--type", "headless"]
|
||||
Command: ["startvm", <ID of the VM>, "--type", "headless"]
|
||||
|
||||
Stderr: VBoxManage: error: VT-x is being used by another hypervisor (VERR_VMX_IN_VMX_ROOT_MODE).
|
||||
VBoxManage: error: VirtualBox can't operate in VMX root mode. Please disable the KVM kernel extension, recompile your kernel and reboot
|
||||
(VERR_VMX_IN_VMX_ROOT_MODE)
|
||||
VBoxManage: error: Details: code NS_ERROR_FAILURE (0x80004005), component ConsoleWrap, interface IConsole
|
||||
Stderr: VBoxManage: error: VT-x is being used by another hypervisor (VERR_VMX_IN_VMX_ROOT_MODE).
|
||||
VBoxManage: error: VirtualBox can't operate in VMX root mode. Please disable the KVM kernel extension, recompile your kernel and reboot
|
||||
(VERR_VMX_IN_VMX_ROOT_MODE)
|
||||
VBoxManage: error: Details: code NS_ERROR_FAILURE (0x80004005), component ConsoleWrap, interface IConsole
|
||||
```
|
||||
|
||||
Other operating systems like Windows will blue screen if you attempt to bring up
|
||||
a VirtualBox VM with Hyper-V enabled. Below are a couple of ways to ensure you
|
||||
|
|
@ -64,16 +62,20 @@ We must blacklist these in order for VirtualBox to run correctly.
|
|||
|
||||
First find out the name of the hypervisor:
|
||||
|
||||
$ lsmod | grep kvm
|
||||
kvm_intel 204800 6
|
||||
kvm 593920 1 kvm_intel
|
||||
irqbypass 16384 1 kvm
|
||||
```shell-session
|
||||
$ lsmod | grep kvm
|
||||
kvm_intel 204800 6
|
||||
kvm 593920 1 kvm_intel
|
||||
irqbypass 16384 1 kvm
|
||||
```
|
||||
|
||||
The one we're interested in is `kvm_intel`. You might have another.
|
||||
|
||||
Blacklist the hypervisor (run the following as root):
|
||||
|
||||
# echo 'blacklist kvm-intel' >> /etc/modprobe.d/blacklist.conf
|
||||
```shell-session
|
||||
$ echo 'blacklist kvm-intel' >> /etc/modprobe.d/blacklist.conf
|
||||
```
|
||||
|
||||
Restart your machine and try running vagrant again.
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Installing Vagrant from Source'
|
||||
sidebar_current: 'installation-source'
|
||||
layout: docs
|
||||
page_title: Installing Vagrant from Source
|
||||
sidebar_current: installation-source
|
||||
description: |-
|
||||
Installing Vagrant from source is an advanced topic and is only recommended
|
||||
when using the official installer is not an option. This page details the
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Uninstalling Vagrant'
|
||||
sidebar_current: 'installation-uninstallation'
|
||||
layout: docs
|
||||
page_title: Uninstalling Vagrant
|
||||
sidebar_current: installation-uninstallation
|
||||
description: |-
|
||||
Uninstalling Vagrant is easy and straightforward. You can either uninstall
|
||||
the Vagrant binary, the user data, or both. The sections below cover how to
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Upgrading from Vagrant 1.0'
|
||||
sidebar_current: 'installation-1-0-upgrading'
|
||||
layout: docs
|
||||
page_title: Upgrading from Vagrant 1.0
|
||||
sidebar_current: installation-1-0-upgrading
|
||||
description: |-
|
||||
The upgrade process from 1.0.x to 1.x is straightforward. Vagrant is
|
||||
backwards compatible with Vagrant 1.0.x, so you can simply reinstall Vagrant
|
||||
|
|
@ -26,8 +26,6 @@ to remove them before upgrading.
|
|||
It is recommended you remove _all_ plugins before upgrading, and then slowly
|
||||
add back the plugins. This usually makes for a smoother upgrade process.
|
||||
|
||||
<div class="alert alert-warning" role="alert">
|
||||
<strong>If your version of Vagrant was installed via Rubygems</strong>, you
|
||||
must uninstall the old version prior to installing the package for the
|
||||
new version of Vagrant. The Rubygems installation is no longer supported.
|
||||
</div>
|
||||
~> **If your version of Vagrant was installed via Rubygems**, you
|
||||
must uninstall the old version prior to installing the package for the
|
||||
new version of Vagrant. The Rubygems installation is no longer supported.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Upgrading Vagrant'
|
||||
sidebar_current: 'installation-upgrading'
|
||||
layout: docs
|
||||
page_title: Upgrading Vagrant
|
||||
sidebar_current: installation-upgrading
|
||||
description: |-
|
||||
If you are upgrading from Vagrant 1.0.x, please read the specific page
|
||||
dedicated to that. This page covers upgrading Vagrant in general during the
|
||||
|
|
@ -27,9 +27,6 @@ promised until 2.0 final. So while Vagrantfiles made for 1.0.x will
|
|||
[continue to work](/docs/installation/backwards-compatibility.html),
|
||||
newer Vagrantfiles may have backwards incompatible changes until 2.0 final.
|
||||
|
||||
<div class="alert alert-info alert-block">
|
||||
<strong>Run into troubles upgrading?</strong> Please
|
||||
<a href="https://github.com/hashicorp/vagrant/issues" class="alert-link">report an issue</a>
|
||||
if you run into problems upgrading. Upgrades are meant to be a smooth
|
||||
process and we consider it a bug if it was not.
|
||||
</div>
|
||||
-> **Run into troubles upgrading?** Please [report an issue](https://github.com/hashicorp/vagrant/issues)
|
||||
if you run into problems upgrading. Upgrades are meant to be a smooth
|
||||
process and we consider it a bug if it was not.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Multi-Machine'
|
||||
sidebar_current: 'multimachine'
|
||||
layout: docs
|
||||
page_title: Multi-Machine
|
||||
sidebar_current: multimachine
|
||||
description: |-
|
||||
Vagrant is able to define and control multiple guest machines per
|
||||
Vagrantfile. This is known as a "multi-machine" environment.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Basic Usage - Networking'
|
||||
sidebar_current: 'networking-basic'
|
||||
layout: docs
|
||||
page_title: Basic Usage - Networking
|
||||
sidebar_current: networking-basic
|
||||
description: |-
|
||||
Vagrant offers multiple options for how you are able to connect your
|
||||
guest machines to the network, but there is a standard usage pattern as
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Forwarded Ports - Networking'
|
||||
sidebar_current: 'networking-fp'
|
||||
layout: docs
|
||||
page_title: Forwarded Ports - Networking
|
||||
sidebar_current: networking-fp
|
||||
description: |-
|
||||
Vagrant 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
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Networking'
|
||||
sidebar_current: 'networking'
|
||||
layout: docs
|
||||
page_title: Networking
|
||||
sidebar_current: networking
|
||||
description: |-
|
||||
In order to access the Vagrant environment created, Vagrant exposes
|
||||
some high-level networking options for things such as forwarded ports,
|
||||
|
|
@ -33,10 +33,8 @@ providers expose [provider-specific configuration](/docs/providers/configuration
|
|||
to do this, so please read the documentation for your specific provider
|
||||
to see what options are available.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>For beginners:</strong> It is strongly recommended you use
|
||||
only the high-level networking options until you are comfortable
|
||||
with the Vagrant workflow and have things working at a basic level.
|
||||
Provider-specific network configuration can very quickly lock you out
|
||||
of your guest machine if improperly done.
|
||||
</div>
|
||||
-> **For beginners:** It is strongly recommended you use
|
||||
only the high-level networking options until you are comfortable
|
||||
with the Vagrant workflow and have things working at a basic level.
|
||||
Provider-specific network configuration can very quickly lock you out
|
||||
of your guest machine if improperly done.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Private Networks - Networking'
|
||||
sidebar_current: 'networking-private'
|
||||
layout: docs
|
||||
page_title: Private Networks - Networking
|
||||
sidebar_current: networking-private
|
||||
description: |-
|
||||
Vagrant private networks allow you to access your guest machine by some
|
||||
address that is not publicly accessible from the global internet. In general,
|
||||
|
|
@ -20,15 +20,12 @@ Multiple machines within the same private network (also usually with the
|
|||
restriction that they're backed by the same [provider](/docs/providers/))
|
||||
can communicate with each other on private networks.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Guest operating system support.</strong> Private networks
|
||||
generally require configuring the network adapters on the guest
|
||||
machine. This process varies from OS to OS. Vagrant ships with
|
||||
knowledge of how to configure networks on a variety of guest
|
||||
operating systems, but it is possible if you are using a particularly
|
||||
old or new operating system that private networks will not properly
|
||||
configure.
|
||||
</div>
|
||||
-> **Guest operating system support.** Private networks generally
|
||||
require configuring the network adapters on the guest machine. This process
|
||||
varies from OS to OS. Vagrant ships with knowledge of how to configure
|
||||
networks on a variety of guest operating systems, but it is possible if you
|
||||
are using a particularly old or new operating system that private networks
|
||||
will not properly configure.
|
||||
|
||||
## DHCP
|
||||
|
||||
|
|
@ -69,11 +66,9 @@ outside world.
|
|||
For some operating systems, additional configuration options for the static
|
||||
IP address are available such as setting the default gateway or MTU.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> Do not choose an IP that overlaps with any
|
||||
other IP space on your system. This can cause the network to not be
|
||||
reachable.
|
||||
</div>
|
||||
~> **Warning!** Do not choose an IP that overlaps with any
|
||||
other IP space on your system. This can cause the network to not be
|
||||
reachable.
|
||||
|
||||
## IPv6
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Public Networks - Networking'
|
||||
sidebar_current: 'networking-public'
|
||||
layout: docs
|
||||
page_title: Public Networks - Networking
|
||||
sidebar_current: networking-public
|
||||
description: |-
|
||||
Vagrant public networks are less private than private networks, and the exact
|
||||
meaning actually varies from provider to provider, hence the ambiguous
|
||||
|
|
@ -19,24 +19,19 @@ hence the ambiguous definition. The idea is that while
|
|||
[private networks](/docs/networking/private_network.html) should never allow the
|
||||
general public access to your machine, public networks can.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Confused?</strong> We kind of are, too. It is likely that
|
||||
public networks will be replaced by <code>:bridged</code> in a
|
||||
future release, since that is in general what should be done with
|
||||
public networks, and providers that do not support bridging generally
|
||||
do not have any other features that map to public networks either.
|
||||
</div>
|
||||
-> **Confused?** We kind of are, too. It is likely that public
|
||||
networks will be replaced by `:bridged` in a future release, since
|
||||
that is in general what should be done with public networks, and providers
|
||||
that do not support bridging generally do not have any other features that map
|
||||
to public networks either.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> Vagrant boxes are insecure by default
|
||||
and by design, featuring public passwords, insecure keypairs
|
||||
for SSH access, and potentially allow root access over SSH. With
|
||||
these known credentials, your box is easily accessible by anyone on
|
||||
your network. Before configuring Vagrant to use a public network,
|
||||
consider <em>all</em> potential security implications
|
||||
and review the <a href="/docs/boxes/base.html">default box
|
||||
configuration</a> to identify potential security risks.
|
||||
</div>
|
||||
~> **Warning!** Vagrant boxes are insecure by default
|
||||
and by design, featuring public passwords, insecure keypairs
|
||||
for SSH access, and potentially allow root access over SSH. With
|
||||
these known credentials, your box is easily accessible by anyone on
|
||||
your network. Before configuring Vagrant to use a public network,
|
||||
consider _all_ potential security implications
|
||||
and review the [default box configuration](/docs/boxes/base.html) to identify potential security risks.
|
||||
|
||||
## DHCP
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Debugging and Troubleshooting'
|
||||
sidebar_current: 'other-debugging'
|
||||
layout: docs
|
||||
page_title: Debugging and Troubleshooting
|
||||
sidebar_current: other-debugging
|
||||
description: |-
|
||||
As much as we try to keep Vagrant stable and bug free, it is inevitable
|
||||
that issues will arise and Vagrant will behave in unexpected ways. In
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Environmental Variables'
|
||||
sidebar_current: 'other-envvars'
|
||||
layout: docs
|
||||
page_title: Environmental Variables
|
||||
sidebar_current: other-envvars
|
||||
description: |-
|
||||
Vagrant has a set of environmental variables that can be used to
|
||||
configure and control it in a global way. This page lists those environmental
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Other'
|
||||
sidebar_current: 'other'
|
||||
layout: docs
|
||||
page_title: Other
|
||||
sidebar_current: other
|
||||
description: |-
|
||||
This page covers Vagrant information that does not quite fit under the other
|
||||
categories.
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant and macOS Catalina'
|
||||
sidebar_current: 'other-macos-catalina'
|
||||
description: |-
|
||||
An overview of using Vagrant on macOS Catalina.
|
||||
layout: docs
|
||||
page_title: Vagrant and macOS Catalina
|
||||
sidebar_current: other-macos-catalina
|
||||
description: An overview of using Vagrant on macOS Catalina.
|
||||
---
|
||||
|
||||
# Vagrant and macOS Catalina
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Vagrant and Windows Subsystem for Linux'
|
||||
sidebar_current: 'other-wsl'
|
||||
layout: docs
|
||||
page_title: Vagrant and Windows Subsystem for Linux
|
||||
sidebar_current: other-wsl
|
||||
description: |-
|
||||
An overview of using Vagrant on Windows within the Windows Subsystem
|
||||
for Linux.
|
||||
|
|
@ -14,11 +14,9 @@ an optional Windows feature. The WSL supports running a Linux environment
|
|||
within Windows. Vagrant support for WSL is still in development and should
|
||||
be considered _beta_.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Using Vagrant within the Windows
|
||||
Subsystem for Linux is an advanced topic that only experienced Vagrant users
|
||||
who are reasonably comfortable with Windows, WSL, and Linux should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Using Vagrant within the Windows
|
||||
Subsystem for Linux is an advanced topic that only experienced Vagrant users
|
||||
who are reasonably comfortable with Windows, WSL, and Linux should approach.
|
||||
|
||||
## Vagrant Installation
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Plugin Development Basics - Action Hooks'
|
||||
sidebar_current: 'plugins-action-hooks'
|
||||
layout: docs
|
||||
page_title: Plugin Development Basics - Action Hooks
|
||||
sidebar_current: plugins-action-hooks
|
||||
description: |-
|
||||
Action hooks provide ways to interact with Vagrant at a very low level by
|
||||
injecting middleware in various phases of Vagrant's lifecycle. This is an
|
||||
|
|
@ -14,11 +14,9 @@ Action hooks provide ways to interact with Vagrant at a very low level by
|
|||
injecting middleware in various phases of Vagrant's lifecycle. This is an
|
||||
advanced option, even for plugin development.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Public Action Hooks
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Command Plugins - Plugin Development'
|
||||
sidebar_current: 'plugins-commands'
|
||||
layout: docs
|
||||
page_title: Command Plugins - Plugin Development
|
||||
sidebar_current: plugins-commands
|
||||
description: |-
|
||||
This page documents how to add new commands to Vagrant, invocable
|
||||
via "vagrant YOUR-COMMAND". Prior to reading this, you should be familiar
|
||||
|
|
@ -14,11 +14,9 @@ This page documents how to add new commands to Vagrant, invocable
|
|||
via `vagrant YOUR-COMMAND`. Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Definition Component
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Custom Configuration - Plugin Development'
|
||||
sidebar_current: 'plugins-configuration'
|
||||
layout: docs
|
||||
page_title: Custom Configuration - Plugin Development
|
||||
sidebar_current: plugins-configuration
|
||||
description: |-
|
||||
This page documents how to add new configuration options to Vagrant,
|
||||
settable with "config.YOURKEY" in Vagrantfiles. Prior to reading this,
|
||||
|
|
@ -15,11 +15,9 @@ settable with `config.YOURKEY` in Vagrantfiles. Prior to reading this,
|
|||
you should be familiar with the
|
||||
[plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Definition Component
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Plugin Development Basics - Plugins'
|
||||
sidebar_current: 'plugins-development-basics'
|
||||
layout: docs
|
||||
page_title: Plugin Development Basics - Plugins
|
||||
sidebar_current: plugins-development-basics
|
||||
description: |-
|
||||
Plugins are a great way to augment or change the behavior and functionality
|
||||
of Vagrant. Since plugins introduce additional external dependencies for
|
||||
|
|
@ -20,11 +20,9 @@ But if you need to introduce custom behaviors
|
|||
into Vagrant, plugins are the best way, since they are safe against future
|
||||
upgrades and use a stable API.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
Plugins are written using [Ruby](https://www.ruby-lang.org/en/) and are packaged
|
||||
using [RubyGems](https://rubygems.org/). Familiarity with Ruby is required,
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Guest Capabilities - Plugin Development'
|
||||
sidebar_current: 'plugins-guestcapabilities'
|
||||
layout: docs
|
||||
page_title: Guest Capabilities - Plugin Development
|
||||
sidebar_current: plugins-guestcapabilities
|
||||
description: |-
|
||||
This page documents how to add new capabilities for guests to Vagrant,
|
||||
allowing Vagrant to perform new actions on specific guest operating systems.
|
||||
|
|
@ -17,11 +17,9 @@ operating systems.
|
|||
Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
Guest capabilities augment [guests](/docs/plugins/guests.html) by attaching
|
||||
specific "capabilities" to the guest, which are actions that can be performed
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Custom Guests - Plugin Development'
|
||||
sidebar_current: 'plugins-guests'
|
||||
layout: docs
|
||||
page_title: Custom Guests - Plugin Development
|
||||
sidebar_current: plugins-guests
|
||||
description: |-
|
||||
This page documents how to add new guest OS detection to Vagrant, allowing
|
||||
Vagrant to properly configure new operating systems. Prior to reading this,
|
||||
|
|
@ -15,11 +15,9 @@ Vagrant to properly configure new operating systems.
|
|||
Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
Vagrant has many features that requires doing guest OS-specific
|
||||
actions, such as mounting folders, configuring networks, etc. These
|
||||
|
|
@ -1,9 +1,11 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Host Capabilities - Plugin Development'
|
||||
sidebar_current: 'plugins-hostcapabilities'
|
||||
description: |-
|
||||
This page documents how to add new capabilities for hosts to Vagrant, allowing Vagrant to perform new actions on specific host operating systems. Prior to reading this, you should be familiar with the plugin development basics.
|
||||
layout: docs
|
||||
page_title: Host Capabilities - Plugin Development
|
||||
sidebar_current: plugins-hostcapabilities
|
||||
description: >-
|
||||
This page documents how to add new capabilities for hosts to Vagrant, allowing
|
||||
Vagrant to perform new actions on specific host operating systems. Prior to
|
||||
reading this, you should be familiar with the plugin development basics.
|
||||
---
|
||||
|
||||
# Plugin Development: Host Capabilities
|
||||
|
|
@ -14,11 +16,9 @@ operating systems.
|
|||
Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
Host capabilities augment [hosts](/docs/plugins/hosts.html) by attaching
|
||||
specific "capabilities" to the host, which are actions that can be performed
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Custom Hosts - Plugin Development'
|
||||
sidebar_current: 'plugins-hosts'
|
||||
layout: docs
|
||||
page_title: Custom Hosts - Plugin Development
|
||||
sidebar_current: plugins-hosts
|
||||
description: |-
|
||||
This page documents how to add new host OS detection to Vagrant, allowing
|
||||
Vagrant to properly execute host-specific operations on new operating systems.
|
||||
|
|
@ -16,11 +16,9 @@ Vagrant to properly execute host-specific operations on new operating systems.
|
|||
Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
Vagrant has some features that require host OS-specific actions, such as
|
||||
exporting NFS folders. These tasks vary from operating system to operating
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Plugins'
|
||||
sidebar_current: 'plugins'
|
||||
layout: docs
|
||||
page_title: Plugins
|
||||
sidebar_current: plugins
|
||||
description: |-
|
||||
Vagrant comes with many great features out of the box to get your environments
|
||||
up and running. Sometimes, however, you want to change the way Vagrant does
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Packaging and Distribution - Plugin Development'
|
||||
sidebar_current: 'plugins-packaging'
|
||||
layout: docs
|
||||
page_title: Packaging and Distribution - Plugin Development
|
||||
sidebar_current: plugins-packaging
|
||||
description: |-
|
||||
This page documents how to organize the file structure of your plugin
|
||||
and distribute it so that it is installable using standard installation
|
||||
|
|
@ -17,11 +17,9 @@ and distribute it so that it is installable using
|
|||
Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Example Plugin
|
||||
|
||||
|
|
@ -47,13 +45,9 @@ You should modify the `vagrant-my-plugin.gemspec` file to add any
|
|||
dependencies and change any metadata. View the [vagrant-aws.gemspec](https://github.com/mitchellh/vagrant-aws/blob/master/vagrant-aws.gemspec)
|
||||
for a good example.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<p>
|
||||
<strong>Do not depend on Vagrant</strong> for your gem. Vagrant
|
||||
is no longer distributed as a gem, and you can assume that it will
|
||||
always be available when your plugin is installed.
|
||||
</p>
|
||||
</div>
|
||||
~> **Do not depend on Vagrant** for your gem. Vagrant is no longer distributed
|
||||
as a gem, and you can assume that it will always be available when your plugin is
|
||||
installed.
|
||||
|
||||
Once the directory structure for a RubyGem is setup, you will want
|
||||
to modify your Gemfile. Here is the basic structure of a Gemfile for
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Custom Providers - Plugin Development'
|
||||
sidebar_current: 'plugins-providers'
|
||||
layout: docs
|
||||
page_title: Custom Providers - Plugin Development
|
||||
sidebar_current: plugins-providers
|
||||
description: |-
|
||||
This page documents how to add support for new providers to Vagrant, allowing
|
||||
Vagrant to run and manage machines powered by a system other than VirtualBox.
|
||||
|
|
@ -20,11 +20,9 @@ Prior to developing a provider you should also be familiar with how
|
|||
[providers work](/docs/providers/) from
|
||||
a user standpoint.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Example Provider: AWS
|
||||
|
||||
|
|
@ -108,8 +106,6 @@ a `vagrant box list` you can see what boxes for what providers are installed.
|
|||
You do _not need_ the provider plugin installed to add a box for that
|
||||
provider.
|
||||
|
||||
<a name="actions"></a>
|
||||
|
||||
## Actions
|
||||
|
||||
Probably the most important concept to understand when building a
|
||||
|
|
@ -204,14 +200,11 @@ The provider-specific configuration is available on the machine object
|
|||
via the `provider_config` attribute. So within actions or your provider class,
|
||||
you can access the config via `machine.provider_config`.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Best practice:</strong> Your provider should <em>not require</em>
|
||||
provider-specific configuration to function, if possible. Vagrant
|
||||
practices a strong <a href="https://en.wikipedia.org/wiki/Convention_over_configuration">convention over configuration</a>
|
||||
philosophy. When a user installs your provider, they should ideally
|
||||
be able to <code>vagrant up --provider=your_provider</code> and
|
||||
have it just work.
|
||||
</div>
|
||||
-> **Best practice:** Your provider should _not require_
|
||||
provider-specific configuration to function, if possible. Vagrant practices a
|
||||
strong [convention over configuration](https://en.wikipedia.org/wiki/Convention_over_configuration)
|
||||
philosophy. When a user installs your provider, they should ideally be able to
|
||||
`vagrant up --provider=your_provider` and have it just work.
|
||||
|
||||
## Parallelization
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Custom Provisioners - Plugin Development'
|
||||
sidebar_current: 'plugins-provisioners'
|
||||
layout: docs
|
||||
page_title: Custom Provisioners - Plugin Development
|
||||
sidebar_current: plugins-provisioners
|
||||
script: |-
|
||||
This page documents how to add new provisioners to Vagrant, allowing Vagrant
|
||||
to automatically install software and configure software using a custom
|
||||
|
|
@ -16,11 +16,9 @@ allowing Vagrant to automatically install software and configure software
|
|||
using a custom provisioner. Prior to reading this, you should be familiar
|
||||
with the [plugin development basics](/docs/plugins/development-basics.html).
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning: Advanced Topic!</strong> Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
</div>
|
||||
~> **Warning: Advanced Topic!** Developing plugins is an
|
||||
advanced topic that only experienced Vagrant users who are reasonably
|
||||
comfortable with Ruby should approach.
|
||||
|
||||
## Definition Component
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Plugin Usage - Plugins'
|
||||
sidebar_current: 'plugins-usage'
|
||||
layout: docs
|
||||
page_title: Plugin Usage - Plugins
|
||||
sidebar_current: plugins-usage
|
||||
description: |-
|
||||
Installing a Vagrant plugin is easy, and should not take more than a few
|
||||
seconds.
|
||||
|
|
@ -15,10 +15,8 @@ Please refer to the documentation of any plugin you plan on using for
|
|||
more information on how to use it, but there is one common method for
|
||||
installation and plugin activation.
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> 3rd party plugins can introduce instabilities
|
||||
into Vagrant due to the nature of them being written by non-core users.
|
||||
</div>
|
||||
~> **Warning!** 3rd party plugins can introduce instabilities
|
||||
into Vagrant due to the nature of them being written by non-core users.
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Basic Usage - Providers'
|
||||
sidebar_current: 'providers-basic-usage'
|
||||
layout: docs
|
||||
page_title: Basic Usage - Providers
|
||||
sidebar_current: providers-basic-usage
|
||||
description: |-
|
||||
Vagrant boxes are all provider-specific. A box for VirtualBox is incompatible
|
||||
with the VMware Fusion provider, or any other provider. A box must be
|
||||
|
|
@ -55,14 +55,12 @@ If you specified a `--provider` flag, you only need to do this for the
|
|||
see what provider is backing a running machine, so commands such as
|
||||
`destroy`, `suspend`, etc. do not need to be told what provider to use.
|
||||
|
||||
<div class="alert alert-info">
|
||||
Vagrant currently restricts you to bringing up one provider per machine.
|
||||
If you have a multi-machine environment, you can bring up one machine
|
||||
backed by VirtualBox and another backed by VMware Fusion, for example, but you
|
||||
cannot back the <em>same machine</em> with both VirtualBox and
|
||||
VMware Fusion. This is a limitation that will be removed in a future
|
||||
version of Vagrant.
|
||||
</div>
|
||||
-> Vagrant currently restricts you to bringing up one provider per machine.
|
||||
If you have a multi-machine environment, you can bring up one machine
|
||||
backed by VirtualBox and another backed by VMware Fusion, for example, but you
|
||||
cannot back the <em>same machine</em> with both VirtualBox and
|
||||
VMware Fusion. This is a limitation that will be removed in a future
|
||||
version of Vagrant.
|
||||
|
||||
## Default Provider
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: 'docs'
|
||||
page_title: 'Configuration - Providers'
|
||||
sidebar_current: 'providers-configuration'
|
||||
layout: docs
|
||||
page_title: Configuration - Providers
|
||||
sidebar_current: providers-configuration
|
||||
description: |-
|
||||
While well-behaved Vagrant providers should work with any Vagrantfile with
|
||||
sane defaults, providers generally expose unique configuration options so that
|
||||
|
|
@ -82,10 +82,8 @@ end
|
|||
In the above case, Vagrant will use the "bionic64" box by default, but
|
||||
will use "bionic64_fusion" if the VMware Fusion provider is used.
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>The Vagrant Way:</strong> The proper "Vagrant way" is to
|
||||
avoid any provider-specific overrides if possible by making boxes
|
||||
for multiple providers that are as identical as possible, since box
|
||||
names can map to multiple providers. However, this is not always possible,
|
||||
and in those cases, overrides are available.
|
||||
</div>
|
||||
-> **The Vagrant Way:** The proper "Vagrant way" is to
|
||||
avoid any provider-specific overrides if possible by making boxes
|
||||
for multiple providers that are as identical as possible, since box
|
||||
names can map to multiple providers. However, this is not always possible,
|
||||
and in those cases, overrides are available.
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue