doc: Move vagrant documentation to main doc/ page
This makes it easier to find from the main landing page. Change-Id: Ic142427cede869c9cbfc6c265c8e4625731f8ce1 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/376232 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
This commit is contained in:
parent
735f7a5cbc
commit
de191b8fb1
@ -123,8 +123,8 @@ with the [VirtualBox](https://www.virtualbox.org/wiki/Downloads) provider. The
|
||||
[VirtualBox Extension Pack](https://www.virtualbox.org/wiki/Downloads) must
|
||||
also be installed in order to get the required NVMe support.
|
||||
|
||||
Details on the Vagrant setup can be found in
|
||||
[scripts/vagrant/README.md](scripts/vagrant/README.md).
|
||||
Details on the Vagrant setup can be found in the
|
||||
[SPDK Vagrant documentation](http://spdk.io/doc/vagrant.html).
|
||||
|
||||
<a id="advanced"></a>
|
||||
## Advanced Build Options
|
||||
|
@ -796,6 +796,7 @@ INPUT = ../include/spdk \
|
||||
nvme.md \
|
||||
nvme-cli.md \
|
||||
nvmf.md \
|
||||
vagrant.md \
|
||||
vhost.md
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
|
@ -2,6 +2,7 @@
|
||||
|
||||
# Introduction {#intro}
|
||||
- @ref getting_started
|
||||
- @ref vagrant
|
||||
- @ref changelog
|
||||
- [Source Code (GitHub)](https://github.com/spdk/spdk/)
|
||||
|
||||
|
@ -1,20 +1,21 @@
|
||||
Introduction
|
||||
============
|
||||
# Vagrant Development Environment {#vagrant}
|
||||
|
||||
The idea behind our use of vagrant is to provide a quick way to get a basic
|
||||
NVMe enabled sandbox going without the need for any special hardware.
|
||||
# Introduction {#vagrant_intro}
|
||||
|
||||
[Vagrant](https://www.vagrantup.com/) provides a quick way to get a basic
|
||||
NVMe enabled virtual machine sandbox running without the need for any
|
||||
special hardware.
|
||||
The vagrant environment for SPDK has support for Ubuntu 16.04 and
|
||||
Centos 7.2. This environment requires vagrant 1.9.4 or newer and
|
||||
VirtualBox 5.1 or newer with the matching VirtualBox extension pack.
|
||||
|
||||
The VM builds SPDK and DPDK from source which can be located at /spdk.
|
||||
The VM builds SPDK and DPDK from source which are located at /spdk.
|
||||
|
||||
Note: If you are behind a corporate firewall, set http_proxy and https_proxy in
|
||||
your environment before trying to start up the VM. Also make sure that you
|
||||
have installed the optional vagrant module 'vagrant-proxyconf'.
|
||||
|
||||
VM Configuration
|
||||
================
|
||||
# VM Configuration {#vagrant_config}
|
||||
|
||||
This vagrant environment creates a VM based on environment variables found in ./env.sh
|
||||
To use, edit env.sh then
|
||||
@ -46,13 +47,11 @@ By default, the VM created is/has:
|
||||
- 4G of RAM
|
||||
- 2 NICs (1 x NAT - host access, 1 x private network)
|
||||
|
||||
Providers
|
||||
=========
|
||||
# Providers {#vagrant_providers}
|
||||
|
||||
Currently only the Virtualbox provider is supported.
|
||||
|
||||
Hello World
|
||||
===========
|
||||
# Running An Example {#vagrant_example}
|
||||
|
||||
The following shows sample output from starting up a VM and running
|
||||
the NVMe sample application "hello world". If you don't see the
|
Loading…
Reference in New Issue
Block a user