Take home your very own free Vagrant CFML Dev Environment - Presented at dev.Objective() June 17, 2016

Take Home Your Very Own
Free Vagrant CFML
Dev Environment
Presented By: Gavin Pickin
dev.Objective() 2016

Who Am I?
★Gavin Pickin – developing Web Apps since late 90s
○Ortus Solutions Software Consultant
○ContentBox Evangelist
★What else do you need to know?
○CFMLRepo.com http://www.cfmlrepo.com
○Blog - http://gpickin.com
○Twitter – http://tw.gavinpickin.com
○Github - https://github.com/gpickin
○Linked In: http://li.gavinpickin.com/
★Lets get on with the show.

The Problem
From developers, designers, managers, everyone working on your app, needs a
way to run dev versions of your app, on their machines.
The problem is, you might have:
● different OSes,
● different file systems,
● different web servers
● different app servers
● different db servers
● manager dns and ips
● a million dependencies to manage

● Windows
● CentOS / RHEL
● Ubuntu
● Other?
What OS do you use?

What Web Server do you use?
● IIS
● Apache
● Nginx

What CFML Server do you use?
● Railo
● Lucee 4.5
● Lucee 5
● ColdFusion 9
● ColdFusion 10
● ColdFusion 11
● ColdFusion 12 2016

What DB do you use?
● MSSql
● MySql
● PostgreSql
● Oracle
● Couchbase
● CouchDB
● Reddis
● Mongo
● Local Storage
● Cookies
● MS Access
● Excel
● CSV
● Text

The Solution
A simple vm that can be
up and running in minutes
that gives the developer
the same dev
environment as everyone
else, regardless of
platform, tools, engines,
os etc

The Solution
" Vagrant provides easy to configure,
reproducible, and portable work
environments built on top of industry-
standard technology and controlled by a
single consistent workflow to help
maximize the productivity and flexibility of
you and your team."
https://www.vagrantup.com/docs/why-vagrant/

Is Vagrant Perfect???
● nothing is perfect
● there are a lot of pros and cons
● it might be overkill for
small or simple projects

Alternatives to Vagrant
● CommandBox
● Docker - Containers
● Chef / Puppet / Ansible

CommandBox - Pros
● love it
● cross platform
● Simple
● multi engine
● it's cfml and json
● always improving

CommandBox - Cons
● undertow not a full web server
● It's dependent on your os
● limited host support
● limited rewrites etc
● it's dependent on your
libraries tools etc

Docker / Chef / Puppet / Ansible - Pros
● Lots of great alternative options
● Lots of great features and benefits
but...

Docker / Chef / Puppet / Ansible - Cons
● Another set of fast moving tools to learn
● Each have their own strengths and weaknesses
● New configuration options, syntax and DSL
● How easy is it really to drop a CFML site in and go
Disclaimer: I’m going to several docker sessions this week,
so hopefully I will know more

Why use Vagrant?
● automated configuration for team environments, perfect example,
SAP connector or image magick plugins
● automated mappings, data sources, other settings
● automated dependencies and library versions
● easy switching in and out between os, web servers etc
● source control for sharing and maintaining the specs / automation
● solid cross platform compat
● dev like local, test like staging

As a CFML Dev - So why should I use vagrant
then?
With the setup I am going to show you:
● It reduces the barriers to entry
● Gives you a great starting point
● No requirement for learning vagrant
We can also work together to better this vagrant tool, offer
more options, and share our successes.

Installing Vagrant
Installing Vagrant is easy
Visit Download page and select the
appropriate OS package
https://www.vagrantup.com/downloads.html
Installation will add ‘vagrant’ to your path.
Logout and login again if necessary

Providers
Providers is the underlying tool that your VM runs on.
While Vagrant ships out of the box with support for
VirtualBox, Hyper-V, and Docker, you can install others.
2 common use cases
● Virtual Box - https://www.virtualbox.org/wiki/Downloads
○ Free
● VM Ware
○ Commercial

Providers
You can switch out a provider in the vagrant file, or
on vagrant up
$ vagrant up --provider=vmware_fusion
$ vagrant up --provider=aws

Boxes
Instead of building a virtual machine from
scratch, which would be a slow and tedious
process, Vagrant uses a base image to quickly
clone a virtual machine.
You can also share your vagrant file and
provisioners, like I am today

Provisioners
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 where you can automate your process to make it
repeatable, sharable, and this is where the value of Vagrant
really kicks in.
You can provision with a lot of different tools.

Plugins
Once Vagrant is installed, or if it already is, it's highly
recommended that you install the following Vagrant plugins:
● vagrant-hostsupdater
$ vagrant plugin install vagrant-hostsupdater
● vagrant-vbguest
$ vagrant plugin install vagrant-vbguest

