-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
313 lines (232 loc) · 13.3 KB
/
index.html
File metadata and controls
313 lines (232 loc) · 13.3 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
<!DOCTYPE html>
<html lang="en">
<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="Bloat-free configuration management">
<meta name="author" content="Eduardo Tongson">
<link rel="canonical" href="http://www.configi.org/">
<link rel="shortcut icon" href="favicon.ico">
<title>Configi</title>
<link href="./css/bootstrap-custom.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="./css/highlight.css">
<link href="./css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href=".">Configi</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="active">
<a href=".">Home</a>
</li>
<li >
<a href="download/">Download</a>
</li>
<li >
<a href="license/">License</a>
</li>
<li >
<a href="modules/">Modules</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Reference <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="reference/about_modules/">About modules</a>
</li>
<li >
<a href="reference/stdlib/">Standard library</a>
</li>
<li >
<a href="reference/modules/">Available Lua modules</a>
</li>
<li >
<a href="reference/roles/">Roles</a>
</li>
<li >
<a href="reference/cli/">Cli</a>
</li>
<li >
<a href="reference/factid/">Factid</a>
</li>
<li >
<a href="reference/glossary/">Glossary</a>
</li>
<li >
<a href="reference/gotchas/">Gotchas</a>
</li>
<li >
<a href="reference/module_functions/">Module functions</a>
</li>
<li >
<a href="reference/policy_functions/">Policy functions</a>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="disabled">
<a rel="next" >
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="download/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li>
<a href="https://github.com/Configi/configi">
<i class="fa fa-github"></i>
GitHub
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#configi">Configi</a></li>
<li><a href="#why">Why?</a></li>
<li><a href="#design-decisions">Design decisions</a></li>
<li><a href="#example-policy">Example policy</a></li>
<li><a href="#policies-are-written-in-lua">Policies are written in Lua</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="configi">Configi</h1>
<p>A minimalistic infrastructure automation and configuration management software. It is MIT licensed (including the core modules).</p>
<p>Configi can manage several aspects of system configuration, compliance and maintenance. Note that this will depend on the availability of Configi modules available for your requirement.</p>
<p>Configi is Linux only at the moment but variants of BSD and macOS support is possible but no plans yet.</p>
<p>See <a href="http://en.wikipedia.org/wiki/Configuration_management">Wikipedia</a> for more information on the topic of configuration management.</p>
<hr />
<h2 id="why">Why?</h2>
<p>There are more mature configuration management software available right now but I find most are bloated both in resource usage and features. The others in the minimalist camp also fall short due to complicated policy writing and poor extensibility.</p>
<p>Configi was inspired by CFEngine 3, Chef and Ansible. You may see some similarities with these configuration management software in Configi. Especially CFEngine 3, where we borrowed identifiers and concepts introduced by the Promise Theory and Computer Immunology.</p>
<p>Visit M. Burgess' <a href="http://markburgess.org/sysadmin.html">page</a> for essays, articles and papers regarding Promise Theory and system administration. I do not claim full compliance to the theory so Configi should not be considered a complete replacement for CFEngine 3.</p>
<p>Choosing the right tool is not a rational matter. If the design decisions outlined below aligns with your requirements then please give Configi a try.</p>
<hr />
<h2 id="design-decisions">Design decisions</h2>
<p><strong>Compiled-in modules and policy</strong><br/>
 The Configi executable (cfg-agent) with all modules (as of 0.9.0) compiled-in is around 500KiB. In practice this should be less because Configi modules are compiled-in. You can choose the modules only applicable for your policy or host. It's also possible to have your policy built-in during compilation of the executable.</p>
<p><strong>Minimal DSL for writing policies</strong><br/>
 Markup languages are getting more popular for this use case but they are more of a hindrance. Configi has a proper programming language so there is little to no DSL semantics to struggle with.</p>
<p><strong>Pull or push model</strong><br/>
 The ideal system would be a pull-based system but if needed Configi can also emulate a push-based system.</p>
<p><strong>No packaging required</strong><br/>
 You can just copy the Configi (cfg-agent) executable to a host and have it configuring the host in no time.</p>
<p><strong>Minimal resource usage</strong><br/>
 Being built in Lua and C allows for minimal resources used, both and disk space, CPU and memory.</p>
<p><strong>Depend on existing host tooling</strong><br/>
 As much as possible Configi makes use of host tools (e.g coreutils, busybox, native package manager, native process manager). If bypassing host tooling is required or there is none available, Configi modules has the capability to drop down to Lua and/or C for operations or execution.</p>
<p><strong>The only reporting mechanism is through syslog</strong><br/>
 To be light as possible, it makes sense to support the most widespread reporting facility. If you need to monitor or gather reports from all your hosts you will need to set up consolidated remote syslogging and automated reporting.</p>
<hr />
<h2 id="example-policy">Example policy</h2>
<pre><code> file.directory"/tmp/dir"{
comment = "Create directory if running on Gentoo",
context = fact.osfamily.gentoo,
mode = 0700,
notify = "touch"
}
yum.present"mtr"{
context = fact.osfamily.centos
}
file.absent"/tmp/dir"{
notify = "touch"
}
file.touch"/tmp/dir"{
comment = "Handle 'touch' notifications. This is only executed once.",
handle = "touch"
}
</code></pre>
<hr />
<h2 id="policies-are-written-in-lua">Policies are written in Lua</h2>
<p><a href="http://lua.org">Lua</a> is a simple and lightweight multi-paradigm dynamically typed programming language. It allows for imperative and functional programming. With a properly specified language we can avoid problems brought upon by ad-hoc implementations of a DSL.</p>
<p>It is a very suitable scripting language for configuration management. The language' features lend to simple core and module code. It's not a batteries-included scripting language so some binding and module writing is necessary.</p>
<p>The following learning resources for Lua should get you going:<br/>
<a href="http://tylerneylon.com/a/learn-lua/">Learn Lua in 15 minutes</a><br/>
<a href="https://rawgit.com/dlaurie/lua-notes/master/glossary.html">Lua Glossary</a><br/>
<a href="https://github.com/stevedonovan/lua-gentle-intro/blob/master/readme.md">Gentle introduction to Lua</a></p>
<hr />
<h4 id="faq">FAQ</h4>
<p>1) <strong>Why not LuaJIT?</strong></p>
<p>LuaJIT and its FFI is amazing but Configi does not need the speed that it provides. Most of the execution time in Configi will be spent by exec(3).</p>
<p>Since the Configi core is small and simple it wouldn't be too hard to port it to LuaJIT. Right now, I just value the simplicity of PUC Lua.</p>
<p>2) <strong>Will you support my chosen Linux distro?</strong></p>
<p>Submit a Github issue or request in the mailing list.</p>
<p>Also check the associated Github Projects page to see if support is already planned.<br/>
<a href="https://github.com/Configi/configi/projects">configi/projects</a></p>
<hr />
<h4 id="mailing-list">Mailing list</h4>
<p>Join the mailing list if you need help or have Configi module requests. Bug reports and patches are also very much welcome.</p>
<p>To join, send an email to configi-request@freelists.org with 'subscribe' in the Subject field OR by
visiting the list page at <a href="http://www.freelists.org/list/configi">Freelists/Configi</a>.</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Content licensed under a CC Attribution 4.0 International License</center>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="./js/jquery-1.10.2.min.js"></script>
<script src="./js/bootstrap-3.0.3.min.js"></script>
<script src="./js/highlight.pack.js"></script>
<script>var base_url = '.';</script>
<script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script>
<script src="./js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>