-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvagrant-virtualbox-puppet-yet-another-boring-explanation.html
551 lines (460 loc) · 50 KB
/
vagrant-virtualbox-puppet-yet-another-boring-explanation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Vagrant, VirtualBox, Puppet, yet another boring explanation</title>
<link rel="stylesheet" href="http://www.piotrdeszynski.com/theme/css/main.css" />
<link href="http://www.piotrdeszynski.com/feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Yet another boring programmer's blog Atom Feed" />
<!--[if IE]>
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body id="index" class="home">
<a href="https://github.com/piteer1">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub" />
</a>
<header id="banner" class="body">
<h1><a href="http://www.piotrdeszynski.com/">Yet another boring programmer's blog </a></h1>
<nav><ul>
<li><a href="http://www.piotrdeszynski.com/category/oop.html">OOP</a></li>
<li class="active"><a href="http://www.piotrdeszynski.com/category/misc.html">Misc</a></li>
<li><a href="http://www.piotrdeszynski.com/category/javascript.html">JavaScript</a></li>
<li><a href="http://www.piotrdeszynski.com/category/about.html">About</a></li>
</ul></nav>
</header><!-- /#banner -->
<section id="content" class="body">
<article>
<header>
<h1 class="entry-title">
<a href="http://www.piotrdeszynski.com/vagrant-virtualbox-puppet-yet-another-boring-explanation.html" rel="bookmark"
title="Permalink to Vagrant, VirtualBox, Puppet, yet another boring explanation">Vagrant, VirtualBox, Puppet, yet another boring explanation</a></h1>
</header>
<div class="entry-content">
<footer class="post-info">
<abbr class="published" title="2012-11-10T20:00:00">
sob 10 listopada 2012
</abbr>
<address class="vcard author">
By <a class="url fn" href="http://www.piotrdeszynski.com/author/piotr-deszynski.html">Piotr Deszyński</a>
</address>
<p>In <a href="http://www.piotrdeszynski.com/category/misc.html">Misc</a>. </p>
<p>tags: <a href="http://www.piotrdeszynski.com/tag/vagrant.html">Vagrant</a><a href="http://www.piotrdeszynski.com/tag/virtualbox.html">VirtualBox</a><a href="http://www.piotrdeszynski.com/tag/puppet.html">Puppet</a><a href="http://www.piotrdeszynski.com/tag/development.html">Development</a></p>
</footer><!-- /.post-info --> <p>How many times in your career you heard from other programmers in your team: <em>"For me it works"</em> while developing some functionality. It happen to me really often. Why does it happen? 99% of the cases it's the difference between environments on which app was run. By myself, I install huge amount of libs on my system not relevant to current project and I forget about them really often having a mess in my personal system. I think, lots of people does the same.</p>
<p>Coming back to the previously stated problem, how to solve it? One of the possible approaches might be using <strong>Continuous Integration</strong> for that, by creating for e.g. unstable, un-reviewed branch and setupping CI to make builds based on it. Even if this will work then still it's not optimal solution, because it forces you to push unstable code to repository. Additionally you have to schedule new build and wait for the results.</p>
<p>Much better approach would be having during the development a way to ensure that everybody have the same environment and as close as it's possible similar to production one. Answer for all and even more might be <a href="http://vagrantup.com" title="Vagrant home page"><strong>Vagrant!</strong></a>.</p>
<p><strong>Vagrant</strong> uses <strong>VirtualBox</strong> to build for you a virtual machine ready for work. The main advantage of it is it's simplicity to run it. As manual says to start a VM it's enough</p>
<div class="highlight"><pre>vagrant box add lucid32 http://files.vagrantup.com/lucid32.box
vagrant init lucid32
vagrant up
</pre></div>
<p>This will download you a box (it's a base image of a system) and add it to system globally, initialize it (it create for you file named <strong>Vagrantfile</strong>) in current directory and run VirtualBox. This VM already sees the folder in which you ran these commands, so all the files in your project are already accessible. What does it give you? If you ran a server inside a VM it will be able to read all the necessary files out of the box!
But this was just easiest example, this server does not do too much other that just running. Imagine now that we need running server with PHP support, how to get it?</p>
<p>Again one of the approaches would be connecting to this VM and installing all necessary libs (using my beloved Debian's apt-get). It's not the best solution for many reasons:</p>
<ul>
<li>People might install different libraries and forget what did they install.</li>
<li>To have the same VM you would have to add whole image to your version control system. These images are big, imagine that with each lib install you have to push it. This is Madness!</li>
<li>How to manage conflicts when two developers install some other libraries at the same time and there's a conflict on this file?</li>
</ul>
<p>When you use <strong>Vagrant</strong> you do not install this way any necessary libraries. Vagrant uses provisioning system for that. You can choose between <a href="http://www.opscode.com/chef/"><strong>Chef</strong></a> and <a href="http://puppetlabs.com"><strong>Puppet</strong></a>. You define in special file what kind of libraries and actions have to be made on a server to setup it according to your needs. I think it'll be easier while trying to explain it using an example.</p>
<h2>A long Puppet example</h2>
<p>Let's assume that we have web project in that's written PHP. For that we will need a web server and a PHP installation. For that let's choose <em>Nginx</em> as a server and <em>php-fpm</em>. All puppet files will be in project root (<strong>not</strong> document root) in <em>private/puppet</em> folder. All files for Puppet have to be put in correct place in directory structure which should look like that:</p>
<div class="highlight"><pre><span class="n">manifests</span>
<span class="err">#</span><span class="n">here</span> <span class="n">goes</span> <span class="n">all</span> <span class="n">top</span> <span class="n">directory</span> <span class="n">manifests</span> <span class="k">for</span> <span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.</span> <span class="n">production</span> <span class="n">setup</span> <span class="n">file</span> <span class="p">(</span><span class="n">file</span> <span class="n">should</span> <span class="n">end</span> <span class="n">with</span> <span class="p">.</span><span class="n">pp</span> <span class="n">extension</span> <span class="n">here</span><span class="p">)</span>
<span class="n">modules</span>
<span class="err">#</span><span class="n">here</span> <span class="n">go</span> <span class="n">all</span> <span class="n">modules</span> <span class="n">which</span> <span class="n">can</span> <span class="n">represent</span> <span class="k">for</span> <span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.</span> <span class="n">the</span> <span class="n">way</span> <span class="n">how</span> <span class="n">apache</span> <span class="n">should</span> <span class="n">be</span> <span class="n">initialized</span>
<span class="n">module</span>
<span class="n">manifests</span>
<span class="n">init</span><span class="p">.</span><span class="n">pp</span> <span class="err">#</span><span class="n">additional</span> <span class="n">module</span> <span class="n">manifets</span><span class="p">,</span> <span class="n">it</span><span class="err">'</span><span class="n">s</span> <span class="n">important</span> <span class="n">that</span> <span class="n">main</span> <span class="n">module</span> <span class="n">file</span> <span class="n">is</span> <span class="n">named</span> <span class="n">init</span><span class="p">.</span><span class="n">pp</span>
<span class="n">files</span>
<span class="err">#</span><span class="n">any</span> <span class="n">files</span> <span class="n">used</span> <span class="n">by</span> <span class="n">module</span>
<span class="n">templates</span>
<span class="err">#</span><span class="n">any</span> <span class="n">templates</span> <span class="n">used</span> <span class="n">by</span> <span class="n">module</span><span class="p">,</span> <span class="n">I</span> <span class="n">will</span> <span class="n">use</span> <span class="n">a</span> <span class="n">template</span> <span class="k">for</span> <span class="n">virtual</span> <span class="n">host</span> <span class="n">definition</span>
</pre></div>
<p>Ok, so let's prepare firstly production environment. For that I will create such a directory structure:</p>
<div class="highlight"><pre><span class="n">manifests</span>
<span class="n">production</span><span class="p">.</span><span class="n">pp</span>
<span class="n">development</span><span class="p">.</span><span class="n">pp</span>
<span class="n">modules</span>
<span class="n">php</span><span class="o">-</span><span class="n">fpm</span>
<span class="n">php</span><span class="o">-</span><span class="n">devel</span>
<span class="n">nginx</span>
<span class="n">users</span>
</pre></div>
<p>And an initialization manifest</p>
<div class="highlight"><pre><span class="c"># private/puppet/manifests/production.pp</span>
<span class="k">class</span> <span class="na">production</span><span class="o">-</span><span class="na">init</span> <span class="p">(</span><span class="nv">$page)</span> <span class="p">{</span>
<span class="k">exec</span> <span class="p">{</span> <span class="s">'apt-get update'</span><span class="p">:</span>
<span class="na">command</span> <span class="o">=></span> <span class="s">'/usr/bin/apt-get update'</span><span class="p">,</span>
<span class="p">}</span><span class="c"></span>
<span class="c"> #create a webadmin user</span>
<span class="na">users</span><span class="p">::</span><span class="na">add_user</span> <span class="p">{</span><span class="s">'webadmin'</span><span class="p">:</span>
<span class="na">uid</span> <span class="o">=></span> <span class="mi">500</span>
<span class="p">}</span>
<span class="k">include</span> <span class="na">php</span><span class="o">-</span><span class="na">fpm</span>
<span class="k">class</span> <span class="p">{</span><span class="s">'nginx'</span><span class="p">:</span>
<span class="na">page</span> <span class="o">=></span> <span class="nv">$page,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>Let's explain what's happening here.</p>
<div class="highlight"><pre><span class="n">class</span> <span class="n">production</span><span class="o">-</span><span class="n">init</span> <span class="p">(</span><span class="err">$</span><span class="n">page</span><span class="p">)</span>
</pre></div>
<p>This is Puppet class definition. I've called production-init, so as the name said it's responsible for whole production initialization. This class get's one $page parameter which is the page domain name. This is not normally necessary, but I wanted to be able to easily create other pages without making copy&paste of Puppet manifests. Let's go further:</p>
<div class="highlight"><pre><span class="n">exec</span> <span class="p">{</span> <span class="err">'</span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span><span class="err">'</span><span class="o">:</span>
<span class="n">command</span> <span class="o">=></span> <span class="err">'</span><span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">bin</span><span class="o">/</span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span><span class="err">'</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<p>Exec task just executes command on server (our VM). This will just update repositories before starting any installations. Important thing in exec is that commands have to have <strong>full path to executable</strong>!</p>
<p>In most of the cases while running webserver on production environment you run it in different user (webadmin), so also let's create one not to have later some permission problems on a different machine, when on ours it'll be working ok (for e.g. with cache folder).</p>
<div class="highlight"><pre><span class="cp">#create a webadmin user</span>
<span class="n">users</span><span class="o">::</span><span class="n">add_user</span> <span class="p">{</span><span class="err">'</span><span class="n">webadmin</span><span class="err">'</span><span class="o">:</span>
<span class="n">uid</span> <span class="o">=></span> <span class="mi">500</span>
<span class="p">}</span>
</pre></div>
<p>Here we called <strong>defined resource type</strong>. If you have good eyesight you saw that previously class was used (production-init). Defined types and classes are similar, but they have one difference. Classes are singletons and any call will Puppet to raise an error.</p>
<p>'users::add_user' means: call add_user from users module. This implies that there is an add_user.pp file in a path:</p>
<div class="highlight"><pre><span class="n">modules</span><span class="o">/</span><span class="n">users</span><span class="o">/</span><span class="n">manifests</span><span class="o">/</span>
</pre></div>
<p>Last parts are calls to <em>php-fpm</em> and <em>nginx</em> classes. You can see the difference how they're called. Why like that? It's because <em>php-fpm</em> is a class without any parameters, so it's allowed to use shorter <strong>include</strong> version.</p>
<div class="highlight"><pre><span class="n">include</span> <span class="n">php</span><span class="o">-</span><span class="n">fpm</span> <span class="err">#</span> <span class="o">===</span> <span class="n">class</span> <span class="p">{</span><span class="err">'</span><span class="n">php</span><span class="o">-</span><span class="n">fpm</span><span class="err">'</span><span class="o">:</span> <span class="p">}</span>
</pre></div>
<p>You have to remember that there is <strong>no possibility</strong> to call a class with a param(s) with include!</p>
<h2>Resource add_user</h2>
<p>Definition of <em>add_user</em> looks as follows:</p>
<div class="highlight"><pre><span class="c">#private/puppet/modules/users/manifests/user_add.pp</span>
<span class="k">define</span> <span class="na">users</span><span class="p">::</span><span class="na">add_user</span> <span class="p">(</span> <span class="nv">$username</span> <span class="o">=</span> <span class="nv">$title,</span> <span class="nv">$uid</span> <span class="p">)</span> <span class="p">{</span>
<span class="k">user</span> <span class="p">{</span> <span class="nv">$username:</span>
<span class="na">comment</span> <span class="o">=></span> <span class="s">"Automatically generated by puppet"</span><span class="p">,</span>
<span class="na">shell</span> <span class="o">=></span> <span class="s">"/bin/bash"</span><span class="p">,</span>
<span class="na">uid</span> <span class="o">=></span> <span class="nv">$uid,</span>
<span class="na">managehome</span> <span class="o">=></span> <span class="k">true</span>
<span class="p">}</span>
<span class="na">group</span> <span class="p">{</span> <span class="nv">$username:</span>
<span class="na">gid</span> <span class="o">=></span> <span class="nv">$uid,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">User</span><span class="p">[</span><span class="nv">$username]</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">"/home/${username}/"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">directory</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">group</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">mode</span> <span class="o">=></span> <span class="mi">750</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="p">[</span> <span class="k">User</span><span class="p">[</span><span class="nv">$username],</span> <span class="na">Group</span><span class="p">[</span><span class="nv">$username]</span> <span class="p">]</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">"/home/${username}/.ssh"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">directory</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">group</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">mode</span> <span class="o">=></span> <span class="mi">700</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">File</span><span class="p">[</span><span class="s">"/home/${username}/"</span><span class="p">]</span>
<span class="p">}</span><span class="c"></span>
<span class="c"> # now make sure that the ssh key authorized files is around</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">"/home/${username}/.ssh/authorized_keys"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">group</span> <span class="o">=></span> <span class="nv">$username,</span>
<span class="na">mode</span> <span class="o">=></span> <span class="mi">600</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">File</span><span class="p">[</span><span class="s">"/home/${username}/"</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>This code creates an user and a group with the same name. Additionally checks if home this user has home folder, <em>.ssh</em> fodler, and <em>authorized_keys</em> file.</p>
<p>There are still few things that have to be explained.</p>
<div class="highlight"><pre><span class="n">define</span> <span class="n">users</span><span class="o">::</span><span class="n">add_user</span> <span class="p">(</span> <span class="err">$</span><span class="n">username</span> <span class="o">=</span> <span class="err">$</span><span class="n">title</span><span class="p">,</span> <span class="err">$</span><span class="n">uid</span> <span class="p">)</span> <span class="p">{</span>
</pre></div>
<p>This one defines add_user 'routine', which can be invoked many times (for e.g. you don't want to create two instances of <em>apache</em> so it will be a <em>class</em> not a resource type). This resource has two params</p>
<ul>
<li>$username that defaults to $title ($title is a special variable in <em>Puppet</em>, it's always present and it's a first 'param', for e.g. <em>user { 'webadmin': }</em>, here <em>'webadmin'</em> is a title of resource user).</li>
<li>$uid which will be created user uid.</li>
</ul>
<p>In <em>Puppet</em> there is a possibility to define requirements for each resources. The simplest example will be group creation</p>
<div class="highlight"><pre><span class="na">group</span> <span class="p">{</span> <span class="nv">$username:</span>
<span class="na">gid</span> <span class="o">=></span> <span class="nv">$uid,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">User</span><span class="p">[</span><span class="nv">$username]</span>
<span class="p">}</span>
</pre></div>
<p>Here group with $username name is created. But to create this grup it's required that previously user with the same name was also created. Thanks to it, if for some reason user was not created, then the creation of group will not be made at all, because of not satisfied dependencies.</p>
<p>Other important part is that Puppet is able to <strong>evaluate variables in a string</strong>, this is done by putting variable in brackets with dollar sign in front (to be honest it is enough to put $var, but according to Puppet standards brackets should be also there):</p>
<div class="highlight"><pre>require => File["/home/<span class="cp">${</span><span class="n">username</span><span class="cp">}</span>/"]
</pre></div>
<p>I will skip rest of the code in add_user, it should be self explanatory.</p>
<h2>php-fpm installation</h2>
<p>Code for <em>php-fpm</em> looks as follows:</p>
<div class="highlight"><pre><span class="k">class</span> <span class="na">php</span><span class="o">-</span><span class="na">fpm</span> <span class="p">{</span>
<span class="k">package</span> <span class="p">{</span> <span class="s">'php5-fpm'</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Exec</span><span class="p">[</span><span class="s">'apt-get update'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">package</span> <span class="p">{</span> <span class="s">"php5-mysql"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">package</span> <span class="p">{</span> <span class="s">"php5-curl"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">package</span> <span class="p">{</span> <span class="s">"php5-xcache"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">service</span> <span class="p">{</span> <span class="s">'php5-fpm'</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">running</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>Let's say what's happening here.</p>
<div class="highlight"><pre><span class="n">class</span> <span class="n">php</span><span class="o">-</span><span class="n">fpm</span> <span class="p">{</span>
</pre></div>
<p>This is a <em>php-fpm</em> class definition without any params. This class just install some of the PHP5 packages with <strong>PHP5 FPM</strong> itself.</p>
<div class="highlight"><pre><span class="n">package</span> <span class="p">{</span> <span class="err">'</span><span class="n">php5</span><span class="o">-</span><span class="n">fpm</span><span class="err">'</span><span class="o">:</span>
<span class="n">ensure</span> <span class="o">=></span> <span class="n">present</span><span class="p">,</span>
<span class="n">require</span> <span class="o">=></span> <span class="n">Exec</span><span class="p">[</span><span class="err">'</span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span><span class="err">'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
<p>This installs <em>php5-fpm</em>, only interesting part here it's that we want to ensure that we're installing the newest possible package in repositories. For that it's required that command <strong>apt-get update</strong> finished successfully. </p>
<div class="highlight"><pre><span class="k">package</span> <span class="p">{</span> <span class="s">"php5-xcache"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'php5-fpm'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
<p>I will describe one more package as an example. The code above install <em><em>php5 xcache</em> extension. What's interesting here it's the notify part. It tells Puppet that, he has to notify </em>php5 fpm* service that new package was installed and it has to load it (do not mistake it with creating necessary ini files - it doesn't do that, it only informs that it should make reload/restart). Puppet knows how to notify most common services out of the box (for e.g. if it needs to be restarted or reload will be enough).</p>
<h2>The last step - Nginx</h2>
<p>Nginx installation will be defined in three separate files. Let's start with first one - virtual host definition</p>
<div class="highlight"><pre><span class="c">#private/puppet/modules/nginx/manifests/virtual-host.pp</span>
<span class="k">class</span> <span class="na">nginx</span><span class="p">::</span><span class="na">virtual</span><span class="o">-</span><span class="k">host</span> <span class="p">(</span><span class="nv">$page,</span> <span class="nv">$template</span> <span class="o">=</span> <span class="s">'default'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">"/home/virtual/${page}"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="s">"directory"</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="s">"webadmin"</span><span class="p">,</span>
<span class="na">group</span> <span class="o">=></span> <span class="s">"webadmin"</span><span class="p">,</span>
<span class="na">mode</span> <span class="o">=></span> <span class="mi">755</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">User</span><span class="p">[</span><span class="s">'webadmin'</span><span class="p">]</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">"/home/virtual/${page}/public"</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">directory</span><span class="p">,</span>
<span class="na">mode</span> <span class="o">=></span> <span class="s">'0755'</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="s">'webadmin'</span><span class="p">,</span>
<span class="na">group</span> <span class="o">=></span> <span class="s">'webadmin'</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">File</span><span class="p">[</span><span class="s">"/home/virtual/${page}"</span><span class="p">]</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">'nginx-site-available'</span><span class="p">:</span>
<span class="na">path</span> <span class="o">=></span> <span class="s">"/etc/nginx/sites-available/${page}"</span><span class="p">,</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">file</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="na">group</span> <span class="o">=></span> <span class="na">root</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="na">root</span><span class="p">,</span>
<span class="na">content</span> <span class="o">=></span> <span class="k">template</span><span class="p">(</span><span class="s">"nginx/${template}"</span><span class="p">),</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">'/etc/nginx/sites-enabled/${page}'</span><span class="p">:</span>
<span class="na">target</span> <span class="o">=></span> <span class="s">"/etc/nginx/sites-available/${page}"</span><span class="p">,</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">link</span><span class="p">,</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="na">require</span> <span class="o">=></span> <span class="p">[</span>
<span class="k">File</span><span class="p">[</span><span class="s">'nginx-site-available'</span><span class="p">],</span>
<span class="k">File</span><span class="p">[</span><span class="s">'default-nginx-disable'</span><span class="p">],</span>
<span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="p">],</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>As always let's start from the beginning to say a few words about this code.</p>
<div class="highlight"><pre><span class="n">class</span> <span class="n">nginx</span><span class="o">::</span><span class="n">virtual</span><span class="o">-</span><span class="n">host</span> <span class="p">(</span><span class="err">$</span><span class="n">page</span><span class="p">,</span> <span class="err">$</span><span class="n">template</span> <span class="o">=</span> <span class="err">'</span><span class="k">default</span><span class="err">'</span><span class="p">)</span> <span class="p">{...}</span>
</pre></div>
<p>This one defines class virtual host. This class has two params where on has a default value. In our case <em>$page</em> param is a domain for which virtual host is created. The <em>$template</em> variable defines which template to use for virtual host definition. How to call this class? It's done by such a call:</p>
<div class="highlight"><pre><span class="k">class</span> <span class="p">{</span><span class="s">'nginx::virtual-host'</span><span class="p">:</span>
<span class="na">page</span> <span class="o">=></span> <span class="s">'www.example.com'</span>
<span class="p">}</span>
</pre></div>
<p>Here I've shown how you can call this class with a param with default value, because I omitted the $template param.</p>
<p>I didn't say earlier</p>
<p>You can ask, why this way, why nginx::virtual-host is a class not a defined resource type.
This question is good. For you define might be much better. I've used here class because during development of a project I use only one VM per domain. If you plan having multiple virtual hosts on one VM, then make it define!</p>
<h2>Templates</h2>
<p>The only other interesting part in previous definition is part with virtual host file.</p>
<div class="highlight"><pre><span class="k">file</span> <span class="p">{</span> <span class="s">'nginx-site-available'</span><span class="p">:</span>
<span class="na">path</span> <span class="o">=></span> <span class="s">"/etc/nginx/sites-available/${page}"</span><span class="p">,</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">file</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="na">group</span> <span class="o">=></span> <span class="na">root</span><span class="p">,</span>
<span class="na">owner</span> <span class="o">=></span> <span class="na">root</span><span class="p">,</span>
<span class="na">content</span> <span class="o">=></span> <span class="k">template</span><span class="p">(</span><span class="s">"nginx/${template}"</span><span class="p">),</span><span class="c"> # <- load a template file in a path: nginx/templates/${template}</span>
<span class="p">}</span>
</pre></div>
<p>This is the first time I've used here a template. Here I've put a virtual host definition in such a file and it looks as follows</p>
<div class="highlight"><pre>server <span class="p">{</span>
listen <span class="m">80</span><span class="p">;</span>
server_name <span class="o"><%= @page %></span><span class="p">;</span> <span class="c1"># <- put here value of $page variable</span>
root <span class="o">/</span>home<span class="o">/</span>virtual<span class="o">/<%= @page %>/</span>public<span class="p">;</span>
index index.php<span class="p">;</span>
location <span class="o">/</span> <span class="p">{</span>
try_files <span class="o">$</span>uri <span class="o">$</span>uri<span class="o">/</span> <span class="o">/</span>index.php<span class="o">?$</span>args<span class="p">;</span>
<span class="p">}</span>
location <span class="o">~</span> \.php<span class="o">$</span> <span class="p">{</span>
fastcgi_pass <span class="m">127.0.0.1</span><span class="o">:</span><span class="m">9000</span><span class="p">;</span>
fastcgi_index index.php<span class="p">;</span>
include fastcgi_params<span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>As you can see it's really simple definition, where <strong>Nginx</strong> will route all the addresses into index.php file. The important part here is that, we declare variables in templates slightly different. You put them between:</p>
<div class="highlight"><pre><span class="cp"><%=</span> <span class="vi">@variable</span> <span class="cp">%></span><span class="x"></span>
</pre></div>
<p>The question that you can ask right now, is how we pass a value to a template? It's simple. <strong>All the variables in parent scope are available in a template!</strong>. What does it mean in the end? If we have a variable named $variable in a class/define, then this variable has to have exactly the same name. To access this variable you would put in template <%= @variable %></p>
<h2>Nginx itself (phew, it was long..)</h2>
<p>Let's go to Nginx installation itself. I've done it by this Puppet manifest:</p>
<div class="highlight"><pre><span class="c">#private/puppet/modules/nginx/manifests/init.pp</span>
<span class="k">class</span> <span class="na">nginx</span> <span class="p">(</span><span class="nv">$page,</span> <span class="nv">$template</span> <span class="o">=</span> <span class="s">'default'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">package</span> <span class="p">{</span> <span class="s">'nginx'</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Exec</span><span class="p">[</span><span class="s">'apt-get update'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">service</span> <span class="p">{</span> <span class="s">'nginx'</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">running</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="p">}</span>
<span class="k">class</span> <span class="p">{</span> <span class="s">'nginx::virtual-host'</span><span class="p">:</span>
<span class="na">page</span> <span class="o">=></span> <span class="nv">$page,</span>
<span class="k">template</span> <span class="o">=></span> <span class="nv">$template,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">]</span>
<span class="p">}</span>
<span class="k">file</span> <span class="p">{</span> <span class="s">'default-nginx-disable'</span><span class="p">:</span>
<span class="na">path</span> <span class="o">=></span> <span class="s">"/etc/nginx/sites-enabled/default"</span><span class="p">,</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">absent</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="k">notify</span> <span class="o">=></span> <span class="k">Service</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>This code:</p>
<ul>
<li>installs <strong>nginx</strong> package</li>
<li>ensures that nginx is up and running</li>
<li>adds one virtual host</li>
<li>at the end it ensures also that there is no default virtual host present</li>
</ul>
<h2>What's next?</h2>
<p>Ok, so we defined all necessary manifests and templates, but we need to still define an entry point. At the beginning I've defined a <strong>production-init</strong> class. To be honest all the contents of this class can be removed from it and just called one by one. I did it this way, because I have one more file <strong>development.pp</strong> which calls this class. It's done this way because it allows me to use this manifest on production, but also I can make small alterations to environment for a dev (for example for a dev you might install additionally xdebug, change error_reporting to E_STRICT & E_ALL etc.)</p>
<p>So <em>development.pp</em> file might be looking like:</p>
<div class="highlight"><pre><span class="c">#private/puppet/manifests/development.pp</span>
<span class="k">import</span> <span class="s">"production-init"</span>
<span class="k">class</span> <span class="p">{</span><span class="s">'production-init'</span><span class="p">:</span> <span class="na">page</span> <span class="o">=></span> <span class="s">'example.com'</span><span class="p">}</span><span class="c"></span>
<span class="c">#install development packages, set additional development settings</span>
<span class="err">...</span>
</pre></div>
<h3>Setup Vagrantfile</h3>
<p>Now really last thing - we have to show Vagrant where our manifest file is and which one to use. When you'll open this <em>Vagrantfile</em> in root of your project you should add:</p>
<div class="highlight"><pre><span class="n">config</span><span class="p">.</span><span class="n">vm</span><span class="p">.</span><span class="n">provision</span> <span class="o">:</span><span class="n">puppet</span><span class="p">,</span> <span class="o">:</span><span class="n">module_path</span> <span class="o">=></span> <span class="s">"private/puppet/modules"</span><span class="p">,</span> <span class="o">:</span><span class="n">options</span> <span class="o">=></span> <span class="s">"--verbose --debug"</span> <span class="k">do</span> <span class="o">|</span><span class="n">puppet</span><span class="o">|</span>
<span class="n">puppet</span><span class="p">.</span><span class="n">manifests_path</span> <span class="o">=</span> <span class="s">"private/puppet/manifests"</span>
<span class="n">puppet</span><span class="p">.</span><span class="n">manifest_file</span> <span class="o">=</span> <span class="s">"development.pp"</span>
<span class="n">end</span>
<span class="n">config</span><span class="p">.</span><span class="n">vm</span><span class="p">.</span><span class="n">share_folder</span> <span class="s">"app-root"</span><span class="p">,</span> <span class="s">"/home/virtual/example.com"</span><span class="p">,</span> <span class="s">"."</span>
</pre></div>
<p>Now you should be able to run</p>
<div class="highlight"><pre><span class="n">vagrant</span> <span class="n">reload</span>
</pre></div>
<p>This should restart VM and run Puppet on it.</p>
<h2>Closing comments</h2>
<p>This example shows how to run a <strong>Nginx</strong> server with PHP using minimal configuration. Probably it might be not enough for you. You might need for example a database on VM (which I don't prefer to have there, I like more to have a real DB server accessible by everybody).</p>
<p>After all work is done and development environment prepared, it can be easily shared between all devs using for example Git and adding all files.</p>
<p>There's one important thing before you'll start developing on this VM. I <strong>strongly suggest enabling NFS!</strong> Shared folder build in VM is really slow. When I said really slow I meant <strong>it's hellish slow</strong>.</p>
<p>To enable NFS firstly install it on host machine by doing</p>
<div class="highlight"><pre><span class="n">vagrant</span> <span class="n">ssh</span>
<span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nfs</span><span class="o">-</span><span class="n">common</span>
</pre></div>
<p>On local machine it might be also required to install <strong>nfs-server</strong> package.
At the end just modify in Vagrantfile definition of shared folder by adding :nfs => true at the end, so it'll be looking like</p>
<div class="highlight"><pre><span class="n">config</span><span class="p">.</span><span class="n">vm</span><span class="p">.</span><span class="n">share_folder</span> <span class="s">"app-root"</span><span class="p">,</span> <span class="s">"/home/virtual/example.com"</span><span class="p">,</span> <span class="s">"."</span><span class="p">,</span> <span class="o">:</span><span class="n">nfs</span> <span class="o">=></span> <span class="nb">true</span>
</pre></div>
<p>We did a lot of work, but was it worth? I will say yes. Here are some <strong>pros</strong> using Vagrant:</p>
<ul>
<li>Unified development environment which is identical or really close to production environment,</li>
<li>No more problems with with "For me it works",</li>
<li>A documented configuration of environment thanks to Puppet manifests, which allows all to see which libs are necessary to be present on production env,</li>
<li>No more hacks to have few versions of libs/interpreters etc. (look at <strong>Ruby</strong> programs - every of them require different version of <em>Ruby</em>, some gems and other, so you need to have rbenv installed to manage it).</li>
</ul>
<p>Still there is no ideal tool and <strong>Vagrant</strong> is not ideal either. As a <strong>cons</strong> you can count:</p>
<ul>
<li>It likes to hang, without any reason. The good part is that it happens only when booting up the VM. Sometimes sadly it requires then to do cleaning up by <em>vagrant destroy</em> and then <em>vagrant up</em>. This thing leads to loss of a lot of time.</li>
<li>It takes a lot of time to setup environment. </li>
</ul>
<p>What's easier?</p>
<div class="highlight"><pre><span class="na">sudo</span> <span class="na">apt</span><span class="o">-</span><span class="na">get</span> <span class="na">install</span> <span class="na">nginx</span>
</pre></div>
<p>or</p>
<div class="highlight"><pre><span class="k">class</span> <span class="na">nginx</span> <span class="p">{</span><span class="na">ensure</span> <span class="o">=></span> <span class="k">present</span><span class="p">,</span> <span class="na">require</span> <span class="o">=></span> <span class="k">Exec</span><span class="p">[</span><span class="s">'apt-get update'</span><span class="p">]}</span>
<span class="k">service</span> <span class="p">{</span> <span class="s">'nginx'</span><span class="p">:</span>
<span class="na">ensure</span> <span class="o">=></span> <span class="k">running</span><span class="p">,</span>
<span class="na">require</span> <span class="o">=></span> <span class="k">Package</span><span class="p">[</span><span class="s">'nginx'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
<p>For me the first option.</p>
<ul>
<li>Without a NFS the VM is really slow, so don't try to use it for development.</li>
</ul>
<p>Still I think that the Vagrant will stay in my computer as a really useful tool for long time.</p>
<p>Thanks!</p>
</div><!-- /.entry-content -->
<div class="comments">
<h2>Comments !</h2>
<div id="disqus_thread"></div>
<script type="text/javascript">
var disqus_identifier = "vagrant-virtualbox-puppet-yet-another-boring-explanation.html";
var disqus_url = "http://www.piotrdeszynski.com/vagrant-virtualbox-puppet-yet-another-boring-explanation.html";
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://yetanotherboringprogrammersblog.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
</div>
</article>
</section>
<section id="extras" class="body">
<div class="blogroll">
<h2>blogroll</h2>
<ul>
<li><a href="http://docs.notmyidea.org/alexis/pelican/">Pelican</a></li>
<li><a href="http://python.org">Python.org</a></li>
<li><a href="http://validator.w3.org/check?uri=http%3A%2F%2Fpiotrdeszynski.com%2F">HTML5 Validator</a></li>
</ul>
</div><!-- /.blogroll -->
<div class="social">
<h2>social</h2>
<ul>
<li><a href="http://www.piotrdeszynski.com/feeds/all.atom.xml" type="application/atom+xml" rel="alternate">atom feed</a></li>
<li><a href="http://github.com/piteer1">github</a></li>
<li><a href="http://www.linkedin.com/pub/piotr-deszy%C5%84ski/14/762/17">linkedin.com</a></li>
</ul>
</div><!-- /.social -->
</section><!-- /#extras -->
<footer id="contentinfo" class="body">
<address id="about" class="vcard body">
Proudly powered by <a href="http://getpelican.com/">Pelican</a>, which takes great advantage of <a href="http://python.org">Python</a>.
</address><!-- /#about -->
<p>The theme is by <a href="http://coding.smashingmagazine.com/2009/08/04/designing-a-html-5-layout-from-scratch/">Smashing Magazine</a>, thanks!</p>
</footer><!-- /#contentinfo -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-35673065-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script type="text/javascript">
var disqus_shortname = 'yetanotherboringprogrammersblog';
(function () {
var s = document.createElement('script'); s.async = true;
s.type = 'text/javascript';
s.src = 'http://' + disqus_shortname + '.disqus.com/count.js';
(document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
}());
</script>
</body>
</html>