Command Line Interface - CLI
Although you have options to add, edit and remove boxes, and a lot more,
in this session, we're talking about using existing Vagrant setups that we
have built, and we're sharing with you.
Common Commands that you will use with these setups would be
● vagrant up
● vagrant halt
● vagrant reload
● vagrant provision
● vagrant reload --provision
● vagrant ssh
● vagrant destroy
● vagrant share

CLI Command: vagrant up
This command creates and configures guest machines
according to your Vagrantfile.
This is the single most important command in Vagrant, since
it is how any Vagrant machine is created. Anyone using
Vagrant must use this command on a day-to-day basis.

CLI Command: vagrant halt
This command shuts down the running machine Vagrant is
managing.
Vagrant will first attempt to gracefully shut down the machine
by running the guest OS shutdown mechanism. If this fails, or
if the --force flag is specified, Vagrant will effectively just shut
off power to the machine.

CLI Command: vagrant reload
The equivalent of running a halt followed by an up.
This command is usually required for changes made in the
Vagrantfile to take effect. After making any modifications to
the Vagrantfile, a reload should be called.
The configured provisioners will not run again, by default. You
can force the provisioners to re-run by specifying the --
provision flag.

CLI Command: vagrant provision
Runs any configured provisioners against the running
Vagrant managed machine.
This command is a great way to quickly test any provisioners.
You can just make simple modifications to the provisioning
scripts on your machine, run a vagrant provision, and check
for the desired results. Rinse and repeat.

CLI Command: vagrant reload --provision
The equivalent of running a halt followed by an up and forcing
provisioners to run.
After making any modifications to the Vagrantfile, or the
Provisioners, a reload should be called.

CLI Command: vagrant ssh
This will SSH into a running Vagrant machine and give you
access to a shell.
Note: On Windows you need a TTY terminal for full shell
interactivity, one option is ConEmu.

CLI Command: vagrant destroy
This command stops the running machine Vagrant is managing and destroys all
resources that were created during the machine creation process. After running
this command, your computer should be left at a clean state, as if you never
created the guest machine in the first place.
Warning: If you do a destroy, the next time you ‘vagrant up’ - you will have a long
wait before the VM is ready

CLI Command: vagrant share
The share command initializes a Vagrant Share session,
allowing you to share your Vagrant environment with anyone
in the world, enabling collaboration directly in your Vagrant
environment in almost any network environment.
This is not perfect, and you should not rely on it. I will try and
demo this later, but it might go down in flames, be warned.

Learning Curve
The title of this session promised a free cfml dev
environment, do I have to do everything myself?
Thankfully no… thanks to members of the CFML community,
you have some ready to go vagrant images.
Lets look at one, and see how it works.

Vagrant-centos-lucee
Github Repo: https://github.com/Ortus-Solutions/vagrant-
centos-lucee
Big thanks to: Dan Skaggs, Luis Majano, Brad Wood, and
Evagoras Charalambous
Lets look at the readme.md

What’s in the repo?
● vagrant/ : Run all vagrant commands from this directory.
○ artifacts/ : Where downloaded installers will be placed
○ provisioners/ : The provisionning bash scripts for the box
○ configs/ : Configuration files for Nginx, Lucee, etc
○ Vagrantfile/ : The vagrant configuration file
○ log/ : Where a log file is stored that documents the last provisioning
process.
○ Sample_VagrantConfig.yaml : A sample configuration file for new sites.
See "Configuring Sites".
● www/ : Code for the small, default site that shows you the status of your
configuration

Why this setup is awesome
● mappings etc
● cfml customization
● built on commandbox
● you can have fusion reactor built in
● dev config can match staging & production
● Ties into cfml engine to settings & config

Customizations I have made before
● updated lucee version
● updated or specific version or nginx
● SES rewrite support
● installing image magick
● installing and r3 adapter for SAP
● config files that match staging and
production - storage

Deep dive into the r3 adapter install
● copy jars
● copy *.so files
● you, installing lib.std.c++5.0
● copying an so file to the right folder /usr/var
● creating and ldconfig conf file with paths to jars
and so files
● running the ldconfig to load the dynamic library

Let's look at vagrant up and running
I’m not dumb enough to do a full live demo without slides.
Screenshots, so we can stop and talk about each one
Fingers crossed, we’ll try a live demo too.

Add a new site to this setup
The conventions for this setup are fairly simple
Create a folder to put your VM stuff in
Inside that:
● clone your vagrant repo
● Add your websites
● Add VagrantConfig folder to your websites
● Add vagrant credentials folder**
** Vagrant Credentials Folder - optional but recommended

