Puppet agent daemon not reading a facter fact (EC2, cloud-init) - amazon-ec2

I am using puppet to read a fact from facter, and based on that I apply a different configuration to my modules.
Problem:
the puppet agent isn't seeing this fact. Running puppet agent --test interactively works as expected. Even running it non-interactively from a script seems to work fine. Only the agent itself is screwing up.
Process:
I am deploying an Ubuntu-based app stack on EC2. Using userdata (#cloud-config), I set an environment variable in /etc/environment:
export FACTER_tl_role=development
then immediately in #cloud-config, i source /etc/environment.
only THEN i apt-get install puppet (i moved away from using package: puppet to eliminate ambiguity in the sequence of #cloud-config steps)
Once the instance boots, I confirm that the fact is available: running facter tl_role returns "development". I then check /var/log/syslog, and apparently the puppet agent is not seeing this fact - I know this because it's unable to compile the catalog, and there's nothing (blank) where I'm supposed to be seeing the value of the variable set depending on this fact.
However, running puppet agent --test interactively compiles and runs the catalog just fine.
even running this from the #cloud-config script (immediately after installing puppet) also works just fine.
How do I make this fact available to the puppet agent? Restarting the agent service makes no difference, it remains unaware of the custom fact. Rebooting the instance also makes no difference.
here's some code:
EC2 userdata:
#cloud-config
puppet:
conf:
agent:
server: "puppet.foo.bar"
certname: "%i.%f"
report: "true"
runcmd:
- sleep 20
- echo 'export FACTER_tl_role=development' >> /etc/environment
- . /etc/environment
- apt-get install puppet
- puppet agent --test
Main puppet manifest:
# /etc/puppet/manifests/site.pp
node default {
case $tl_role {
'development': { $sitedomain = "dev.foo.bar"}
'production': { $sitedomain = "new.foo.bar"}
}
class {"code" : sitedomain => $sitedomain}
class {"apache::site" : sitedomain => $sitedomain}
class {"nodejs::grunt-daemon" : sitedomain => $sitedomain}
And then I see failures where $sitedomain is supposed to be, so $tl_role appears to be not set.
Any ideas? This is exploding my brain....

Another easy option would be to drop a fact into an external fact.
Dropping a file into /etc/facter/facts.d/* is fairly easy, and you can use a text file, yaml json or an executable to do it.
http://docs.puppetlabs.com/guides/custom_facts.html#external-facts
*that's on Open source puppet, on unix-y machines. See the link for the full docs.

Thank you, #christopher. This may be a good solution, I will test it and possibly move to it from my current horrible hack.
The answer I got in the Puppet Users Google Group was that I should not assume that the Puppet agent process will have an environment of a login shell, and that Facter will also have this environment when it is run by the Puppet agent.
Here is the way I solved it (admittedly, by brute force):
runcmd:
- echo 'export FACTER_tl_role=development' >> /etc/environment
- . /etc/environment
- apt-get install puppet
- service puppet stop
- sed -i '/init-functions/a\. \/etc\/environment' /etc/init.d/puppet
- puppet agent --test
- service puppet start
As you can see, after installing Puppet, I stop the agent, and add a line to /etc/init.d/puppet to source /etc/environment. Then I start the agent. NOT ideal... but it works!

I don't think . /etc/environment is going to work properly the way cloud-init executes runcmd. Two possible solutions:
Export the variable with the puppet agent command:
export FACTER_tl_role=development && puppet agent --test
If that doesn't work:
Just drop the commands into a user-data script and wire them together as a "multipart input" (described in the cloud-init docs).
The second solution executes the commands as a proper shell script, and would likely fix the problem. If the first works, though, it's easier to do with what you have.

Related

Jenkins - Local checkout - Enable using script console

I am encountering below error. I am able to set the property using System.setProperty("hudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT", "true")
However, the issue still persists. Any pointers?
ERROR: Checkout of Git remote '<path to project folder>' aborted
because it references a local directory, which may be insecure.
You can allow local checkouts anyway by setting the system property
'hudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT' to true.
I found the info I needed and propably helps you too in
https://issues.jenkins.io/browse/JENKINS-68571:
So, follow these steps:
$ sudo systemctl stop jenkins
$ sudo systemctl edit jenkins
[Service]
Environment="JAVA_OPTS=-Dhudson.model.DirectoryBrowserSupport.CSP= -Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true"
$ sudo systemctl restart jenkins
As per https://issues.jenkins.io/browse/JENKINS-68571:
it seems the System Property is read during initialization, thus changing it in Script Console does not change it.
In Script console use property on class directly:
hudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT = true
Note that neither the System Property nor the class property persist across restarts.
A persistent solution depends on how you installed / start Jenkins.
If you are running via java -jar ..., add the system property there (java -Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true -jar ...).
Or, if you installed it using your systems package manager and your system is using systemd:
$ sudo systemctl edit jenkins
[Service]
Environment="JAVA_OPTS=-Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true"
$ sudo systemctl restart jenkins

How to configure docker swarm using jenkins?

I have got an assignment. The assignment is "Write a shell script to install and configure docker swarm(one master/leader and one node) and automate the process using Jenkins." I am new to this technology and finding it difficult to proceed. Can anyone help me in explaining step-by-step process of how to proceed?
#Rajnish Kumar Singh, Have you tried to check resources online? I understand you are very new to this technology, but googling some key words like
what is docker swarm
what is jenkins , etc would definitely helps
Having said that, Basically you need to do below set of steps to complete your assignment
Pre-requisites
2 or more - Ubuntu 20.04 Server
(You can use any linux distros like ubuntu, Redhat etc, But make sure your install and execute commands change accordingly.
Here we need two nodes mainly to configure the master and worker node cluster)
Eg :
manager --- 132.92.41.4
worker --- 132.92.41.5
You can create these nodes in any of public cloud providers like AWS EC2 instances or GCP VMs etc
Next, You need to do below set of steps
Configure Hosts
Install Docker-ce
Docker Swarm Initialization
You can refer this article for more info https://www.howtoforge.com/tutorial/ubuntu-docker-swarm-cluster/
This completes first part of your assignment.
Next, You can create one small shell script and include all those install and configuration commands in that script. Basically shell script is collection of set of linux commands. Instead of running each commands separately , you will run script alone and all set up will be done for you.
You can create small script using touch command
touch docker-swarm-install.sh
Specify proper privileges to script to make it executable
chmod +x docker-swarm-install.sh
Next include all your install + configure commands, which you have used earlier to do docker swarm set up in scripts (You can refer above shared link)
Now, when your script is ready, you can configure this script in jenkins job and whenever jenkins job is run, script will get execute and docker swarm cluster will be created
You need a jenkins server. Jenkins is open source software, you can install it in any of public cloud instance (Aws EC2)
Reference : https://devopsarticle.com/how-to-install-jenkins-on-aws-ec2-ubuntu-20-04/
Next once installation is completed. You need to configure job in jenkins
Reference : https://www.toolsqa.com/jenkins/jenkins-build-jobs/
Add your 'docker-swarm-install.sh' as build step in created job
Reference : https://faun.pub/jenkins-jobs-hands-on-for-the-different-use-cases-devops-b153efb483c7
If all set up is successful and now when you run your jenkins job, your docker swarm cluster must be get created.

puppet is not creating agent_catalog_run.lock file

I have an ansible script that starts puppet agent and then waits for /var/lib/puppet/state/agent_catalog_run.lock file.
I found that this file is not getting created on target machine.
Ansible version is: 1.9.7 and puppet agent version is: 3.8.7
I checked on target linux machine and puppet agent is in running state.
Below is ansible script line:
- name: ensure that puppet lock file is created
wait_for:
path: /var/lib/puppet/state/agent_catalog_run.lock
timeout: 1800
What are things that should be checked in this scenario ?
(Note: No puppet logs have been created.)
The code is simply checking for the wrong file.
As the name suggests, the agent_catalog_run.lock is:
A lock file to indicate that a puppet agent catalog run is currently in progress. The file contains the pid of the process that holds the lock on the catalog run.
In other words, that file will only be there if a Puppet agent run is occurring.
You may want the pidfile instead, which is:
The file containing the PID of a running process. This file is intended to be used by service management frameworks and monitoring systems to determine if a puppet process is still in the process table.
Default: $rundir/${run_mode}.pid
(Where $run_mode would be "agent".)
Note that you can inspect your actual settings using puppet config print, e.g.:
▶ puppet config print pidfile
/Users/alexharvey/.puppetlabs/var/run/main.pid
Yours will be different because mine is running as the non root user on a Mac OS X laptop. Thus, I think you will need to change your code to:
- name: wait for the puppet PID file to be created
wait_for:
path: /var/run/agent.pid
timeout: 1800

vagrant / puppet init.d script reports start when no start occurred

So, struggling with a fairly major problem, i've tried multiple different workarounds to try and get this working but there is something happening between puppet and the actual server that is just boggling my mind.
Basically, I have an init.d script /etc/init.d/rserve which is copied over correctly and when used from the command-line on the server works perfectly (i.e. sudo service rserve start|stop|status), the service returns correct error codes based on testing using echo $? on the different commands.
The puppet service statement is as follows:
service { 'rserve':
ensure => running,
enable => true,
require => [File["/etc/init.d/rserve"], Package['r-base'], Exec['install-r-packages']]
}
When puppet hits this service, it runs it's status method, sees that it isn't running and sets it to running and presumably starts the service, the output from puppet is below:
==> twine: debug: /Schedule[weekly]: Skipping device resources because running on a host
==> twine: debug: /Schedule[puppet]: Skipping device resources because running on a host
==> twine: debug: Service[rserve](provider=upstart): Could not find rserve.conf in /etc/init
==> twine: debug: Service[rserve](provider=upstart): Could not find rserve.conf in /etc/init.d
==> twine: debug: Service[rserve](provider=upstart): Could not find rserve in /etc/init
==> twine: debug: Service[rserve](provider=upstart): Executing '/etc/init.d/rserve status'
==> twine: debug: Service[rserve](provider=upstart): Executing '/etc/init.d/rserve start'
==> twine: notice: /Stage[main]/Etl/Service[rserve]/ensure: ensure changed 'stopped' to 'running'
Now when I actually check for the service using sudo service rserve status or ps aux | grep Rserve the service is in fact NOT running and a quick sudo service rserve start shows the init.d script is working fine and starting rserve as the service starts and is visible with ps aux.
Is there something I'm missing here? I've even tried starting the service by creating a puppet Exec { "sudo service rserve start"} which still reports that it executed successfully but the service is still not running on the server.
tl;dr puppet says a service started when it hasn't and there's seemingly nothing wrong with the init.d script, its exit codes or otherwise.
Update 1
In the comments below you can see I tried isolating the service in it's own test.pp file and running it using puppet apply on the server with the same result.
Update 2
I've now tried creating an .sh file with the command to start Rserve using a separate vagrant provision and can finally see an error. However, the error is confusing as the error does not occur when simply running sudo service rserve start, something in the way that vagrant executes .sh commands, or the user it executes them under is causing an option to be removed from the command inside the init.d script when it's executed.
This error is R and Rserve specific but it is complaining about a missing flag --no-save needing to be passed to R when it is in fact present in the init.d script and being correctly passed when ssh'd into the vagrant box and using the init.d commands.
Update 3
I've managed to get the whole process working at this point, however, it's one of those situations where the steps to get it to work didn't really readily reveal any understanding of why the original problem existed. I'm going to replicate the broken version and see if I can figure out what exactly was going on using one of the methods mentioned in the comments so that I can potentially post an answer up that will help someone out later on. If anyone has insight into why this might have been happening feel free to answer in the meantime however. To clarify the situation a bit, here are some details:
The service's dependencies were installed correctly using puppet
The service used a script in /etc/init.d on ubuntu to start|stop the Rserve service
The software in question is R (r-base) and Rserve (a communication layer between other langs and R)
Running the command sudo service rserve start from the command-line worked as expected
The init.d script returned correct error codes
A service {} block was being used to start the service from puppet
Puppet reported starting the service when the service wasn't started
Adding a provision option to the Vagrantfile for an .sh file containing sudo service rserve start revealed that some arguments in the init.d were being ignored when run by vagrants provisioning but not by a user active on the shell.

Getting a LAMP stack running on a Vagrant VM (under Windows 7 host), full instructions?

I have a Vagrant VM standard issue lucid32.box running. What would the complete instructions be to set up LAMP on this?
I have looked at knife (part of chef) and attempted:
vagrant#lucid32:~$ knife cookbook site install apache2
but got
WARNING: No knife configuration file found
How do I set up a knife configuration file and what should I have in it?
I've been doing a lot of searching online for answers but am overwhelmed by partial solutions that don't explain their starting point/pre-requisites.
Update
I will aim to answer this myself as no-one else seems to want to. Here is my current understanding - I aim to address my unknowns/questions in red later.
OK, I've decided to answer this fully for myself as the original question poster. (Thanks to everyone who contributed prior.)
End-to-end setup of LAMP VM on a Windows 64-bit host using Vagrant and Oracle VirtualBox
I asked this question originally because although there are plenty of instructions and guides on the web, what they don’t seem to do is:
Clearly define a starting point and what the prerequisites are
Give instructions for those, like me, in corporate environments that have a capable Windows machine to host the VM. Instead they assume a Linux-based host machine.
Be clear on where the files being set up are: On the host? On the guest OS? (This is especially difficult to determine if both the host and guest OS are both Linux or Unix-based - the command line snippets shown don’t give clues obviously as they all look the same.)
State which version of Vagrant is used. There are two (2) main versions: API version 1 which is all releases before (but NOT including) v1.1.0. The other is API version 2 - which is releases from v1.1.0 onwards. So the versioning convention is similar to Java. This API version is important as, for example, v1 API scripts simply won't work on API v2 of the Vagrant software unless a clause is put at the beginning of the script to state which version to use.
Personally I think the Vagrant versioning convention could be simpler. NOTE: This guide here is for Vagrant 1. I am told that version 1 has a wide established installed base, while Vagrant 2 was still in draft mid 2013. I therefore like to call version 1 - V1 LTS - Long Term Support - like Ubuntu to show that this is going to be around for a long time yet.
Here is a picture to clarify which API is on which version of the Vagrant software:
For my example setup of using Vagrant here, I would suggest using pre-V1.1.0 (i.e. Vagrant API 1 from the downloads on vagrantup.com) however you ought to be able to use Vagrant 2 API version of the Vagrant software as mentioned above but you'll need to add a 'directive' at the beginning of your scripts to tell Vagrant that they are for Vagrant 1 otherwise the scripts will fail with an error message. TODO: I'll try to get that directive and put it here to help.
(Mitchell Hashimoto, Vagrant creator - please take note of the above for any future editions of your O'Reilly book: Vagrant: Up and Running: http://shop.oreilly.com/product/0636920026358.do)
What these instructions in this answer should do:
Get you a 32-bit Ubuntu Linux OS with a LAMP (Linux OS, Apache web server, MySQL database, PHP) stack running as a Virtual Machine using Oracle VirtualBox on your Windows 7 64-bit machine (or a Mac or Linux machine, but primarily tested on Windows but should work fine on Mac and this solution is meant to be platform-independent). I have tested PHP OK (via standard phpinfo.php file and see that MySQL is running but haven't tested this yet).
Other ways to set up a LAMP stack running on a Vagrant VM
Note: An alternative pretty much out-of-the-box solution for those (like me) who want a LAMP stack with the Drupal open-source content management framework is here: http://drupal.org/project/vagrant
You should be able to follow just my prerequisites below and then download the .zip from the above URL and follow the instructions on there and run vagrant up from the command line to start the VM and wait as it builds and starts (some of this is one-off the first time as once you have the image set up subsequent boots should be faster). You get a lot of other developer stuff 'for free' (i.e. to save you the effort installing them) - like git, drush (I think), and performance profiling tools. Afterwards go to [server address]/install.php to install Drupal. This seems to work well without issue - I've tried it out but not tested it extensively. You might need to disable the install of xhprof if you get an error message - see http://drupal.org/node/1940668 for details.
Another option is to use this configuration tool: https://puphpet.com/
- It's a visual point-and-click method for configuring your Vagrant setup. This works on Vagrant 2 (I think, Update yes, it does, on Vagrant 1.2.2 at least). Update: In fact, I've got this working successfully and based a setup for running Drupal on it locally - see my guide here: https://drupal.org/node/2055947
Update
Here are some other out-of-the-box Vagrant setups that I've found to work well - on Mac and Windows:
https://github.com/mikebell/drupaldev-apache
https://github.com/mikebell/drupaldev-nginx
If you want the Solr search engine locally in your VM as part of your LAMP stack, you may want to look at:
https://github.com/computerminds/parrot
Even though these alternatives are great, my instructions are still of value to help you understand the workings of such setups or if you want a simpler more basic LAMP stack.
Small extras that you need to find out how to do (will try to include them here)
Logging into the machine once set up - this is done via the standard SSH-based login. You will need the free tools putty.exe and puttygen.exe.
At the moment I have not provided how to log in with SSH here but will try to do so in future. You will find references at the end of this answer.
Note that the login will be with the user vagrant.
(After you have followed the setup instructions below) to use the root user you need to 'unlock' the account to be able to reset the password:
Unlock the root account:
vagrant#lucid32:~$ sudo passwd -u root
passwd: password expiry information changed.
Then change the root password:
vagrant#lucid32:~$ sudo passwd root
Enter new UNIX password:
Retype new UNIX password:
passwd: password updated successfully
(The password is not shown as you type.)
Test the new password by logging into root with it:
vagrant#lucid32:~$ su root
Password:
root#lucid32:/home/vagrant#
Credit: https://scottlinux.com/2011/07/22/reset-or-change-user-password-in-linux/
(Article: "Reset or Change User Password in Linux" - This helped me work out how to do it.)
Any errors?
Give it a try - add comments to the answer if you have problems and I will try to fix. See also the troubleshooting at the end.
Future tasks
Currently using Puppet. Do it with Chef instead of Puppet, just to widen the ways of working. Both of these are contenders but have different approaches so I believe: With Puppet I am told that you say what you want and Puppet may make some arbitrary decisions to get you there. Whereas with Chef I believe you define the precise sequence of steps. Again - comment here and correct me if necessary,
Prerequisites for these instructions:
Windows 7 64-bit
Installed VirtualBox
Installed Vagrant
Separate installs of Ruby and Puppet are not required as these appear to come with Vagrant. To be honest, I did install these to fix some problems but found out those problems were something else. So I uninstalled Ruby and Puppet and re-ran (vagrant up etc) and it still works so I assume these extra, separate installs of Ruby and Puppet are not required.
Suggested Vagrant and VirtualBox version combination to use: VirtualBox version 4.2.12 and pre-Vagrant 1.2 (as previously discussed). Certain other combinations could work but I haven't tested those, so am sticking with this combination unless I can see clear benefit of using later versions. One top clear benefit would be speed of provisioning. The combination I state here works for the puphpet.com route to setting up a VM at least which is quite complex, and I would therefore assume should work on my simple setup documented here.
(Credit: These instructions are based on:
http://ox86.tumblr.com/post/23734821654/painless-development-environments-with-virtualbox
...but not an exact copy as they did not work for me.)
The instructions
(Ensure you have the prerequisites above.)
The host setup work is done on your host machine in your Windows user folder, for example for me this is C:\Users\rdavis
mkdir lamp-project
cd lamp-project
mkdir configs
cd ..
cd lamp-project
mkdir manifests
(following from: http://docs.vagrantup.com/v1/docs/getting-started/index.html)
Download the distro install image, in this case Ubuntu Lucid (10.04). This image is effectively equivalent to the install disk (CD or DVD) that you would traditionally use to install an OS on a machine.
C:\Users\rdavis\lamp-project>vagrant box add lucid32 http://files.vagrantup.com/lucid32.box
(By the way, there are several other popular distros on vagrantup.com, but if you want to generate the .box file from a distro .ISO then there is a tool called VeeWee to do that: https://github.com/jedi4ever/veewee)
Initialise it:
C:\Users\rdavis\lamp-project>vagrant init lucid32
(Note, I just used vagrant init when writing up these instructions because I had already initialised lucid32, but for the first time, you will have to do the above command.)
C:\Users\rdavis\lamp-project>vagrant init
A `Vagrantfile` has been placed in this directory. You are now
ready to `vagrant up` your first virtual environment! Please read
the comments in the Vagrantfile as well as documentation on
`vagrantup.com` for more information on using Vagrant.
C:\Users\rdavis\lamp-project>
Edit C:\Users\rdavis\lamp-project\Vagrantfile
- insert the following directly after Vagrant::Config.run do |config|
config.vm.box = "lucid32"
config.vm.provision :puppet do |puppet|
puppet.manifests_path = File.expand_path("../manifests", __FILE__)
end
config.vm.forward_port 80, 8080
config.vm.share_folder "configs", "/configs", File.expand_path("../configs", __FILE__)
So your Vagrantfile should look like:
# -*- mode: ruby -*-
# vi: set ft=ruby :
Vagrant::Config.run do |config|
config.vm.box = "lucid32"
config.vm.provision :puppet do |puppet|
puppet.manifests_path = File.expand_path("../manifests", __FILE__)
end
config.vm.forward_port 80, 8080
config.vm.share_folder "configs", "/configs", File.expand_path("../configs", __FILE__)
# All Vagrant configuration is done here. The most common configuration
# options are documented and commented below. For a complete reference,
# please see the online documentation at vagrantup.com.
# Every Vagrant virtual environment requires a box to build off of.
# config.vm.box = "lucid32"
# (this is already done above, but if you have a box called 'base' which is an Ubuntu lucid32 then you can use: config.vm.box = "base". This info may be helpful if you get error: "The box 'base' could not be found.")
# The url from where the 'config.vm.box' box will be fetched if it
# doesn't already exist on the user's system.
# config.vm.box_url = "http://example.com/path/to/above.box"
# Boot with a GUI so you can see the screen. (Default is headless)
# config.vm.boot_mode = :gui
# Assign this VM to a host-only network IP, allowing you to access it
# via the IP. Host-only networks can talk to the host machine as well as
# any other machines on the same network, but cannot be accessed (through this
# network interface) by any external networks.
# config.vm.network :hostonly, "192.168.33.10"
# Assign this VM to a bridged network, allowing you to connect directly to a
# network using the host's network device. This makes the VM appear as another
# physical device on your network.
# config.vm.network :bridged
# Forward a port from the guest to the host, which allows for outside
# computers to access the VM, whereas host only networking does not.
# config.vm.forward_port 80, 8080
# Share an additional folder to the guest VM. The first argument is
# an identifier, the second is the path on the guest to mount the
# folder, and the third is the path on the host to the actual folder.
# config.vm.share_folder "v-data", "/vagrant_data", "../data"
# Enable provisioning with Puppet stand alone. Puppet manifests
# are contained in a directory path relative to this Vagrantfile.
# You will need to create the manifests directory and a manifest in
# the file base.pp in the manifests_path directory.
#
# An example Puppet manifest to provision the message of the day:
#
# # group { "puppet":
# # ensure => "present",
# # }
# #
# # File { owner => 0, group => 0, mode => 0644 }
# #
# # file { '/etc/motd':
# # content => "Welcome to your Vagrant-built virtual machine!
# # Managed by Puppet.\n"
# # }
#
# config.vm.provision :puppet do |puppet|
# puppet.manifests_path = "manifests"
# puppet.manifest_file = "base.pp"
# end
# Enable provisioning with chef solo, specifying a cookbooks path, roles
# path, and data_bags path (all relative to this Vagrantfile), and adding
# some recipes and/or roles.
#
# config.vm.provision :chef_solo do |chef|
# chef.cookbooks_path = "../my-recipes/cookbooks"
# chef.roles_path = "../my-recipes/roles"
# chef.data_bags_path = "../my-recipes/data_bags"
# chef.add_recipe "mysql"
# chef.add_role "web"
#
# # You may also specify custom JSON attributes:
# chef.json = { :mysql_password => "foo" }
# end
# Enable provisioning with chef server, specifying the chef server URL,
# and the path to the validation key (relative to this Vagrantfile).
#
# The Opscode Platform uses HTTPS. Substitute your organization for
# ORGNAME in the URL and validation key.
#
# If you have your own Chef Server, use the appropriate URL, which may be
# HTTP instead of HTTPS depending on your configuration. Also change the
# validation key to validation.pem.
#
# config.vm.provision :chef_client do |chef|
# chef.chef_server_url = "https://api.opscode.com/organizations/ORGNAME"
# chef.validation_key_path = "ORGNAME-validator.pem"
# end
#
# If you're using the Opscode platform, your validator client is
# ORGNAME-validator, replacing ORGNAME with your organization name.
#
# IF you have your own Chef Server, the default validation client name is
# chef-validator, unless you changed the configuration.
#
# chef.validation_client_name = "ORGNAME-validator"
end
Then, in C:\Users\rdavis\lamp-project\manifests create file default.pp and put in it:
$config_path = "/configs"
$vagrant_base_path = "/vagrant"
Exec { path => "/bin:/usr/bin:/usr/local/bin" }
group { "puppet": ensure => present }
exec { "apt-get update": command => "apt-get update" }
class apache {
exec { "enable-mod_rewrite":
require => Package["apache2"],
before => Service["apache2"],
command => "/usr/sbin/a2enmod rewrite"
}
package { "apache2":
ensure => present
}
service { "apache2":
ensure => running,
require => Package["apache2"]
}
}
class php {
package { "libapache2-mod-php5": ensure => present }
package { "php5": ensure => present }
package { "php5-cli": ensure => present }
package { "php5-dev": ensure => present }
package { "php5-mysql": ensure => present }
package { "php-pear": ensure => present }
exec { "pear upgrade":
command => "/usr/bin/pear upgrade",
require => Package["php-pear"],
}
}
class mysql {
package { "mysql-server":
require => Exec["apt-get update"],
ensure => present,
}
service { "mysql":
enable => true,
ensure => running,
require => Package["mysql-server"],
}
exec { "Set MySQL server root password":
require => Package["mysql-server"],
unless => "/usr/bin/mysqladmin -uroot -proot status",
command => "/usr/bin/mysqladmin -uroot password root",
}
}
include apache
include php
include mysql
(Helpful note (optional), my above versions of Vagrantfile and default.pp (and other Vagrant ancilliary files and folder structure) are available from my GitHub repository, VagrantVMSetups, at: https://github.com/therobyouknow/VagrantVMSetups
- See the justlamp folder - this is the same as the contents of lamp-project used in this answer.)
Then run Vagrant:
C:\Users\rdavis\lamp-project>vagrant up
Note that this can take a while (5-15 minutes) - but bear with it. It should now successfully run a LAMP VM. Then you have finished with the VM in your current work task. If you then keep the VM for use at a later time but shut it down using vagrant halt (rather than vagrant destroy to delete the VM image) then I would expect this delay to be a one-off initial setup time. Subsequent startups of the VM (using vagrant up) should be faster I would think.
Troubleshooting:
Troubleshooting Problem 1: Bad/illegal quotes used - error message seen on host machine after running vagrant up
Background: this happened to me because I pasted in the code snippets from the web page where the instructions came from. The code snippet had open-and-close quotes - which aren’t interpreted as proper quotes by the interpreter/parser that Vagrant uses (or indeed by most script interpreters and compilers I would think.)
Symptom:
output like this:
There is a syntax error in the following Vagrantfile. The syntax error
message is reproduced below for convenience:
C:/Users/rdavis/lamp-project/Vagrantfile:6: invalid multibyte char (US-ASCII)
C:/Users/rdavis/lamp-project/Vagrantfile:6: syntax error, unexpected $end
Or this:
Could not parse for environment production: Could not match ?/configs? at /tmp/vagrant-puppet/manifests/default.pp:1 on node lucid32.hsd1.ca.comcast.net.
The following SSH command responded with a non-zero exit status.
Vagrant assumes that this means the command failed!
Or this:
There was an error executing the following command with VBoxManage:
["list", "hostonlyifs"]
Remedy: use proper double quotes “. Don’t use open-and-closing quotes.
Troubleshooting Problem 2: Following error message on host machine after running vagrant up
←[1;35merr: /Stage[main]/Apache/File[/etc/apache2/sites-enabled/000-default]: Could not evaluate: Could not retrieve information from environment production source(s) file:/configs/000-default at /tmp
/vagrant-puppet/manifests/default.pp:11←[0m
Remedy: you shouldn’t see this - the original script used contained references to a path containing 000-default. I just removed all lines and constructs referring to it.
Troubleshooting Problem 3: PHP files are treated as downloads (download of file occurs in browser) rather than being executed and displayed.
PHP needs enabling on the guest VM machine.
Remedy: you may or may not need to do this.
This tip worked: (to enable PHP and stop the file being seen as a download):
https://serverfault.com/questions/243435/getting-php-to-work-with-apache-to-run-php-files-through-browser
vagrant#lucid32:/etc/php5/cli$ a2enmod php5
Module php5 already enabled
vagrant#lucid32:/etc/php5/cli$ sudo apache2ctl restart
Another tip:
PHP needs enabling, suggestion in:
http://galleryproject.org/node/55011
is:
edit php.ini
These are shared extensions (.so files). You need to enable them in php.ini and then restart PHP.
Myself, I didn’t need to edit php.ini after all. By the way, this is at: /etc/php5/cli/php.ini for this lucid32 VM.
Troubleshooting Problem 4: Addressing the VirtualBox additions warning message about version mismatch
[default] The guest additions on this VM do not match the install version of
VirtualBox! This may cause things such as forwarded ports, shared
folders, and more to not work properly. If any of those things fail on
this machine, please update the guest additions and repackage the
box.
Guest Additions Version: 4.2.0
VirtualBox Version: 4.2.4
Not a problem it seems (it doesn’t stop the VM from running successfully), but if you wish to address it:
http://automation.binarysage.net/?p=1198
https://unix.stackexchange.com/questions/58216/automate-installation-of-virtualbox-guest-additio
ns-via-command-line
https://serverfault.com/questions/243435/getting-php-to-work-with-apache-to-run-php-files-through-browser
(for Linux-like users: http://www.pauloamgomes.net/blog/installing-vagrant)
Troubleshooting problem 5: The box 'base' could not be found." error message seen after running vagrant up.
Remedy? Check the line containing the statement config.vm.box = etc. in your Vagrantfile (see my example Vagrantfile above) to ensure that it is referring to a Vagrant box (the OS install image) that actually exists on your system - issue command vagrant box list to see what boxes you have.
If you have followed my instructions then you should have the lucid32 box. Make sure that there are no extraneous config.vm.box = etc. statements in your Vagrantfile. Confession: there was an extraneous config.vm.box = "base" in my Vagrantfile when actually a few lines above, config.vm.box = "lucid32" was already done. I have now corrected this.
FAQ
Q: What is a Vagrant box? A: Can be considered equivalent to an OS install disk in that it is the basis, the starting point for a VM - it’s the OS. It’s a binary file.
Q: What is a Vagrant package? A: A snapshot of the VM plus the configuration that Vagrant has performed from the VagrantFile provides a self-contained means to distribute the setup to other people.
References:
General Vagrant resources:
What exactly do the Vagrant commands do?
- nice description
http://community.opscode.com/questions/81
http://deanstrezovski.com/setting-up-a-cagrant-lamp-stack/
http://www.jasongrimes.org/2012/06/managing-lamp-environments-with-chef-vagrant-and-ec2-1-of-3/
How do I associate a Vagrant project directory with an existing VirtualBox VM?
http://docs.vagrantup.com/v1/docs/getting-started/index.html
More on Vagrant Boxes:
http://docs.vagrantup.com/v1/docs/boxes.html
Where is Vagrant saving changes to the VM?
SSH key-based logins (logging into the VM box externally - i.e. from the host machine or from another machine):
http://www.howtoforge.com/ssh_key_based_logins_putty_p2
http://docs.vagrantup.com/v1/docs/getting-started/ssh.html
http://en.wikipedia.org/wiki/Ssh-agent
For Windows SSH-based login to the VM:
PuTTY: a free telnet/ssh client
www.chiark.greenend.org.uk/~sgtatham/putty/
puttygen:
www.chiark.greenend.org.uk/~sgtatham/putty/download.html
Version history/updates of this answer
Signposting and headings clean-up
Added running vagrant up and that it can take a while
Added how to set the root password in the VM
Added missing step to download and init the lucid32 box (equivalent to the install disk)
Added link to my https://github.com/therobyouknow/VagrantVMSetups GitHub repo that contains the Vagrant config setup for this answer - for convenience.
Altered Vagrantfile to remove the extraneous config.vm.box = "base" when actually a few lines above, config.vm.box = "lucid32" was already done. This will help if you encounter the error The box 'base' could not be found." Also added a new troubleshooting item explaining the same.
Added alternative out-of-the-box solution for those wanting a Drupal-based LAMP VM: http://drupal.org/project/vagrant see more notes above on this.
2013-07-10: slight grammar adjustment to reasons for writing this guide. Updated that the Vagrant book from O'Reilly is now published. Added link to https://puphpet.com/ - online Vagrant configurator script generator (very nice!). Added link to VeeWee tool which is used to generate a Vagrant .box file from any .ISO Linux distribution (standard install disc)
2013-10-14 Updated "what they don't seem to do" bullets with points on which Version of Vagrant - this guide uses Vagrant 1 (and why). Stated Vagrant 2 used with puphpet.com also link to my documentation using puphpet.com to set up a Vagrant VM for Drupal.
2013-10-21 Updated to state combination of VirtualBox version and Vagrant to use: VirtualBox version 4.2.12 and Vagrant 1.2.2. Certain other combinations could work but I haven't test those, so am sticking with this combination unless I can see clear benefit of using later versions. One top clear benefit would be speed of provisioning. Put heading on other approaches to Vagrant VM section. Updated to say this and other solutions are platform independent and should work on PC, Mac or Linux.
2013-10-23 updates on what Vagrant version to use for this guide (i.e. pre v1.2 (that's pre Vagrant 2)) and for another approach, puphpet.com (v1.2.2 - which by contrast is a Vagrant 2 release.)
2013-12-03 corrected notes of Vagrant API versioning and what API version is in which Vagrant software version. Added some more alternative, comprehensive Vagrant setups.
In your VM, you need to run:
$knife configure
Accept all the defaults.
After you have run this, there will be a configuration file in your ~/.chef/knife.rb.
As for your diagram:
The vagrant folder contains the Vagrantfile for that project. The actual .ovf and .vmdk files, along with another Vagranfile, exists in /%USERPROFILE%/.vagrant.d/
The Vagranfile is the configuration file for Vagrant and exists in multiple places with a set order of precedence. The Vagranfile in your project folder takes precedence: Vagrantfile documentation.
Everything can be from localhost, including setting up a more complex Vagrant project with multiple VMs, as such.
EDIT: to make it clear that the 'knife configure' cmd should be run in the VM and to remove a spurrious Windows path reference.

Resources