-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathansible-api-reporting.html
215 lines (186 loc) · 12.9 KB
/
ansible-api-reporting.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
<!doctype html>
<html lang="pt">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title> Testando o Blog | Python User Group - Piauí
</title>
<link rel="canonical" href="/ansible-api-reporting.html">
<link rel="stylesheet" href="/theme/css/bootstrap.min.css">
<link rel="stylesheet" href="/theme/css/font-awesome.min.css">
<link rel="stylesheet" href="/theme/css/pygments/default.min.css">
<link rel="stylesheet" href="/theme/css/theme.css">
<meta name="description" content="Leveraging Ansible's Python API to generate infrastructure reports.">
</head>
<body>
<header class="header">
<div class="container">
<div class="row">
<div class="col-sm-4">
<a href="/">
<img class="img-fluid rounded" src=https://avatars2.githubusercontent.com/u/5644128?s=400&v=4 width=200 height=200 alt="Python User Group - Piauí">
</a>
</div>
<div class="col-sm-8">
<h1 class="title"><a href="/">Python User Group - Piauí</a></h1>
<ul class="list-inline">
<li class="list-inline-item"><a href="/archives.html">Blog</a></li>
<li class="list-inline-item"><a href="/events.html">Eventos</a></li>
<li class="list-inline-item text-muted">|</li>
<li class="list-inline-item"><a href="/pages/about-us.html">Sobre nós</a></li>
<li class=" list-inline-item text-muted">|</li>
<li class="list-inline-item"><a class="fa fa-github" href="https://github.com/pugpi" target="_blank"></a></li>
<li class="list-inline-item"><a class="fa fa-telegram" href="https://t.me/pugpi" target="_blank"></a></li>
</ul>
</div>
</div> </div>
</header>
<div class="main">
<div class="container">
<h1> Testando o Blog
</h1>
<hr>
<article class="article">
<header>
<ul class="list-inline">
<li class="list-inline-item text-muted" title="2019-04-27T11:40:00-03:00">
<i class="fa fa-clock-o"></i>
sáb 27 abril 2019
</li>
<li class="list-inline-item">
<i class="fa fa-folder-open-o"></i>
<a href="/category/teste.html">Teste</a>
</li>
<li class="list-inline-item">
<i class="fa fa-user-o"></i>
<a href="/author/alan-orth.html">Alan Orth</a> </li>
<li class="list-inline-item">
<i class="fa fa-files-o"></i>
<a href="/tag/linux.html">#linux</a>, <a href="/tag/opensource.html">#opensource</a>, <a href="/tag/python.html">#python</a> </li>
</ul>
</header>
<div class="content">
<p>A few days ago I had to get some basic information from a handful of servers for an inventory report; just basic stuff like hostname, IP address, storage capacity, distro version, etc. I already manage all of my servers with Ansible, and there's a wealth of information available in Ansible's <code>setup</code> module, so I knew there had to be a clever way to do this.</p>
<p>Somehow I stumbled upon <a href="http://docs.ansible.com/developing_api.html">Ansible's Python API</a>, which solves this problem elegantly! It helped that other people are doing cool things and <a href="http://jpmens.net/2012/12/13/obtaining-remote-data-with-ansible-s-api/">writing about their experiences</a> too.</p>
<h2>Enter ansible.runner</h2>
<p>According to the documentation, the Python API is:</p>
<blockquote>[...] very powerful, and is how the ansible CLI and ansible-playbook are implemented.</blockquote>
<p>Indeed! Using <code>ansible.runner</code> I whipped something up and extracted data from several dozen servers in just a few minutes (and I don't even know Python!):</p>
<div class="highlight"><pre><span></span>$ ./ansible-runner.py
mjanjavm10, <span class="m">2</span>, <span class="m">30</span>, Ubuntu <span class="m">14</span>.04, <span class="m">192</span>.168.7.34
mjanjavm14, <span class="m">2</span>, <span class="m">30</span>, Ubuntu <span class="m">14</span>.04, <span class="m">192</span>.168.7.37
</pre></div>
<p>I had to massage the data a bit to get clean numbers for RAM and storage capacity, but other than that it was extremely straightforward (as most things with Ansible generally are).</p>
<h2>The Code</h2>
<p>Here's the source code for the <em>ansible-runner.py</em> script above:</p>
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 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</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
<span class="kn">import</span> <span class="nn">ansible.runner</span>
<span class="c1"># hosts to contact</span>
<span class="n">hostlist</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'virtual'</span><span class="p">]</span>
<span class="c1"># MiB -> GiB</span>
<span class="k">def</span> <span class="nf">mibs_to_gibs</span><span class="p">(</span><span class="n">mibs</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">mibs</span><span class="p">)</span> <span class="o">/</span> <span class="mf">1024.0</span>
<span class="c1"># KiB -> GiB</span>
<span class="k">def</span> <span class="nf">kibs_to_gibs</span><span class="p">(</span><span class="n">kibs</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">kibs</span><span class="p">)</span> <span class="o">/</span> <span class="mf">1024.0</span> <span class="o">/</span> <span class="mf">1024.0</span>
<span class="c1"># bytes -> GiB</span>
<span class="k">def</span> <span class="nf">bytes_to_gibs</span><span class="p">(</span><span class="n">num_bytes</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">num_bytes</span><span class="p">)</span> <span class="o">/</span> <span class="mf">1024.0</span> <span class="o">/</span> <span class="mf">1024.0</span> <span class="o">/</span> <span class="mf">1024.0</span>
<span class="k">def</span> <span class="nf">parse_results</span><span class="p">(</span><span class="n">results</span><span class="p">):</span>
<span class="k">for</span> <span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="ow">in</span> <span class="n">results</span><span class="p">[</span><span class="s1">'contacted'</span><span class="p">]</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">memory</span> <span class="o">=</span> <span class="n">mibs_to_gibs</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_memtotal_mb'</span><span class="p">])</span>
<span class="c1"># enumerate all disk devices to get total capacity</span>
<span class="n">disk_total_capacity</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">disk_device</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_devices'</span><span class="p">]</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">():</span>
<span class="n">disk_sectors</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_devices'</span><span class="p">][</span><span class="n">disk_device</span><span class="p">][</span><span class="s1">'sectors'</span><span class="p">])</span>
<span class="n">disk_sectors_size</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_devices'</span><span class="p">][</span><span class="n">disk_device</span><span class="p">][</span><span class="s1">'sectorsize'</span><span class="p">])</span>
<span class="n">disk_bytes</span> <span class="o">=</span> <span class="n">disk_sectors</span> <span class="o">*</span> <span class="n">disk_sectors_size</span>
<span class="n">disk_total_capacity</span> <span class="o">+=</span> <span class="n">bytes_to_gibs</span><span class="p">(</span><span class="n">disk_bytes</span><span class="p">)</span>
<span class="n">os</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_distribution'</span><span class="p">],</span> <span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_distribution_version'</span><span class="p">])</span>
<span class="n">ip</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">'ansible_facts'</span><span class="p">][</span><span class="s1">'ansible_default_ipv4'</span><span class="p">][</span><span class="s1">'address'</span><span class="p">])</span>
<span class="k">print</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">, </span><span class="si">%.0f</span><span class="s2">, </span><span class="si">%2.0f</span><span class="s2">, </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">memory</span><span class="p">,</span> <span class="n">disk_total_capacity</span><span class="p">,</span> <span class="n">os</span><span class="p">,</span> <span class="n">ip</span><span class="p">)</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">ansible</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">Runner</span><span class="p">(</span>
<span class="n">module_name</span><span class="o">=</span><span class="s1">'setup'</span><span class="p">,</span>
<span class="n">module_args</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span>
<span class="n">remote_user</span><span class="o">=</span><span class="s1">'provisioning'</span><span class="p">,</span>
<span class="n">sudo</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="n">pattern</span><span class="o">=</span><span class="n">hostlist</span><span class="p">,</span>
<span class="n">forks</span><span class="o">=</span><span class="mi">5</span>
<span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
<span class="n">parse_results</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
<span class="c1"># vim: set sw=4 ts=4:</span>
</pre></div>
</td></tr></table>
<p>Feel free to use, improve, and share it.</p>
<p>This was <a href="https://mjanja.ch/2015/01/leveraging-the-ansible-python-api-for-infrastructure-reporting/">originally posted</a> on my personal blog; re-posted here for posterity.</p>
</div>
</article>
</div>
</div>
<footer class="footer">
<div class="container">
<div class="row">
<ul class="col-sm-6 list-inline">
<li class="list-inline-item"><a href="/authors.html">Autores</a></li>
<li class="list-inline-item"><a href="/categories.html">Categorias</a></li>
<li class="list-inline-item"><a href="/tags.html">Tags</a></li>
</ul>
<p class="col-sm-6 text-sm-right text-muted">
Feito com <a href="https://github.com/getpelican/pelican" target="_blank">Pelican</a>
/ <a href="https://github.com/nairobilug/pelican-alchemy" target="_blank">✨</a>
</p>
</div> </div>
</footer>
</body>
</html>