Add your Website
You can take 2 approaches to adding your files
Flat structure Nested structure

Website Vagrant Config File
● Yaml file - Tabs and spaces matter
● Location: VagrantConfig / settings.yaml
● Site settings to help vagrant spin up your
website automatically

Vagrant Config - Page 1
# name of the app
name: coldboxRest
# Path to web root relative to the repo root
webroot: www
# SES Rewrites - True or False
sesrewrites: false
# List of domains to be added to the Host machine's and VM's "hosts" file
hosts:
- coldboxrest.gpickin.com

# List of CF Mappings to create relative to the repo root or drive root if starts with a /
cfmappings:
- virtual: '/storage/coldboxrest/'
physical: '/opt/storage/coldboxrest/'
# List of Nginx Mappings to create
nginxmappings:
- virtual: '/storage/coldboxrest/'
physical: '/opt/storage/coldboxrest/'

# List of datasources to create
datasources:
- name: coldboxapp_client
database: coldboxapp_Client
host: mydb.gpickin.com
port: 1433
class: com.microsoft.jdbc.sqlserver.SQLServerDriver
dsn: jdbc:sqlserver://{host}:{port};DATABASENAME={database};
sendStringParametersAsUnicode=true;SelectMethod=direct
storage: true
password: topsecret
username: gavin

Provisioning your Websites
Vagrant provision or vagrant reload --provision

What is the Vagrant Credentials folder
This is a convention for an external location to store your username and
passwords for your datasources.
VagrantCredentials / DB.yaml
Provisioner looks in this file when generating the datasources for your applications
If you do not have a record for a datasource in the DB.yaml - it will create one for
you and warn you in the provisioner
If you do not have username and password in the app settings yaml, you need a
DB.yaml file, or the provisioner will error.

Why use Vagrant Credentials
Security:
This keeps the usernames and passwords out of your app
source control
Flexibility:
It allows users to have their own usernames and passwords
myDatasource: {username: gavin, password:
topsecretpassword}

Reprovision Vagrant
Vagrant provision or vagrant reload --provision

Vagrant File
The vagrant file is the core of vagrant, with all the details, on what should run,
when, and how.
https://github.com/Ortus-Solutions/vagrant-centos-
lucee/blob/master/vagrant/Vagrantfile
# -*- mode: ruby -*-
# vi: set ft=ruby :
# Require YAML module
require 'yaml'

Vagrant File - Server Configuration
# server configuration
vm_ip_address = "192.168.60.35"
vm_naked_hostname = "lucee.dev"
vm_name = "Lucee-CFML"
vm_max_memory = 1024
vm_num_cpus = 2
vm_max_host_cpu_cap = "100"

Vagrant File - Synced Folders
# synced folder configuration
synced_webroot_local = "../www"
synced_webroot_box = "/var/wwwDefault/"
synced_webroot_id = "wwwDefault"
synced_webroot_owner = "vagrant"
synced_webroot_group = "vagrant"
synced_parent_local = "../../"
synced_parent_box = "/vagrant-parent"
synced_parent_id = "vagrant-parent"
synced_parent_owner = "vagrant"
synced_parent_group = "vagrant"

Vagrant File - do Config
Vagrant.configure("2") do |config|
config.vm.box = "centos-7-x64"
config.vm.box_url = "https://github.com/holms/vagrant-centos7-
box/releases/download/7.1.1503.001/CentOS-7.1.1503-x86_64-netboot.box"
config.vm.boot_timeout = 180

Vagrant File - Provider Do
config.vm.provider "virtualbox" do |v|
# set name of vm
v.name = vm_name
# no matter how much cpu is used in vm, use no more than
vm_max_host_cpu_cap amount
v.customize ["modifyvm", :id, "--cpuexecutioncap", vm_max_host_cpu_cap]
# set max amount of host machine ram allotted for vm to use
v.customize ["modifyvm", :id, "--memory", vm_max_memory]
# set number of cpus from host machine that vm is allowed to use
v.customize ["modifyvm", :id, "--cpus", vm_num_cpus]
……...

Vagrant File - Provider Do - Cont.
# the next two settings enable using the host computer's dns inside the
vagrant box
# enable dns proxy in nat mode
v.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
# use the host's resolver as a dns proxy in nat mode
v.customize ["modifyvm", :id, "--natdnsproxy1", "on"]
end

Vagrant File - Network Setup
# set vm ip address and add auto_correct on forwarded port so it doesn't
collide with other vagrant boxes
config.vm.network :private_network, ip: vm_ip_address
# config.vm.network :forwarded_port, guest: 22, host: 2223, auto_correct: true

