Vagrant Packet Provider

This Vagrant plugin allows you to create and manage packet.net instances.

Based heavily (almost completely) on the Vagrant-AWS provider written by Mitchell Hashimoto

This repository is Experimental meaning that it's based on untested ideas or techniques and not yet established or finalized or involves a radically new and innovative style! This means that support is best effort (at best!) and we strongly encourage you to NOT use this in production.

Of note:

• Packet provisions bare metal machines. It's cool.
  • Since they're bare metal, provision time is somewhat slower (5-10min)
  • Once provisioned, I suggest vagrant halt and vagrant up for faster performance.
  • Keeping machines around does cost money so running vagrant destroy once your short-term needs are met is a good idea.
• You need to add your SSH Key within the Packet.net portal. Vagrant will not handle this for you. (Much like the Vagrant-Google plugin.)
• Your synced folders must use the rsync option (seen below) or it won't work.
• There are some Packet-specific options required in the config. The example explains how to find and select the correct options.

Installation and use:

To install, run vagrant plugin install vagrant-packet

You can then use the packet provider in Vagrant.

Example Vagrantfile:

Vagrant.configure("2") do |config|
    config.vm.box = "packet.box"

    config.vm.synced_folder ".", "/vagrant", type: "rsync", rsync__exclude: ".git/"
    
    config.vm.provider :packet do |packet, override|
        # Create an API token within Packet
        # See https://help.packet.net/quick-start/api-integrations
        # This can be read from the Environment Variable "PACKET_TOKEN".
        # Setting via Environment variable is preferred to prevent possible secret leakage.
        packet.packet_token = "YOUR_PACKET_API_TOKEN"

        # Get your project ID
        # See https://help.packet.net/faq/onboarding/portal
        # This can be read from the Environment Variable "PACKET_PROJECT_ID"
        # Setting via Environment variable is preferred to prevent possible secret leakage.
        packet.project_id = "YOUR_PACKET_PROJECT_ID"

        # Example: sjc1
        # See https://help.packet.net/faq/pre-sales/data-centers for
        # a list. Always use lower-case for the facility name.
        packet.facility = "DATACENTER"

        # Example: c2.medium.x86
        # Use the datacenter link above to make sure your machine
        # type is supported in your selected datacenter
        packet.plan = "MACHINE_TYPE"

        # Example: ubuntu_16_04
        # Use https://www.packet.net/developers/api/operatingsystems/
        # to find available operating systems and the correct label
        packet.operating_system = "OS"

        # Packet provisions machines with root so we must set this
        override.ssh.username = "root"

        # Make sure you've added your SSH key within Packet.
        # See https://help.packet.net/technical/infrastructure/ssh-access
        override.ssh.private_key_path = "~/.ssh/id_rsa"
    end
end

With this vagrant file you can then run vagrant up

Development

To work on the vagrant-packet plugin, clone this repository out, and use Bundler to get the dependencies:

$ bundle

Once you have the dependencies, verify the unit tests pass with rake:

$ bundle exec rake

If those pass, you're ready to start developing the plugin. You can test the plugin without installing it into your Vagrant environment by just creating a Vagrantfile in the top level of this directory (it is gitignored) and add the following line to your Vagrantfile

Vagrant.require_plugin "vagrant-packet"

Use bundler to execute Vagrant:

$ bundle exec vagrant --provider=packet up