vagrant-packet 0.1.2 → 0.1.3

data/vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/website/source/docs/provisioning/docker.html.md

@@ -1,208 +0,0 @@
----
-layout: "docs"
-page_title: "Docker - Provisioning"
-sidebar_current: "provisioning-docker"
-description: |-
-  The Vagrant Docker provisioner can automatically install Docker, pull Docker
-  containers, and configure certain containers to run on boot.
----
-
-# Docker Provisioner
-
-**Provisioner name: `"docker"`**
-
-The Vagrant Docker provisioner can automatically install
-[Docker](https://www.docker.io), pull Docker containers, and configure certain
-containers to run on boot.
-
-The docker provisioner is ideal for organizations that are using
-Docker as a means to distribute things like their application or services.
-Or, if you are just getting started with Docker, the Docker provisioner
-provides the easiest possible way to begin using Docker since the provisioner
-automates installing Docker for you.
-
-As with all provisioners, the Docker provisioner can be used along with
-all the other provisioners Vagrant has in order to setup your working
-environment the best way possible. For example, perhaps you use Puppet to
-install services like databases or web servers but use Docker to house
-your application runtime. You can use the Puppet provisioner along
-with the Docker provisioner.
-
-<div class="alert alert-info">
-  <strong>Note:</strong> This documentation is for the Docker
-      <em>provisioner</em>. If you are looking for the Docker
-  <em>provider</em>, visit the
-  <a href="/docs/docker/">Docker provider documentation</a>.
-</div>
-
-## Options
-
-The docker provisioner takes various options. None are required. If
-no options are required, the Docker provisioner will only install Docker
-for you (if it is not already installed).
-
-* `images` (array) - A list of images to pull using `docker pull`. You
-  can also use the `pull_images` function. See the example below this
-  section for more information.
-
-In addition to the options that can be set, various functions are available
-and can be called to configure other aspects of the Docker provisioner. Most
-of these functions have examples in more detailed sections below.
-
-* `build_image` - Build an image from a Dockerfile.
-
-* `pull_images` - Pull the given images. This does not start these images.
-
-* `post_install_provisioner` - A [provisioner block](/docs/provisioning) that runs post docker
-   installation.
-
-* `run` - Run a container and configure it to start on boot. This can
-  only be specified once.
-
-## Building Images
-
-The provisioner can automatically build images. Images are built prior to
-any configured containers to run, so you can build an image before running it.
-Building an image is easy:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.build_image "/vagrant/app"
-  end
-end
-```
-
-The argument to build an image is the path to give to `docker build`. This
-must be a path that exists within the guest machine. If you need to get data
-to the guest machine, use a synced folder.
-
-The `build_image` function accepts options as a second parameter. Here
-are the available options:
-
-* `args` (string) - Additional arguments to pass to `docker build`. Use this
-  to pass in things like `-t "foo"` to tag the image.
-
-## Pulling Images
-
-The docker provisioner can automatically pull images from the
-Docker registry for you. There are two ways to specify images to
-pull. The first is as an array using `images`:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker",
-    images: ["ubuntu"]
-end
-```
-
-This will cause Vagrant to pull the "ubuntu" image from the registry
-for you automatically.
-
-The second way to pull images is to use the `pull_images` function.
-Each call to `pull_images` will _append_ the images to be pulled. The
-`images` variable, on the other hand, can only be used once.
-
-Additionally, the `pull_images` function cannot be used with the
-simple configuration method for provisioners (specifying it all in one line).
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.pull_images "ubuntu"
-    d.pull_images "vagrant"
-  end
-end
-```
-
-## Running Containers
-
-In addition to pulling images, the Docker provisioner can run and start
-containers for you. This lets you automatically start services as part of
-`vagrant up`.
-
-Running containers can only be configured using the Ruby block syntax with
-the `do...end` blocks. An example of running a container is shown below:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.run "rabbitmq"
-  end
-end
-```
-
-This will `docker run` a container with the "rabbitmq" image. Note that
-Vagrant uses the first parameter (the image name by default) to override any
-settings used in a previous `run` definition. Therefore, if you need to run
-multiple containers from the same image then you must specify the `image`
-option (documented below) with a unique name.
-
-In addition to the name, the `run` method accepts a set of options, all optional:
-
-* `image` (string) - The image to run. This defaults to the first argument
-  but can also be given here as an option.
-
-* `cmd` (string) - The command to start within the container. If not specified,
-  then the container's default command will be used, such as the
-  "CMD" command [specified in the `Dockerfile`](https:/docs.docker.io/en/latest/use/builder/#cmd).
-
-* `args` (string) - Extra arguments for [`docker run`](https:/docs.docker.io/en/latest/commandline/cli/#run)
-  on the command line. These are raw arguments that are passed directly to Docker.
-
-* `auto_assign_name` (boolean) - If true, the `--name` of the container will
-  be set to the first argument of the run. By default this is true. If the
-  name set contains a "/" (because of the image name), it will be replaced
-  with "-". Therefore, if you do `d.run "foo/bar"`, then the name of the
-  container will be "foo-bar".
-
-* `daemonize` (boolean) - If true, the "-d" flag is given to `docker run` to
-  daemonize the containers. By default this is true.
-
-* `restart` (string) - The restart policy for the container. Defaults to
-  "always"
-
-For example, here is how you would configure Docker to run a container
-with the Vagrant shared directory mounted inside of it:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.run "ubuntu",
-      cmd: "bash -l",
-      args: "-v '/vagrant:/var/www'"
-  end
-end
-```
-
-In case you need to run multiple containers based off the same image, you can do
-so by providing different names and specifying the `image` parameter to it:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.run "db-1", image: "user/mysql"
-    d.run "db-2", image: "user/mysql"
-  end
-end
-```
-
-## Other
-
-This section documents some other things related to the Docker provisioner
-that are generally useful to know if you are using this provisioner.
-
-### Customize `/etc/default/docker`
-
-To customize this file, use the `post_install_provisioner` shell provisioner.
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "docker" do |d|
-    d.post_install_provision "shell", inline:"echo export http_proxy='http://127.0.0.1:3128/' >> /etc/default/docker"
-    d.run "ubuntu",
-      cmd: "bash -l",
-      args: "-v '/vagrant:/var/www'"
-  end
-end
-```

data/vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/website/source/docs/provisioning/file.html.md

@@ -1,120 +0,0 @@
----
-layout: "docs"
-page_title: "File Uploads - Provisioning"
-sidebar_current: "provisioning-file"
-description: |-
-  The Vagrant file provisioner allows you to upload a file or directory from the
-  host machine to the guest machine.
----
-
-# File Provisioner
-
-**Provisioner name: `"file"`**
-
-The Vagrant file provisioner allows you to upload a file or directory from the
-host machine to the guest machine.
-
-File provisioning is a simple way to, for example, replicate your local
-~/.gitconfig to the vagrant user's home directory on the guest machine so
-you will not have to run `git config --global` every time you provision a
-new VM.
-
-    Vagrant.configure("2") do |config|
-      # ... other configuration
-
-      config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig"
-    end
-
-If you want to upload a folder to your guest system, it can be accomplished by
-using a file provisioner seen below. When copied, the resulting folder on the guest will
-replace `folder` as `newfolder` and place its on the guest machine. Note that if
-you'd like the same folder name on your guest machine, make sure that the destination
-path has the same name as the folder on your host.
-
-    Vagrant.configure("2") do |config|
-      # ... other configuration
-
-      config.vm.provision "file", source: "~/path/to/host/folder", destination: "$HOME/remote/newfolder"
-    end
-
-Prior to copying `~/path/to/host/folder` to the guest machine:
-
-        folder
-        ├── script.sh
-        ├── otherfolder
-        │   └── hello.sh
-        ├── goodbye.sh
-        ├── hello.sh
-        └── woot.sh
-
-        1 directory, 5 files
-
-After to copying `~/path/to/host/folder` into `$HOME/remote/newfolder` to the guest machine:
-
-        newfolder
-        ├── script.sh
-        ├── otherfolder
-        │   └── hello.sh
-        ├── goodbye.sh
-        ├── hello.sh
-        └── woot.sh
-
-        1 directory, 5 files
-
-Note that, unlike with synced folders, files or directories that are uploaded
-will not be kept in sync. Continuing with the example above, if you make
-further changes to your local ~/.gitconfig, they will not be immediately
-reflected in the copy you uploaded to the guest machine.
-
-The file uploads by the file provisioner are done as the
-_SSH or PowerShell user_. This is important since these users generally
-do not have elevated privileges on their own. If you want to upload files to
-locations that require elevated privileges, we recommend uploading them
-to temporary locations and then using the
-[shell provisioner](/docs/provisioning/shell.html)
-to move them into place.
-
-## Options
-
-The file provisioner takes only two options, both of which are required:
-
-* `source` (string) - Is the local path of the file or directory to be
-  uploaded.
-
-* `destination` (string) - Is the remote path on the guest machine where
-  the source will be uploaded to. The file/folder is uploaded as the SSH user
-  over SCP, so this location must be writable to that user. The SSH user can be
-  determined by running `vagrant ssh-config`, and defaults to "vagrant".
-
-## Caveats
-
-While the file provisioner does support trailing slashes or "globing", this can
-lead to some confusing results due to the underlying tool used to copy files and
-folders between the host and guests. For example, if you have a source and
-destination with a trailing slash defined below:
-
-      config.vm.provision "file", source: "~/pathfolder", destination: "/remote/newlocation/"
-
-You are telling vagrant to upload `~/pathfolder` under the remote dir `/remote/newlocation`,
-which will look like:
-
-        newlocation
-        ├── pathfolder
-        │   └── file.sh
-
-        1 directory, 2 files
-
-This behavior can also be achieved by defining your file provisioner below:
-
-      config.vm.provision "file", source: "~/pathfolder", destination: "/remote/newlocation/pathfolder"
-
-Another example is using globing on the host machine to grab all files within a
-folder, but not the top level folder itself:
-
-      config.vm.provision "file", source: "~/otherfolder/.", destination: "/remote/otherlocation"
-
-The file provisioner is defined to include all files under `~/otherfolder`
-to the new location `/remote/otherlocation`. This idea can be achieved by simply
-having your destination folder differ from the source folder:
-
-      config.vm.provision "file", source: "/otherfolder", destination: "/remote/otherlocation"

data/vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/website/source/docs/provisioning/index.html.md

@@ -1,49 +0,0 @@
----
-layout: "docs"
-page_title: "Provisioning"
-sidebar_current: "provisioning"
-description: |-
-  Provisioners in Vagrant allow you to automatically install software, alter configurations, and more on the machine as part of the `vagrant up` process.
----
-
-# Provisioning
-
-Provisioners in Vagrant allow you to automatically install software, alter configurations,
-and more on the machine as part of the `vagrant up` process.
-
-This is useful since [boxes](/docs/boxes.html) typically are not
-built _perfectly_ for your use case. Of course, if you want to just use
-`vagrant ssh` and install the software by hand, that works. But by using
-the provisioning systems built-in to Vagrant, it automates the process so
-that it is repeatable. Most importantly, it requires no human interaction,
-so you can `vagrant destroy` and `vagrant up` and have a fully ready-to-go
-work environment with a single command. Powerful.
-
-Vagrant gives you multiple options for provisioning the machine, from
-simple shell scripts to more complex, industry-standard configuration
-management systems.
-
-If you've never used a configuration management system before, it is
-recommended you start with basic [shell scripts](/docs/provisioning/shell.html)
-for provisioning.
-
-You can find the full list of built-in provisioners and usage of these
-provisioners in the navigational area to the left.
-
-## When Provisioning Happens
-
-Provisioning happens at certain points during the lifetime of your
-Vagrant environment:
-
-* On the first `vagrant up` that creates the environment, provisioning is run.
-  If the environment was already created and the up is just resuming a machine
-  or booting it up, they will not run unless the `--provision` flag is explicitly
-  provided.
-
-* When `vagrant provision` is used on a running environment.
-
-* When `vagrant reload --provision` is called. The `--provision` flag must
-  be present to force provisioning.
-
-You can also bring up your environment and explicitly _not_ run provisioners
-by specifying `--no-provision`.

data/vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/website/source/docs/provisioning/puppet_agent.html.md

@@ -1,101 +0,0 @@
----
-layout: "docs"
-page_title: "Puppet Agent - Provisioning"
-sidebar_current: "provisioning-puppetagent"
-description: |-
-  The Vagrant Puppet agent provisioner allows you to provision the guest using
-  Puppet, specifically by calling "puppet agent", connecting to a Puppet master,
-  and retrieving the set of modules and manifests from there.
----
-
-# Puppet Agent Provisioner
-
-**Provisioner name: `puppet_server`**
-
-The Vagrant Puppet agent provisioner allows you to provision the guest using
-[Puppet](https://www.puppetlabs.com/puppet), specifically by
-calling `puppet agent`, connecting to a Puppet master, and retrieving
-the set of modules and manifests from there.
-
-<div class="alert alert-warning">
-  <strong>Warning:</strong> If you are not familiar with Puppet and Vagrant already,
-  I recommend starting with the <a href="/docs/provisioning/shell.html">shell
-  provisioner</a>. However, if you are comfortable with Vagrant already, Vagrant
-  is the best way to learn Puppet.
-</div>
-
-## Options
-
-The `puppet_server` provisioner takes various options. None are strictly
-required. They are listed below:
-
-* `binary_path` (string) - Path on the guest to Puppet's `bin/` directory.
-
-* `client_cert_path` (string) - Path to the client certificate for the
-  node on your disk. This defaults to nothing, in which case a client
-  cert will not be uploaded.
-
-* `client_private_key_path` (string) - Path to the client private key for
-  the node on your disk. This defaults to nothing, in which case a client
-  private key will not be uploaded.
-
-* `facter` (hash) - Additional Facter facts to make available to the
-  Puppet run.
-
-* `options` (string or array) - Additional command line options to pass
-  to `puppet agent` when Puppet is ran.
-
-* `puppet_node` (string) - The name of the node. If this is not set,
-  this will attempt to use a hostname if set via `config.vm.hostname`.
-  Otherwise, the box name will be used.
-
-* `puppet_server` (string) - Hostname of the Puppet server. By default
-  "puppet" will be used.
-
-## Specifying the Puppet Master
-
-The quickest way to get started with the Puppet agent provisioner is to just
-specify the location of the Puppet master:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "puppet_server" do |puppet|
-    puppet.puppet_server = "puppet.example.com"
-  end
-end
-```
-
-By default, Vagrant will look for the host named "puppet" on the
-local domain of the guest machine.
-
-## Configuring the Node Name
-
-The node name that the agent registers as can be customized. Remember
-this is important because Puppet uses the node name as part of the process
-to compile the catalog the node will run.
-
-The node name defaults to the hostname of the guest machine, but can
-be customized using the Vagrantfile:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "puppet_server" do |puppet|
-    puppet.puppet_node = "node.example.com"
-  end
-end
-```
-
-## Additional Options
-
-Puppet supports a lot of command-line flags. Basically any setting can
-be overridden on the command line. To give you the most power and flexibility
-possible with Puppet, Vagrant allows you to specify custom command line
-flags to use:
-
-```ruby
-Vagrant.configure("2") do |config|
-  config.vm.provision "puppet_server" do |puppet|
-    puppet.options = "--verbose --debug"
-  end
-end
-```