Skip to content

BasicSetup

Jump to bottom
Maciej Laskowski edited this page Sep 20, 2016 · 10 revisions

Basic Setup

This setup uses vagrant module, a pseudo-cookbook which is responsible for local environment provisioning using Vagrant (powered by Chef + Berkshelf under the hood).

Overview

Currently a virtual machine with the following services is created:

  • Karaf
  • Apache
  • Tomcat
  • ActiveMQ
  • MongoDb
  • Brosermob
  • Firefox
  • X environment

AET services

All services are running using default ports. For communication please use IP address:

  • 192.168.123.100

General prerequisites

By default Vagrant virtual machine needs 3 GB of RAM and 2 vCPUs, so please make sure that you have enough memory on your machine (8 GB is minimum, 16 GB recommended though).

Installation

As an administrator execute the following commands:

  • vagrant plugin install vagrant-omnibus
  • vagrant plugin install vagrant-berkshelf
  • vagrant plugin install vagrant-hostmanager

Whenever you'd like to keep all Vagrant related data and virtual machine disks in non-standard directories please:

  • set VAGRANT_HOME variable to new location (by default it is set to $HOME/vagrant.d).
  • update VirtualBox settings (File -> Preferences -> General) to move all disks to other directory.

Starting virtual machine

Once you set all described things up just execute:

berks update && vagrant destroy -f && vagrant up

First run

All commands have to be executed when you're inside a directory that contains Vagrantfile.

Next please execute:

  • berks install - downloads Chef dependencies from external sources. It acts as mvn clean install, but for Chef cookbooks.
  • vagrant up - creates new virtual machine (.box file will be downloaded during first run), runs Chef inside it, sets domains and port forwarding up.

Updates

Whenever new version is released please execute the following:

  • git pull to get latest version of Vagrantfile.
  • berks update to update Chef dependencies.
  • vagrant provision to re-run Chef on the virtual machine.

SSH access

To get into the virtual machine via SSH please execute vagrant ssh from the same directory that contains Vagrantfile. After that please type sudo -i and press ENTER to switch to root.

If you prefer to use PuTTY, mRemote or any other connection manager, please log in as user vagrant with password vagrant on localhost port 2222. Keep in mind that the port may be different if you have more than one Vagrant machine running at the same time. You can check current assignment by executing vagrant ssh-config command from directory that contains your Vagrantfile.

Useful Vagrant commands

  • vagrant reload restarts Vagrant machine and re-applies settings defined in Vagrantfile. It's useful whenever you've changed port forwarding or synced folder configuration.
  • vagrant destroy -f deletes entire virtual machine.
  • vagrant reload --provision restarts virtual machine and re-run Chef afterwards.
  • vagrant suspend suspends currently running virtual machine.
  • vagrant resume resumes suspended virtual machine.
  • vagrant status show status of virtual machine described in Vagrantfile.
  • vagrant halt halts/turns off virtual machine.

Port forwarding

Local port is a port exposed on your machine. You can access services via localhost:<PORT>.

VM port refers to port assigned inside Vagrant's virtual machine.

Port forwarding rules can be easily changed in Vagrantfile.

Local port VM port Description
8181 8181 Karaf

Known Issues

  • When getting following error on deploying application to local vagrant: 
    What went wrong: Execution failed for task ':deployDevClearCache'. > java.net.ConnectException: Connection timed out: connect
    run ifup eth1 command on vagrant using ssh.

Clone this wiki locally