Vagrant File - The Web Hosts
# An array of hosts that need configured on the host machine to access the VM
hosts = []
# Look for other sites checked out in the same directory as this repo that have a
"VagrantConfig.yaml" in their root.
siteConfigs = Dir["../../*/VagrantConfig/*.yaml"]

Vagrant File - The Web Hosts - Cont.
siteConfigs.each do |config|
if File.read(config).length > 0
thisConfig = YAML.load_file( config )
puts "Found '#{thisConfig["name"]}' in #{config.sub! '../../', ''}"
hosts.concat thisConfig["hosts"]
else
puts "Found '#{config}' but it was empty!"
end
end

Vagrant File - Host Updater
if Vagrant.has_plugin?("vagrant-hostsupdater")
# set vm hostname
config.vm.hostname = vm_naked_hostname
config.hostsupdater.aliases = hosts
end

Vagrant File - Provisioners
# Init log file
config.vm.provision :shell, :path => "provisioners/setup-log.sh", :privileged => true
# set vm timezone and do some cleanup before installations
config.vm.provision :shell, :path => "provisioners/set-vm-timezone.sh", :privileged
=> true
# install miscellaneous utilities
config.vm.provision :shell, :path => "provisioners/install-utilities.sh", :privileged =>
true

# install/configure nginx
config.vm.provision :shell, :path => "provisioners/install-nginx.sh", :privileged =>
true
# install/configure Oracle JDK
config.vm.provision :shell, :path => "provisioners/install-jdk.sh", :privileged => true

# install/configure CommandBox
config.vm.provision :shell, :path => "provisioners/install-commandbox.sh", :
privileged => true
# install/configure lucee
config.vm.provision :shell, :path => "provisioners/install-lucee.sh", :privileged =>
true, :args => [
vm_name, vm_naked_hostname, vm_ip_address
]

Gotchas - The hard lessons learned
● Hosts plugin, killing vagrant can leave them in your hosts file
● Vpn access can mess with your
host files, and sometimes your
Vagrant
● Case sensitivity

● Sometimes I forgot if it was running...
● Or which vagrant was running
● Fs plugin only works for 1 share
● vagrant reload
vs
vagrant reload --provision

● Hosts plugin, killing vagrant can leave them in your hosts file
● Vpn access can mess with your host files, and sometimes your
vagrant
● Sometimes I forgot if it was running... Or which vagrant was
running
● Case sensitivity
● Fs plugin only works for 1 share
● Vagrant reload vs vagrant reload --provision

CentOS Lucee Nginx Vagrant
● This is the vagrant box used today
● Please go fork it, star it, and subscribe
● Clone it, spin it up and try it out
Github repo: https://github.com/Ortus-Solutions/vagrant-
centos-lucee

Ubuntu Lucee Nginx Vagrant
● This is the vagrant box I have not completed converting
yet
● Please go fork it, star it, and watch it for more information.
Github repo: https://github.com/Ortus-Solutions/vagrant-
ubuntu-lucee

ColdFusion 11 Vagrant Box
George Murphy has a CF11 Vagrant running on CentOS.
Presented on it at Into The Box, and some User Groups
https://github.com/murpg/centos-coldfusion-vagrant

More Vagrant Flavors
Using the survey from earlier, I want to prioritize the building
of vagrant boxes with different combinations
Some options can be a flag in the vagrant file
Consistent use across OSes and Webservers with the
conventions
How do you find them all?

Not just installation files any more
Adding IDE and IDE tools / plugins
Adding Vagrant and Docker images & getting started guides
Lets all pitch in and make our lives easier - http://www.cfmlrepo.com
Blog post and new site coming soon

Q & A
● Questions
● Comments
● Insults?

● Come try some chocolate
Richy & Creamy
● Keep an eye on http://www.gpickin.com/ for slides, blog posts and updates
● Linked In - http://li.gavinpickin.com/
Thanks everyone

Take home your very own free Vagrant CFML Dev Environment - Presented at dev.Objective() June 17, 2016

Recommended

Recommended

More Related Content

What's hot

What's hot (19)

Similar to Take home your very own free Vagrant CFML Dev Environment - Presented at dev.Objective() June 17, 2016

Similar to Take home your very own free Vagrant CFML Dev Environment - Presented at dev.Objective() June 17, 2016 (20)

More from Gavin Pickin

More from Gavin Pickin (12)

Recently uploaded

Recently uploaded (20)

Take home your very own free Vagrant CFML Dev Environment - Presented at dev.Objective() June 17, 2016