Name: gbif-ipt-vagrant
Owner: Biological Informatics CoE @ Agriculture and Agri-Food Canada
Owner: Biological Informatics CoE @ Agriculture and Agri-Food Canada
Description: Package to quickly launch a GBIF IPT instance inside a VM
Created: 2014-08-27 14:57:34.0
Updated: 2016-11-07 18:41:13.0
Pushed: 2016-11-07 18:41:13.0
Homepage: null
Size: 29
Language: Shell
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Package to quickly launch a GBIF IPT instance inside a Vagrant VM.
Vagrant 1.7+: Some functionality being used in this Vagrantfile is available since Vagrant v1.6.5 but have been only tested with Vagrant v1.7. Please see the Hypervisor Support section for additional requirements that depend on your configuration.
Step) Description: execute command in the terminal
1) Clone this repository: git clone http://github.com/aafc-mbb/gbif-ipt-vagrant
2) Change directory into the cloned repository: cd gbif-ipt-vagrant
3) Copy the config.yml.sample to config.yml and modify it accordingly
4) Install vagrant:
5) Initialize the VM and wait for provisioning to complete: vagrant up
6) Navigate to IPT in a web browser
7) Complete the IPT configuration
For this hypervisor, modifications are not required. Folders between the hypervisor and host are synced using VirtualBox's Shared Folders. This hypervisor permits using a Windows, Linux, or Mac host.
Ensure that you have VirtualBox installed before continuing.
Inside the GIT repository you cloned, start the VM using
vagrant up
Support for the libvirt provider allows using several underlying hypervisors through the libvirt api. KVM is the default hypervisor, which is supported using most modern Linux hosts.
Ensure that you have installed the libvirt, kvm, and all relevant system packages and are able to start a KVM Virtual Machine before using this repository. In addition, Vagrant will NFS mount the ipt-data folder in the VM from an NFS Server running on the Host. To support this, you must install an NFS server on your host and modify the firewall to support TCP access to the relevant ports for the NFS server. Vagrant will automatically configure and export the appropriate shares and restart the NFS Server when it starts the VM.
The vagrant-libvirt plugin is required before issuing a vagrant up command. This requires system packages to be installed. Ob debian based systems: libxslt-dev libxml2-dev libvirt-dev . On fedora based systems: libxslt-devel libxml2-devel libvirt-devel
vagrant plugin install vagrant-libvirt
In addition, you must convert the Vagrant box from the VirtualBox format to the libvirt format using vagrant-mutate.
Inside the GIT repository you cloned, start the VM with libvirt using
vagrant up –provider=libvirt
The vagrant-openstack-plugin is required before issuing a vagrant up command. This plugin is only compatible with Vagrant 1.4+ and can be installed using:
vagrant plugin install vagrant-openstack-plugin
In addition, a dummy box must be installed as it is required for Vagrant to function:
vagrant box add dummy https://github.com/cloudbau/vagrant-openstack-plugin/raw/master/dummy.box
Generate a private/public key pair to use for SSHing into the VM and register it in Openstack and your workstation. See Openstack's documentation for more information.
The openstack provider requires some configuration in config.yml under the vm->provider->openstack section.
NOTE: This provider ignores the vm->networking section config.yml completely!
See the following for a brief explanation of the options.
enabled: true | false - Set to 'true' if you want to use the openstack provider (vagrant-openstack-plugin required)
box: dummy - Name of the empty box to user. This is a limitation of Vagrant.
vm-name: 'IPT' - Name of the instance that you will see in OpenStack
box-url: https://github.com/cloudbau/vagrant-openstack-plugin/raw/master/dummy.box - Place holder
username: admin - OpenStack identity/authentication username
api-key: admin - OpenStack identity/authentication password.
flavor: m1.small - Name of VM flavor to use. m1.small, m1.medium, etc are default flavours in openstack. They control the VM's cpu, mem, and storage paremeters.
project-name: admin | - The project name to use. Leave empty to use the default project for your account.
image: Ubuntu 14.04 Trusty - The base image to use (must be available in OpenStack). This Vagrantfile is based on and tested on Debian 6 and Ubuntu 14.04 only.
identity-auth-url: http://openstack-test.biodiversity.agr.gc.ca:5000/v2.0/tokens - URL to identity service appended by "/tokens"
ssh-username: ubuntu - The username used to SSH into the VM, which is typically defined in the image (default is ubuntu for Ubuntu cloud images)
ssh-key-path: ~/.ssh/cloud.key - Location of the SSH private key on disk. You must generate a private/public key pair abd unoirt the public key to openstack.
keypair-name: iyad - Name of the private/public key pair defined in OpenStack. You must generate a private/public key pair and import the public key to openstack.
floating-ip: 192.168.0.100 | auto | - Provide a floating-ip address, or set to 'auto', or leave it empty. This will be the IP used to access the VM. If left empty, the nova network IP will be used.
Insite the GIT repository you cloned, start the VM with OpenStack using
vagrant up –provider=openstack
The vagrant-aws plugin is required before issuing a vagrant up command. This plugin is only compatible with Vagrant 1.2+ and can be installed using:
vagrant plugin install vagrant-aws
In addition, a dummy box must be installed as it is required for Vagrant to function:
vagrant box add ubuntu_aws vagrant box add dummy https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box
Generate a private/public key pair to use for SSHing into the VM and register it in AWS and your workstation. See [Amazon's keypair documentation]http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) for more information.
The AWS provider requires some configuration in config.yml under the vm->provider->aws section.
NOTE: This provider ignores the vm->networking section config.yml completely!
See the following for a brief explanation of the options.
i vm-name: 'IPT' - Identifier to assign to VM
box: ubuntu_aws - A dummy box that Vagrant requires for backwards compatibility
box-url: https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box - The path for the dummy box
access-key-id: ABCDEFGHIJKLMNOP - AWS access id
secret-access-key: ABCDEFHIJKLMNOPQRSTUVWXYZ1234567890 - AWS secret key
keypair-name: example-keypair - SSH keypair name in AWS (ensure it is in your default region)
ssh-key-path: ~/.ssh/example-keypair.pem - Private key path on your disk
ssh-username: ubuntu - Username to ssh with (set in the image)
instance-type: t2.micro - The instance type defines the CPU, Mem, and Storage for the VM
image: ami-8827efe0 - Amazon Machine Image identifier
elastic-ip: - Provide an existing elastic-ip address, or set to 'auto' to assign a new one, or leave it empty
Insite the GIT repository you cloned, start the VM with AWS using
vagrant up –provider=aws
Two networking options are supported: private and public. Modify config.yml and edit the networking->type parameter to switch between these two modes. You can change this option and reload the VM using
vagrant reload –provision
Note: The OpenStack and AWS providers ignores the networking section in config.yml completely. If using the OpenStack or AWS provider, please skip this section.
Vagrant establishes a network between the hypervisor and its VMs where traffic flow into the VM must be explicitly forwarded to the VM by defining port forwarding. Hence, the VM's IP is not accessible from outside the VM. This is advantageous when IPs are limited or adding DNS records is not possible, which means you are relying on an existing hostname and IP. Nevertheless, this creates the need for port forwarding from the Host (Hypervisor) to the Guest, which causes a management overhead. To specify the forwarded ports, modify config.yml and add/remove entries in networking->private->port-forward with a guest-port: host-port syntax.
Vagrant creates a bridge interface to a logical device on the host (Hypervisor) and pass traffic through to it from the VM. This permits assigning the VM a “public” IP and avoid the need for port forwarding. Currently, DHCP is not supported. Edit config.yml and modify the ip, gateway, dns parameters under networking->public accordingly.
The following contributors have dedicated the time and effort to make this possible.
Allan Jones Agriculture & Agri-Foods Canada
Iyad Kandalaft Agriculture & Agri-Foods Canada
If you feel that your name should be on this list, please make a pull request listing your contributions.
Package to quickly launch a GBIF IPT instance inside a Vagrant VM.
Vagrant 1.7+: Some functionality being used in this Vagrantfile is available since Vagrant v1.6.5 but have been only tested with Vagrant v1.7. Please see the Hypervisor Support section for additional requirements that depend on your configuration.
Step) Description: execute command in the terminal
1) Clone this repository: git clone http://github.com/aafc-mbb/gbif-ipt-vagrant
2) Change directory into the cloned repository: cd gbif-ipt-vagrant
3) Copy the config.yml.sample to config.yml and modify it accordingly
4) Install vagrant:
5) Initialize the VM and wait for provisioning to complete: vagrant up
6) Navigate to IPT in a web browser
7) Complete the IPT configuration
For this hypervisor, modifications are not required. Folders between the hypervisor and host are synced using VirtualBox's Shared Folders. This hypervisor permits using a Windows, Linux, or Mac host.
Ensure that you have VirtualBox installed before continuing.
Inside the GIT repository you cloned, start the VM using
vagrant up
Support for the libvirt provider allows using several underlying hypervisors through the libvirt api. KVM is the default hypervisor, which is supported using most modern Linux hosts.
Ensure that you have installed the libvirt, kvm, and all relevant system packages and are able to start a KVM Virtual Machine before using this repository. In addition, Vagrant will NFS mount the ipt-data folder in the VM from an NFS Server running on the Host. To support this, you must install an NFS server on your host and modify the firewall to support TCP access to the relevant ports for the NFS server. Vagrant will automatically configure and export the appropriate shares and restart the NFS Server when it starts the VM.
The vagrant-libvirt plugin is required before issuing a vagrant up command. This requires system packages to be installed. Ob debian based systems: libxslt-dev libxml2-dev libvirt-dev . On fedora based systems: libxslt-devel libxml2-devel libvirt-devel
vagrant plugin install vagrant-libvirt
In addition, you must convert the Vagrant box from the VirtualBox format to the libvirt format using vagrant-mutate.
Inside the GIT repository you cloned, start the VM with libvirt using
vagrant up –provider=libvirt
The vagrant-openstack-plugin is required before issuing a vagrant up command. This plugin is only compatible with Vagrant 1.4+ and can be installed using:
vagrant plugin install vagrant-openstack-plugin
In addition, a dummy box must be installed as it is required for Vagrant to function:
vagrant box add dummy https://github.com/cloudbau/vagrant-openstack-plugin/raw/master/dummy.box
Generate a private/public key pair to use for SSHing into the VM and register it in Openstack and your workstation. See Openstack's documentation for more information.
The openstack provider requires some configuration in config.yml under the vm->provider->openstack section.
NOTE: This provider ignores the vm->networking section config.yml completely!
See the following for a brief explanation of the options.
enabled: true | false - Set to 'true' if you want to use the openstack provider (vagrant-openstack-plugin required)
box: dummy - Name of the empty box to user. This is a limitation of Vagrant.
vm-name: 'IPT' - Name of the instance that you will see in OpenStack
box-url: https://github.com/cloudbau/vagrant-openstack-plugin/raw/master/dummy.box - Place holder
username: admin - OpenStack identity/authentication username
api-key: admin - OpenStack identity/authentication password.
flavor: m1.small - Name of VM flavor to use. m1.small, m1.medium, etc are default flavours in openstack. They control the VM's cpu, mem, and storage paremeters.
project-name: admin | - The project name to use. Leave empty to use the default project for your account.
image: Ubuntu 14.04 Trusty - The base image to use (must be available in OpenStack). This Vagrantfile is based on and tested on Debian 6 and Ubuntu 14.04 only.
identity-auth-url: http://openstack-test.biodiversity.agr.gc.ca:5000/v2.0/tokens - URL to identity service appended by "/tokens"
ssh-username: ubuntu - The username used to SSH into the VM, which is typically defined in the image (default is ubuntu for Ubuntu cloud images)
ssh-key-path: ~/.ssh/cloud.key - Location of the SSH private key on disk. You must generate a private/public key pair abd unoirt the public key to openstack.
keypair-name: iyad - Name of the private/public key pair defined in OpenStack. You must generate a private/public key pair and import the public key to openstack.
floating-ip: 192.168.0.100 | auto | - Provide a floating-ip address, or set to 'auto', or leave it empty. This will be the IP used to access the VM. If left empty, the nova network IP will be used.
Insite the GIT repository you cloned, start the VM with OpenStack using
vagrant up –provider=openstack
The vagrant-aws plugin is required before issuing a vagrant up command. This plugin is only compatible with Vagrant 1.2+ and can be installed using:
vagrant plugin install vagrant-aws
In addition, a dummy box must be installed as it is required for Vagrant to function:
vagrant box add ubuntu_aws vagrant box add dummy https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box
Generate a private/public key pair to use for SSHing into the VM and register it in AWS and your workstation. See [Amazon's keypair documentation]http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) for more information.
The AWS provider requires some configuration in config.yml under the vm->provider->aws section.
NOTE: This provider ignores the vm->networking section config.yml completely!
See the following for a brief explanation of the options.
i vm-name: 'IPT' - Identifier to assign to VM
box: ubuntu_aws - A dummy box that Vagrant requires for backwards compatibility
box-url: https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box - The path for the dummy box
access-key-id: ABCDEFGHIJKLMNOP - AWS access id
secret-access-key: ABCDEFHIJKLMNOPQRSTUVWXYZ1234567890 - AWS secret key
keypair-name: example-keypair - SSH keypair name in AWS (ensure it is in your default region)
ssh-key-path: ~/.ssh/example-keypair.pem - Private key path on your disk
ssh-username: ubuntu - Username to ssh with (set in the image)
instance-type: t2.micro - The instance type defines the CPU, Mem, and Storage for the VM
image: ami-8827efe0 - Amazon Machine Image identifier
elastic-ip: - Provide an existing elastic-ip address, or set to 'auto' to assign a new one, or leave it empty
Insite the GIT repository you cloned, start the VM with AWS using
vagrant up –provider=aws
Two networking options are supported: private and public. Modify config.yml and edit the networking->type parameter to switch between these two modes. You can change this option and reload the VM using
vagrant reload –provision
Note: The OpenStack and AWS providers ignores the networking section in config.yml completely. If using the OpenStack or AWS provider, please skip this section.
Vagrant establishes a network between the hypervisor and its VMs where traffic flow into the VM must be explicitly forwarded to the VM by defining port forwarding. Hence, the VM's IP is not accessible from outside the VM. This is advantageous when IPs are limited or adding DNS records is not possible, which means you are relying on an existing hostname and IP. Nevertheless, this creates the need for port forwarding from the Host (Hypervisor) to the Guest, which causes a management overhead. To specify the forwarded ports, modify config.yml and add/remove entries in networking->private->port-forward with a guest-port: host-port syntax.
Vagrant creates a bridge interface to a logical device on the host (Hypervisor) and pass traffic through to it from the VM. This permits assigning the VM a “public” IP and avoid the need for port forwarding. Currently, DHCP is not supported. Edit config.yml and modify the ip, gateway, dns parameters under networking->public accordingly.
The following contributors have dedicated the time and effort to make this possible.
Allan Jones Agriculture & Agri-Foods Canada
Iyad Kandalaft Agriculture & Agri-Foods Canada
If you feel that your name should be on this list, please make a pull request listing your contributions.