-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
402 lines (291 loc) · 13.5 KB
/
Copy pathindex.html
File metadata and controls
402 lines (291 loc) · 13.5 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Simple Configuration Tools">
<link rel="shortcut icon" href="./img/favicon.ico">
<title>Home - Waffles</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="./css/theme.css" type="text/css" />
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="./css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/";
</script>
<script src="./js/jquery-2.1.1.min.js"></script>
<script src="./js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="./js/highlight.pack.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75603-16', 'wffls.github.io');
ga('send', 'pageview');
</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> Waffles</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current">
<a class="current" href=".">Home</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#waffles">Waffles</a></li>
<ul>
<li><a class="toctree-l3" href="#waffles-shell-scripts">Waffles Shell Scripts</a></li>
<li><a class="toctree-l3" href="#wafflescript">Wafflescript</a></li>
</ul>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Guides</span>
<ul class="subnav">
<li class="">
<a class="" href="guides/install_waffles/">Install Waffles</a>
</li>
<li class="">
<a class="" href="guides/install_wafflescript/">Install wafflescript</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Waffles Functions</span>
<ul class="subnav">
<li class="">
<a class="" href="functions/arrays/">arrays</a>
</li>
<li class="">
<a class="" href="functions/consul/">consul</a>
</li>
<li class="">
<a class="" href="functions/exec/">exec</a>
</li>
<li class="">
<a class="" href="functions/ini/">ini</a>
</li>
<li class="">
<a class="" href="functions/logging/">logging</a>
</li>
<li class="">
<a class="" href="functions/mysql/">mysql</a>
</li>
<li class="">
<a class="" href="functions/options/">options</a>
</li>
<li class="">
<a class="" href="functions/resource/">resource</a>
</li>
<li class="">
<a class="" href="functions/strings/">strings</a>
</li>
<li class="">
<a class="" href="functions/utils/">utils</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Waffles Resources</span>
<ul class="subnav">
<li class="">
<a class="" href="resources/apt.key/">apt.key</a>
</li>
<li class="">
<a class="" href="resources/apt.pkg/">apt.pkg</a>
</li>
<li class="">
<a class="" href="resources/apt.ppa/">apt.ppa</a>
</li>
<li class="">
<a class="" href="resources/apt.source/">apt.source</a>
</li>
<li class="">
<a class="" href="resources/augeas.generic/">augeas.generic</a>
</li>
<li class="">
<a class="" href="resources/consul.check/">consul.check</a>
</li>
<li class="">
<a class="" href="resources/consul.service/">consul.service</a>
</li>
<li class="">
<a class="" href="resources/consul.template/">consul.template</a>
</li>
<li class="">
<a class="" href="resources/consul.watch/">consul.watch</a>
</li>
<li class="">
<a class="" href="resources/cron.entry/">cron.entry</a>
</li>
<li class="">
<a class="" href="resources/dnf.copr/">dnf.copr</a>
</li>
<li class="">
<a class="" href="resources/dnf.pkg/">dnf.pkg</a>
</li>
<li class="">
<a class="" href="resources/dnf.repo/">dnf.repo</a>
</li>
<li class="">
<a class="" href="resources/dpkg.debconf/">dpkg.debconf</a>
</li>
<li class="">
<a class="" href="resources/file.ini/">file.ini</a>
</li>
<li class="">
<a class="" href="resources/file.line/">file.line</a>
</li>
<li class="">
<a class="" href="resources/git.repo/">git.repo</a>
</li>
<li class="">
<a class="" href="resources/ip6tables.rule/">ip6tables.rule</a>
</li>
<li class="">
<a class="" href="resources/iptables.rule/">iptables.rule</a>
</li>
<li class="">
<a class="" href="resources/mysql.database/">mysql.database</a>
</li>
<li class="">
<a class="" href="resources/mysql.grant/">mysql.grant</a>
</li>
<li class="">
<a class="" href="resources/mysql.user/">mysql.user</a>
</li>
<li class="">
<a class="" href="resources/os.directory/">os.directory</a>
</li>
<li class="">
<a class="" href="resources/os.file/">os.file</a>
</li>
<li class="">
<a class="" href="resources/os.groupadd/">os.groupadd</a>
</li>
<li class="">
<a class="" href="resources/os.symlink/">os.symlink</a>
</li>
<li class="">
<a class="" href="resources/os.useradd/">os.useradd</a>
</li>
<li class="">
<a class="" href="resources/python.pip/">python.pip</a>
</li>
<li class="">
<a class="" href="resources/python.virtualenv/">python.virtualenv</a>
</li>
<li class="">
<a class="" href="resources/rabbitmq.policy/">rabbitmq.policy</a>
</li>
<li class="">
<a class="" href="resources/rabbitmq.user_permissions/">rabbitmq.user_permissions</a>
</li>
<li class="">
<a class="" href="resources/rabbitmq.user/">rabbitmq.user</a>
</li>
<li class="">
<a class="" href="resources/rabbitmq.vhost/">rabbitmq.vhost</a>
</li>
<li class="">
<a class="" href="resources/ruby.gem/">ruby.gem</a>
</li>
<li class="">
<a class="" href="resources/service.sysv/">service.sysv</a>
</li>
<li class="">
<a class="" href="resources/service.upstart/">service.upstart</a>
</li>
<li class="">
<a class="" href="resources/sudoers.cmd/">sudoers.cmd</a>
</li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">Waffles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".">Docs</a> »</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/wffls/wffls.github.io/tree/docs/docs/index.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="waffles">Waffles</h1>
<p>A collection of tools to help make deploying, provisioning, and maintaining systems easier.</p>
<h2 id="waffles-shell-scripts">Waffles Shell Scripts</h2>
<p>The core of the Waffles project is... <a href="https://github.com/wffls/waffles">Waffles</a>: a suite of Bash scripts to manage server resources in an idempotent fashion. You can use Waffles to create server build scripts that can be executed multiple times and only making changes when needed.</p>
<p>Waffles tries to be:</p>
<h3 id="easy-to-use">Easy to Use</h3>
<p>To get started with Waffles, simply "source" the <code>init.sh</code> script:</p>
<pre><code class="shell">$ source /opt/waffles/init.sh
$ apt.pkg --help
</code></pre>
<h3 id="simple">Simple</h3>
<p>If you're proficient in shell scripting and system administration, you should have no problem dissecting and understanding Waffles.</p>
<h3 id="helpful">Helpful</h3>
<p>Waffles helps make the tasks you're already doing easier; whether that's adding an <code>apt</code> PPA, a line to an <code>ini</code> file, or adding a Cron entry.</p>
<h3 id="resourceful">Resourceful</h3>
<p>Waffles doesn't try to reinvent the wheel. Waffles leans on core system tools like <code>awk</code>, <code>sed</code>, and plain 'ol Bash to accomplish its tasks. Some Waffles resources have dependencies, but only when it makes sense.</p>
<h3 id="humble">Humble</h3>
<p>If there's a better tool for the job, Waffles yields to it. Waffles isn't interested in creating servers -- use <a href="https://terraform.io">Terraform</a> for that. Use <a href="https://consul.io">Consul</a> or <a href="https://jujucharms.com/">Juju</a> for service orchestration.</p>
<p>Use Waffles for maintaining basic resources within a server.</p>
<h2 id="wafflescript">Wafflescript</h2>
<p><a href="https://github.com/wffls/wafflescript">Wafflescript</a> is a compiled binary of Waffles. Simply copy the <code>wafflescript</code> binary to any system and immediately take advantage of the various Waffles resources.</p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="guides/install_waffles/" class="btn btn-neutral float-right" title="Install Waffles">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a href="https://github.com/wffls/wffls.github.io" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span style="margin-left: 15px"><a href="guides/install_waffles/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script src="./js/theme.js"></script>
</body>
</html>
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-09-30 00:35:03
-->