-
Notifications
You must be signed in to change notification settings - Fork 0
/
models.krkn.models.html
239 lines (202 loc) · 17.5 KB
/
models.krkn.models.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
<!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>models.krkn.models 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.telemetry package" href="models.telemetry.html" />
<link rel="prev" title="models.krkn package" href="models.krkn.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"><a class="reference internal" href="k8s.html">k8s package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="models.html">models package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="models.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="models.elastic.html">models.elastic package</a></li>
<li class="toctree-l3"><a class="reference internal" href="models.k8s.html">models.k8s package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="models.krkn.html">models.krkn package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="models.krkn.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="models.krkn.html#module-models.krkn">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="models.telemetry.html">models.telemetry package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="models.html#module-models">Module contents</a></li>
</ul>
</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="models.html">models package</a></li>
<li class="breadcrumb-item"><a href="models.krkn.html">models.krkn package</a></li>
<li class="breadcrumb-item active">models.krkn.models 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-models.krkn.models">
<span id="models-krkn-models-module"></span><h1>models.krkn.models module<a class="headerlink" href="#module-models.krkn.models" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">models.krkn.models.</span></span><span class="sig-name descname"><span class="pre">ChaosRunAlert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alertname</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">alertstate</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</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">severity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#models.krkn.models.ChaosRunAlert" 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>Represents a single alert collected from prometheus</p>
<dl class="py method">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert.__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">alertname</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">alertstate</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</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">severity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#models.krkn.models.ChaosRunAlert.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert.alertname">
<span class="sig-name descname"><span class="pre">alertname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlert.alertname" title="Link to this definition"></a></dt>
<dd><p>prometheus alert name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert.alertstate">
<span class="sig-name descname"><span class="pre">alertstate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlert.alertstate" title="Link to this definition"></a></dt>
<dd><p>prometheus alert state</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert.namespace">
<span class="sig-name descname"><span class="pre">namespace</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlert.namespace" title="Link to this definition"></a></dt>
<dd><p>namespace where the alert has been fired</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlert.severity">
<span class="sig-name descname"><span class="pre">severity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlert.severity" title="Link to this definition"></a></dt>
<dd><p>severity of the alert</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">models.krkn.models.</span></span><span class="sig-name descname"><span class="pre">ChaosRunAlertSummary</span></span><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary" 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>Represents a summary of the collected alerts</p>
<dl class="py method">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.chaos_alerts">
<span class="sig-name descname"><span class="pre">chaos_alerts</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><a class="reference internal" href="#models.krkn.models.ChaosRunAlert" title="models.krkn.models.ChaosRunAlert"><span class="pre">ChaosRunAlert</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.chaos_alerts" title="Link to this definition"></a></dt>
<dd><p>alerts collected during the chaos</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.post_chaos_alerts">
<span class="sig-name descname"><span class="pre">post_chaos_alerts</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><a class="reference internal" href="#models.krkn.models.ChaosRunAlert" title="models.krkn.models.ChaosRunAlert"><span class="pre">ChaosRunAlert</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.post_chaos_alerts" title="Link to this definition"></a></dt>
<dd><p>alerts collected after the chaos run</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.run_id">
<span class="sig-name descname"><span class="pre">run_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.run_id" title="Link to this definition"></a></dt>
<dd><p>Chaos run id</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.scenario">
<span class="sig-name descname"><span class="pre">scenario</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.scenario" title="Link to this definition"></a></dt>
<dd><p>scenario that caused critical alerts</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunAlertSummary.to_json">
<span class="sig-name descname"><span class="pre">to_json</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">str</span></span></span><a class="headerlink" href="#models.krkn.models.ChaosRunAlertSummary.to_json" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunOutput">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">models.krkn.models.</span></span><span class="sig-name descname"><span class="pre">ChaosRunOutput</span></span><a class="headerlink" href="#models.krkn.models.ChaosRunOutput" 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>The krkn full json output. this is meant to be injected
into Elastic search to be indexed</p>
<dl class="py method">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunOutput.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#models.krkn.models.ChaosRunOutput.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunOutput.critical_alerts">
<span class="sig-name descname"><span class="pre">critical_alerts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#models.krkn.models.ChaosRunAlertSummary" title="models.krkn.models.ChaosRunAlertSummary"><span class="pre">ChaosRunAlertSummary</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunOutput.critical_alerts" title="Link to this definition"></a></dt>
<dd><p>the prometheus critical alerts collected during and after the chaos
run</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunOutput.telemetry">
<span class="sig-name descname"><span class="pre">telemetry</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="models.telemetry.models.html#models.telemetry.models.ChaosRunTelemetry" title="models.telemetry.models.ChaosRunTelemetry"><span class="pre">ChaosRunTelemetry</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#models.krkn.models.ChaosRunOutput.telemetry" title="Link to this definition"></a></dt>
<dd><p>the cluster telemetry collected by krkn</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="models.krkn.models.ChaosRunOutput.to_json">
<span class="sig-name descname"><span class="pre">to_json</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">str</span></span></span><a class="headerlink" href="#models.krkn.models.ChaosRunOutput.to_json" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="models.krkn.html" class="btn btn-neutral float-left" title="models.krkn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="models.telemetry.html" class="btn btn-neutral float-right" title="models.telemetry 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>