-
Notifications
You must be signed in to change notification settings - Fork 0
/
k8s.pods_monitor_pool.html
251 lines (224 loc) · 15.6 KB
/
k8s.pods_monitor_pool.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>k8s.pods_monitor_pool module — Krkn Foundation Library</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/krkn-style.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=34c10c6c"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="models package" href="models.html" />
<link rel="prev" title="k8s.krkn_kubernetes module" href="k8s.krkn_kubernetes.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="modules.html">
<img src="_static/redhat-chaos.png" class="logo" alt="Logo"/>
</a>
<div class="version">
v4.0.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="elastic.html">elastic package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="k8s.html">k8s package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="k8s.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="k8s.krkn_kubernetes.html">k8s.krkn_kubernetes module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">k8s.pods_monitor_pool module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#k8s.pods_monitor_pool.PodsMonitorPool"><code class="docutils literal notranslate"><span class="pre">PodsMonitorPool</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="k8s.html#module-k8s">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="models.html">models package</a></li>
<li class="toctree-l1"><a class="reference internal" href="ocp.html">ocp package</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus.html">prometheus package</a></li>
<li class="toctree-l1"><a class="reference internal" href="telemetry.html">telemetry package</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">utils package</a></li>
<li class="toctree-l1"><a class="reference internal" href="version.html">version package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="modules.html">Krkn Foundation Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="modules.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="k8s.html">k8s package</a></li>
<li class="breadcrumb-item active">k8s.pods_monitor_pool module</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-k8s.pods_monitor_pool">
<span id="k8s-pods-monitor-pool-module"></span><h1>k8s.pods_monitor_pool module<a class="headerlink" href="#module-k8s.pods_monitor_pool" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">k8s.pods_monitor_pool.</span></span><span class="sig-name descname"><span class="pre">PodsMonitorPool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">krkn_lib</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KrknKubernetes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class has the purpose to manage pools of pod
status monitoring threads for the Krkn Scenarios
having multiple killing sessions at the same time (eg. Plugin scenarios)
the methods reflects the behaviour of the underlying
KrknKubernetes Primitives but each call to select_and_monitor_*
method pushes a new thread that is managed by the pool.
The join method joins all the threads in the pool simultaneously
and merges the results on a single PodsStatus structure.</p>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">krkn_lib</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KrknKubernetes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.cancel">
<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.cancel" title="Link to this definition"></a></dt>
<dd><p>cancels all the threads in the pool and makes return
the join() call immediately</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.events">
<span class="sig-name descname"><span class="pre">events</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Event</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.events" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.join">
<span class="sig-name descname"><span class="pre">join</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">PodsStatus</span></span></span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.join" title="Link to this definition"></a></dt>
<dd><p>waits all the threads pushed into the pool to finish</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>a PodsStatus structure that is the merge between
all the PodsStatus structures returned by every thread
pushed into the pool.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_label">
<span class="sig-name descname"><span class="pre">select_and_monitor_by_label</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label_selector</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_label" title="Link to this definition"></a></dt>
<dd><p>Pushes into the pool a monitoring thread for all the pods identified
by a label selector and collects infos about the
pods recovery after a kill scenario while the scenario is running.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>label_selector</strong> – the label selector used
to filter the pods to monitor (must be the
same used in <cite>select_pods_by_label</cite>)</p></li>
<li><p><strong>max_timeout</strong> – the expected time the pods should take
to recover. If the killed pods are replaced in this time frame,
but they didn’t reach the Ready State, they will be marked as
unrecovered. If during the time frame the pods are not replaced
at all the error field of the PodsStatus structure will be
valorized with an exception.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_name_pattern_and_namespace_pattern">
<span class="sig-name descname"><span class="pre">select_and_monitor_by_name_pattern_and_namespace_pattern</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_name_pattern</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace_pattern</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_name_pattern_and_namespace_pattern" title="Link to this definition"></a></dt>
<dd><p>Pushes into the pool a monitoring thread for all the pods identified
by a pod name regex pattern
and a namespace regex pattern, that collects infos about the
pods recovery after a kill scenario while the scenario is running.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pod_name_pattern</strong> – a regex representing the
pod name pattern used to filter the pods to be monitored
(must be the same used in
<cite>select_pods_by_name_pattern_and_namespace_pattern</cite>)</p></li>
<li><p><strong>namespace_pattern</strong> – a regex representing the namespace
pattern used to filter the pods to be monitored
(must be the same used in
<cite>select_pods_by_name_pattern_and_namespace_pattern</cite>)</p></li>
<li><p><strong>max_timeout</strong> – the expected time the pods should take to
recover. If the killed pods are replaced in this time frame,
but they didn’t reach the Ready State, they will be marked as
unrecovered. If during the time frame the pods are not replaced
at all the error field of the PodsStatus structure will be
valorized with an exception.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_namespace_pattern_and_label">
<span class="sig-name descname"><span class="pre">select_and_monitor_by_namespace_pattern_and_label</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_pattern</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_selector</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#k8s.pods_monitor_pool.PodsMonitorPool.select_and_monitor_by_namespace_pattern_and_label" title="Link to this definition"></a></dt>
<dd><p>Pushes into the pool a monitoring thread for all the pods identified
by a namespace regex pattern
and a pod label selector, that collects infos about the
pods recovery after a kill scenario while the scenario is running.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>label_selector</strong> – the label selector used to filter
the pods to monitor (must be the same used in
<cite>select_pods_by_label</cite>)</p></li>
<li><p><strong>namespace_pattern</strong> – a regex representing the namespace
pattern used to filter the pods to be monitored (must be
the same used
in <cite>select_pods_by_name_pattern_and_namespace_pattern</cite>)</p></li>
<li><p><strong>max_timeout</strong> – the expected time the pods should take to recover.
If the killed pods are replaced in this time frame, but they
didn’t reach the Ready State, they will be marked as unrecovered.
If during the time frame the pods are not replaced
at all the error field of the PodsStatus structure will be
valorized with an exception.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="k8s.krkn_kubernetes.html" class="btn btn-neutral float-left" title="k8s.krkn_kubernetes module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="models.html" class="btn btn-neutral float-right" title="models package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Red Hat Chaos Team.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>