mirror of
https://github.com/prometheus-community/ansible
synced 2024-12-18 08:03:10 +00:00
deploy: c0d782c178
This commit is contained in:
gardar
parent
a6040691f0
commit
73ff628e7e
53 changed files with 0 additions and 8231 deletions
|
|
@ -1,4 +0,0 @@
|
||||||
# Sphinx build info version 1
|
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
|
||||||
config: 2425e66685edee675bc1f9ab7687f954
|
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,903 +0,0 @@
|
||||||
/*
|
|
||||||
* basic.css
|
|
||||||
* ~~~~~~~~~
|
|
||||||
*
|
|
||||||
* Sphinx stylesheet -- basic theme.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
/* -- main layout ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.clearer {
|
|
||||||
clear: both;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.section::after {
|
|
||||||
display: block;
|
|
||||||
content: '';
|
|
||||||
clear: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- relbar ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.related {
|
|
||||||
width: 100%;
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related h3 {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related ul {
|
|
||||||
margin: 0;
|
|
||||||
padding: 0 0 0 10px;
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related li {
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related li.right {
|
|
||||||
float: right;
|
|
||||||
margin-right: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- sidebar --------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.sphinxsidebarwrapper {
|
|
||||||
padding: 10px 5px 0 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar {
|
|
||||||
float: left;
|
|
||||||
width: 230px;
|
|
||||||
margin-left: -100%;
|
|
||||||
font-size: 90%;
|
|
||||||
word-wrap: break-word;
|
|
||||||
overflow-wrap : break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul {
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul ul,
|
|
||||||
div.sphinxsidebar ul.want-points {
|
|
||||||
margin-left: 20px;
|
|
||||||
list-style: square;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul ul {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar form {
|
|
||||||
margin-top: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar input {
|
|
||||||
border: 1px solid #98dbcc;
|
|
||||||
font-family: sans-serif;
|
|
||||||
font-size: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar #searchbox form.search {
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar #searchbox input[type="text"] {
|
|
||||||
float: left;
|
|
||||||
width: 80%;
|
|
||||||
padding: 0.25em;
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
|
||||||
float: left;
|
|
||||||
width: 20%;
|
|
||||||
border-left: none;
|
|
||||||
padding: 0.25em;
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
img {
|
|
||||||
border: 0;
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- search page ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
ul.search {
|
|
||||||
margin: 10px 0 0 20px;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li {
|
|
||||||
padding: 5px 0 5px 20px;
|
|
||||||
background-image: url(file.png);
|
|
||||||
background-repeat: no-repeat;
|
|
||||||
background-position: 0 7px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li a {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li p.context {
|
|
||||||
color: #888;
|
|
||||||
margin: 2px 0 0 30px;
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.keywordmatches li.goodmatch a {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- index page ------------------------------------------------------------ */
|
|
||||||
|
|
||||||
table.contentstable {
|
|
||||||
width: 90%;
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.contentstable p.biglink {
|
|
||||||
line-height: 150%;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.biglink {
|
|
||||||
font-size: 1.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.linkdescr {
|
|
||||||
font-style: italic;
|
|
||||||
padding-top: 5px;
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- general index --------------------------------------------------------- */
|
|
||||||
|
|
||||||
table.indextable {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable td {
|
|
||||||
text-align: left;
|
|
||||||
vertical-align: top;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable ul {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
list-style-type: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable > tbody > tr > td > ul {
|
|
||||||
padding-left: 0em;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable tr.pcap {
|
|
||||||
height: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable tr.cap {
|
|
||||||
margin-top: 10px;
|
|
||||||
background-color: #f2f2f2;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.toggler {
|
|
||||||
margin-right: 3px;
|
|
||||||
margin-top: 3px;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.modindex-jumpbox {
|
|
||||||
border-top: 1px solid #ddd;
|
|
||||||
border-bottom: 1px solid #ddd;
|
|
||||||
margin: 1em 0 1em 0;
|
|
||||||
padding: 0.4em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.genindex-jumpbox {
|
|
||||||
border-top: 1px solid #ddd;
|
|
||||||
border-bottom: 1px solid #ddd;
|
|
||||||
margin: 1em 0 1em 0;
|
|
||||||
padding: 0.4em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- domain module index --------------------------------------------------- */
|
|
||||||
|
|
||||||
table.modindextable td {
|
|
||||||
padding: 2px;
|
|
||||||
border-collapse: collapse;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- general body styles --------------------------------------------------- */
|
|
||||||
|
|
||||||
div.body {
|
|
||||||
min-width: 360px;
|
|
||||||
max-width: 800px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
|
||||||
-moz-hyphens: auto;
|
|
||||||
-ms-hyphens: auto;
|
|
||||||
-webkit-hyphens: auto;
|
|
||||||
hyphens: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.headerlink {
|
|
||||||
visibility: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1:hover > a.headerlink,
|
|
||||||
h2:hover > a.headerlink,
|
|
||||||
h3:hover > a.headerlink,
|
|
||||||
h4:hover > a.headerlink,
|
|
||||||
h5:hover > a.headerlink,
|
|
||||||
h6:hover > a.headerlink,
|
|
||||||
dt:hover > a.headerlink,
|
|
||||||
caption:hover > a.headerlink,
|
|
||||||
p.caption:hover > a.headerlink,
|
|
||||||
div.code-block-caption:hover > a.headerlink {
|
|
||||||
visibility: visible;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body p.caption {
|
|
||||||
text-align: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body td {
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
.first {
|
|
||||||
margin-top: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.rubric {
|
|
||||||
margin-top: 30px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
|
||||||
clear: left;
|
|
||||||
float: left;
|
|
||||||
margin-right: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
|
||||||
clear: right;
|
|
||||||
float: right;
|
|
||||||
margin-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
|
||||||
display: block;
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-default, figure.align-default, .figure.align-default {
|
|
||||||
display: block;
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-left {
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-center {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-default {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-right {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- sidebars -------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.sidebar,
|
|
||||||
aside.sidebar {
|
|
||||||
margin: 0 0 0.5em 1em;
|
|
||||||
border: 1px solid #ddb;
|
|
||||||
padding: 7px;
|
|
||||||
background-color: #ffe;
|
|
||||||
width: 40%;
|
|
||||||
float: right;
|
|
||||||
clear: right;
|
|
||||||
overflow-x: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.sidebar-title {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
nav.contents,
|
|
||||||
aside.topic,
|
|
||||||
div.admonition, div.topic, blockquote {
|
|
||||||
clear: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- topics ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
nav.contents,
|
|
||||||
aside.topic,
|
|
||||||
div.topic {
|
|
||||||
border: 1px solid #ccc;
|
|
||||||
padding: 7px;
|
|
||||||
margin: 10px 0 10px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.topic-title {
|
|
||||||
font-size: 1.1em;
|
|
||||||
font-weight: bold;
|
|
||||||
margin-top: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- admonitions ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.admonition {
|
|
||||||
margin-top: 10px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
padding: 7px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.admonition dt {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.admonition-title {
|
|
||||||
margin: 0px 10px 5px 0px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body p.centered {
|
|
||||||
text-align: center;
|
|
||||||
margin-top: 25px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
|
||||||
|
|
||||||
div.sidebar > :last-child,
|
|
||||||
aside.sidebar > :last-child,
|
|
||||||
nav.contents > :last-child,
|
|
||||||
aside.topic > :last-child,
|
|
||||||
div.topic > :last-child,
|
|
||||||
div.admonition > :last-child {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sidebar::after,
|
|
||||||
aside.sidebar::after,
|
|
||||||
nav.contents::after,
|
|
||||||
aside.topic::after,
|
|
||||||
div.topic::after,
|
|
||||||
div.admonition::after,
|
|
||||||
blockquote::after {
|
|
||||||
display: block;
|
|
||||||
content: '';
|
|
||||||
clear: both;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- tables ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
table.docutils {
|
|
||||||
margin-top: 10px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
border: 0;
|
|
||||||
border-collapse: collapse;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.align-center {
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.align-default {
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
table caption span.caption-number {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
table caption span.caption-text {
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils td, table.docutils th {
|
|
||||||
padding: 1px 8px 1px 5px;
|
|
||||||
border-top: 0;
|
|
||||||
border-left: 0;
|
|
||||||
border-right: 0;
|
|
||||||
border-bottom: 1px solid #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
th {
|
|
||||||
text-align: left;
|
|
||||||
padding-right: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.citation {
|
|
||||||
border-left: solid 1px gray;
|
|
||||||
margin-left: 1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.citation td {
|
|
||||||
border-bottom: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
th > :first-child,
|
|
||||||
td > :first-child {
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
th > :last-child,
|
|
||||||
td > :last-child {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- figures --------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.figure, figure {
|
|
||||||
margin: 0.5em;
|
|
||||||
padding: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.figure p.caption, figcaption {
|
|
||||||
padding: 0.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.figure p.caption span.caption-number,
|
|
||||||
figcaption span.caption-number {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.figure p.caption span.caption-text,
|
|
||||||
figcaption span.caption-text {
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- field list styles ----------------------------------------------------- */
|
|
||||||
|
|
||||||
table.field-list td, table.field-list th {
|
|
||||||
border: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-list ul {
|
|
||||||
margin: 0;
|
|
||||||
padding-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-list p {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-name {
|
|
||||||
-moz-hyphens: manual;
|
|
||||||
-ms-hyphens: manual;
|
|
||||||
-webkit-hyphens: manual;
|
|
||||||
hyphens: manual;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- hlist styles ---------------------------------------------------------- */
|
|
||||||
|
|
||||||
table.hlist {
|
|
||||||
margin: 1em 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.hlist td {
|
|
||||||
vertical-align: top;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- object description styles --------------------------------------------- */
|
|
||||||
|
|
||||||
.sig {
|
|
||||||
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-name, code.descname {
|
|
||||||
background-color: transparent;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-name {
|
|
||||||
font-size: 1.1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
code.descname {
|
|
||||||
font-size: 1.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-prename, code.descclassname {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.optional {
|
|
||||||
font-size: 1.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-paren {
|
|
||||||
font-size: larger;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig-param.n {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* C++ specific styling */
|
|
||||||
|
|
||||||
.sig-inline.c-texpr,
|
|
||||||
.sig-inline.cpp-texpr {
|
|
||||||
font-family: unset;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig.c .k, .sig.c .kt,
|
|
||||||
.sig.cpp .k, .sig.cpp .kt {
|
|
||||||
color: #0033B3;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig.c .m,
|
|
||||||
.sig.cpp .m {
|
|
||||||
color: #1750EB;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sig.c .s, .sig.c .sc,
|
|
||||||
.sig.cpp .s, .sig.cpp .sc {
|
|
||||||
color: #067D17;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/* -- other body styles ----------------------------------------------------- */
|
|
||||||
|
|
||||||
ol.arabic {
|
|
||||||
list-style: decimal;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.loweralpha {
|
|
||||||
list-style: lower-alpha;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.upperalpha {
|
|
||||||
list-style: upper-alpha;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.lowerroman {
|
|
||||||
list-style: lower-roman;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.upperroman {
|
|
||||||
list-style: upper-roman;
|
|
||||||
}
|
|
||||||
|
|
||||||
:not(li) > ol > li:first-child > :first-child,
|
|
||||||
:not(li) > ul > li:first-child > :first-child {
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
:not(li) > ol > li:last-child > :last-child,
|
|
||||||
:not(li) > ul > li:last-child > :last-child {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.simple ol p,
|
|
||||||
ol.simple ul p,
|
|
||||||
ul.simple ol p,
|
|
||||||
ul.simple ul p {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.simple > li:not(:first-child) > p,
|
|
||||||
ul.simple > li:not(:first-child) > p {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.simple p,
|
|
||||||
ul.simple p {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
aside.footnote > span,
|
|
||||||
div.citation > span {
|
|
||||||
float: left;
|
|
||||||
}
|
|
||||||
aside.footnote > span:last-of-type,
|
|
||||||
div.citation > span:last-of-type {
|
|
||||||
padding-right: 0.5em;
|
|
||||||
}
|
|
||||||
aside.footnote > p {
|
|
||||||
margin-left: 2em;
|
|
||||||
}
|
|
||||||
div.citation > p {
|
|
||||||
margin-left: 4em;
|
|
||||||
}
|
|
||||||
aside.footnote > p:last-of-type,
|
|
||||||
div.citation > p:last-of-type {
|
|
||||||
margin-bottom: 0em;
|
|
||||||
}
|
|
||||||
aside.footnote > p:last-of-type:after,
|
|
||||||
div.citation > p:last-of-type:after {
|
|
||||||
content: "";
|
|
||||||
clear: both;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.field-list {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: fit-content(30%) auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.field-list > dt {
|
|
||||||
font-weight: bold;
|
|
||||||
word-break: break-word;
|
|
||||||
padding-left: 0.5em;
|
|
||||||
padding-right: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.field-list > dd {
|
|
||||||
padding-left: 0.5em;
|
|
||||||
margin-top: 0em;
|
|
||||||
margin-left: 0em;
|
|
||||||
margin-bottom: 0em;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl {
|
|
||||||
margin-bottom: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd > :first-child {
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd ul, dd table {
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd {
|
|
||||||
margin-top: 3px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
margin-left: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl > dd:last-child,
|
|
||||||
dl > dd:last-child > :last-child {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
dt:target, span.highlighted {
|
|
||||||
background-color: #fbe54e;
|
|
||||||
}
|
|
||||||
|
|
||||||
rect.highlighted {
|
|
||||||
fill: #fbe54e;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.glossary dt {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 1.1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.versionmodified {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.system-message {
|
|
||||||
background-color: #fda;
|
|
||||||
padding: 5px;
|
|
||||||
border: 3px solid red;
|
|
||||||
}
|
|
||||||
|
|
||||||
.footnote:target {
|
|
||||||
background-color: #ffa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.line-block {
|
|
||||||
display: block;
|
|
||||||
margin-top: 1em;
|
|
||||||
margin-bottom: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.line-block .line-block {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
margin-left: 1.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.guilabel, .menuselection {
|
|
||||||
font-family: sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
.accelerator {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
.classifier {
|
|
||||||
font-style: oblique;
|
|
||||||
}
|
|
||||||
|
|
||||||
.classifier:before {
|
|
||||||
font-style: normal;
|
|
||||||
margin: 0 0.5em;
|
|
||||||
content: ":";
|
|
||||||
display: inline-block;
|
|
||||||
}
|
|
||||||
|
|
||||||
abbr, acronym {
|
|
||||||
border-bottom: dotted 1px;
|
|
||||||
cursor: help;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- code displays --------------------------------------------------------- */
|
|
||||||
|
|
||||||
pre {
|
|
||||||
overflow: auto;
|
|
||||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
|
||||||
}
|
|
||||||
|
|
||||||
pre, div[class*="highlight-"] {
|
|
||||||
clear: both;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.pre {
|
|
||||||
-moz-hyphens: none;
|
|
||||||
-ms-hyphens: none;
|
|
||||||
-webkit-hyphens: none;
|
|
||||||
hyphens: none;
|
|
||||||
white-space: nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
div[class*="highlight-"] {
|
|
||||||
margin: 1em 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
td.linenos pre {
|
|
||||||
border: 0;
|
|
||||||
background-color: transparent;
|
|
||||||
color: #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable tbody {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable tr {
|
|
||||||
display: flex;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable td {
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable td.linenos {
|
|
||||||
padding-right: 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable td.code {
|
|
||||||
flex: 1;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
.highlight .hll {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.highlight pre,
|
|
||||||
table.highlighttable pre {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.code-block-caption + div {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.code-block-caption {
|
|
||||||
margin-top: 1em;
|
|
||||||
padding: 2px 5px;
|
|
||||||
font-size: small;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.code-block-caption code {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable td.linenos,
|
|
||||||
span.linenos,
|
|
||||||
div.highlight span.gp { /* gp: Generic.Prompt */
|
|
||||||
user-select: none;
|
|
||||||
-webkit-user-select: text; /* Safari fallback only */
|
|
||||||
-webkit-user-select: none; /* Chrome/Safari */
|
|
||||||
-moz-user-select: none; /* Firefox */
|
|
||||||
-ms-user-select: none; /* IE10+ */
|
|
||||||
}
|
|
||||||
|
|
||||||
div.code-block-caption span.caption-number {
|
|
||||||
padding: 0.1em 0.3em;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.code-block-caption span.caption-text {
|
|
||||||
}
|
|
||||||
|
|
||||||
div.literal-block-wrapper {
|
|
||||||
margin: 1em 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
code.xref, a code {
|
|
||||||
background-color: transparent;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.viewcode-link {
|
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
.viewcode-back {
|
|
||||||
float: right;
|
|
||||||
font-family: sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.viewcode-block:target {
|
|
||||||
margin: -1px -10px;
|
|
||||||
padding: 0 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- math display ---------------------------------------------------------- */
|
|
||||||
|
|
||||||
img.math {
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body div.math p {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.eqno {
|
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.eqno a.headerlink {
|
|
||||||
position: absolute;
|
|
||||||
z-index: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.math:hover a.headerlink {
|
|
||||||
visibility: visible;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- printout stylesheet --------------------------------------------------- */
|
|
||||||
|
|
||||||
@media print {
|
|
||||||
div.document,
|
|
||||||
div.documentwrapper,
|
|
||||||
div.bodywrapper {
|
|
||||||
margin: 0 !important;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar,
|
|
||||||
div.related,
|
|
||||||
div.footer,
|
|
||||||
#top-link {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,491 +0,0 @@
|
||||||
@import 'theme.css';
|
|
||||||
/*! minified with http://css-minify.online-domain-tools.com/ - all comments
|
|
||||||
* must have ! to preserve during minifying with that tool */
|
|
||||||
/*! Fix for read the docs theme:
|
|
||||||
* https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
|
|
||||||
*/
|
|
||||||
/*! override table width restrictions */
|
|
||||||
@media screen and (min-width: 767px) {
|
|
||||||
/*! If we ever publish to read the docs, we need to use !important for
|
|
||||||
* these two styles as read the docs itself loads their theme in a way that
|
|
||||||
* we can't otherwise override it.
|
|
||||||
*/
|
|
||||||
.wy-table-responsive table td {
|
|
||||||
white-space: normal;
|
|
||||||
}
|
|
||||||
.wy-table-responsive {
|
|
||||||
overflow: visible;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/*!
|
|
||||||
* We use the class documentation-table for attribute tables where the first
|
|
||||||
* column is the name of an attribute and the second column is the description.
|
|
||||||
*/
|
|
||||||
/*! These tables look like this:
|
|
||||||
*
|
|
||||||
* Attribute Name Description
|
|
||||||
* -------------- -----------
|
|
||||||
* **NAME** This is a multi-line description
|
|
||||||
* str/required that can span multiple lines
|
|
||||||
* added in x.y
|
|
||||||
* With multiple paragraphs
|
|
||||||
* -------------- -----------
|
|
||||||
*
|
|
||||||
* **NAME** is given the class .value-name
|
|
||||||
* str is given the class .value-type
|
|
||||||
* / is given the class .value-separator
|
|
||||||
* required is given the class .value-required
|
|
||||||
* added in x.y is given the class .value-added-in
|
|
||||||
*/
|
|
||||||
/*! The extra .rst-content is so this will override rtd theme */
|
|
||||||
.rst-content table.documentation-table td {
|
|
||||||
vertical-align: top;
|
|
||||||
}
|
|
||||||
table.documentation-table td:first-child {
|
|
||||||
white-space: nowrap;
|
|
||||||
vertical-align: top;
|
|
||||||
}
|
|
||||||
table.documentation-table td:first-child p:first-child {
|
|
||||||
font-weight: 700;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
/*! This is now redundant with above position-based styling */
|
|
||||||
/*!
|
|
||||||
table.documentation-table .value-name {
|
|
||||||
font-weight: bold;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
table.documentation-table .value-type {
|
|
||||||
font-size: x-small;
|
|
||||||
color: purple;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
table.documentation-table .value-separator {
|
|
||||||
font-size: x-small;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
table.documentation-table .value-required {
|
|
||||||
font-size: x-small;
|
|
||||||
color: red;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
.value-added-in {
|
|
||||||
font-size: x-small;
|
|
||||||
font-style: italic;
|
|
||||||
color: green;
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
/*! Ansible-specific CSS pulled out of rtd theme for 2.9 */
|
|
||||||
.DocSiteProduct-header {
|
|
||||||
flex: 1;
|
|
||||||
-webkit-flex: 1;
|
|
||||||
padding: 10px 20px 20px;
|
|
||||||
display: flex;
|
|
||||||
display: -webkit-flex;
|
|
||||||
flex-direction: column;
|
|
||||||
-webkit-flex-direction: column;
|
|
||||||
align-items: center;
|
|
||||||
-webkit-align-items: center;
|
|
||||||
justify-content: flex-start;
|
|
||||||
-webkit-justify-content: flex-start;
|
|
||||||
margin-left: 20px;
|
|
||||||
margin-right: 20px;
|
|
||||||
text-decoration: none;
|
|
||||||
font-weight: 400;
|
|
||||||
font-family: "Open Sans", sans-serif;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-header:active,
|
|
||||||
.DocSiteProduct-header:focus,
|
|
||||||
.DocSiteProduct-header:visited {
|
|
||||||
color: #fff;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-header--core {
|
|
||||||
font-size: 25px;
|
|
||||||
background-color: #5bbdbf;
|
|
||||||
border: 2px solid #5bbdbf;
|
|
||||||
border-top-left-radius: 4px;
|
|
||||||
border-top-right-radius: 4px;
|
|
||||||
color: #fff;
|
|
||||||
padding-left: 2px;
|
|
||||||
margin-left: 2px;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-headerAlign {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-logo {
|
|
||||||
width: 60px;
|
|
||||||
height: 60px;
|
|
||||||
margin-bottom: -9px;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-logoText {
|
|
||||||
margin-top: 6px;
|
|
||||||
font-size: 25px;
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
.DocSiteProduct-CheckVersionPara {
|
|
||||||
margin-left: 2px;
|
|
||||||
padding-bottom: 4px;
|
|
||||||
margin-right: 2px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
/*! Ansible color scheme */
|
|
||||||
.wy-nav-top,
|
|
||||||
.wy-side-nav-search {
|
|
||||||
background-color: #5bbdbf;
|
|
||||||
}
|
|
||||||
.wy-menu-vertical header,
|
|
||||||
.wy-menu-vertical p.caption {
|
|
||||||
color: #5bbdbf;
|
|
||||||
}
|
|
||||||
.wy-menu-vertical a {
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
.wy-menu-vertical a.reference.internal {
|
|
||||||
padding: 0.4045em 1.618em;
|
|
||||||
}
|
|
||||||
/*! Override sphinx rtd theme max-with of 800px */
|
|
||||||
.wy-nav-content {
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
/*!
|
|
||||||
* Override sphinx_rtd_theme - keeps left-nav from overwriting
|
|
||||||
* Documentation title
|
|
||||||
**/
|
|
||||||
.wy-nav-side {
|
|
||||||
top: 45px;
|
|
||||||
}
|
|
||||||
/*!
|
|
||||||
* Ansible - changed absolute to relative to remove extraneous side scroll bar
|
|
||||||
**/
|
|
||||||
.wy-grid-for-nav {
|
|
||||||
position: relative;
|
|
||||||
}
|
|
||||||
/*! Ansible narrow the search box */
|
|
||||||
.wy-side-nav-search input[type="text"] {
|
|
||||||
width: 90%;
|
|
||||||
padding-left: 24px;
|
|
||||||
}
|
|
||||||
/*! Ansible - remove so highlight indenting is correct */
|
|
||||||
.rst-content .highlighted {
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
.DocSiteBanner {
|
|
||||||
display: flex;
|
|
||||||
display: -webkit-flex;
|
|
||||||
justify-content: center;
|
|
||||||
-webkit-justify-content: center;
|
|
||||||
flex-wrap: wrap;
|
|
||||||
-webkit-flex-wrap: wrap;
|
|
||||||
margin-bottom: 25px;
|
|
||||||
}
|
|
||||||
.DocSiteBanner-imgWrapper {
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
td,
|
|
||||||
th {
|
|
||||||
min-width: 100px;
|
|
||||||
}
|
|
||||||
table {
|
|
||||||
overflow-x: auto;
|
|
||||||
max-width: 100%;
|
|
||||||
}
|
|
||||||
.documentation-table td,
|
|
||||||
.documentation-table th {
|
|
||||||
padding: 4px;
|
|
||||||
border-left: 1px solid #000;
|
|
||||||
border-top: 1px solid #000;
|
|
||||||
}
|
|
||||||
.documentation-table {
|
|
||||||
border-right: 1px solid #000;
|
|
||||||
border-bottom: 1px solid #000;
|
|
||||||
}
|
|
||||||
@media print {
|
|
||||||
* {
|
|
||||||
background: 0 0 !important;
|
|
||||||
color: #000 !important;
|
|
||||||
text-shadow: none !important;
|
|
||||||
filter: none !important;
|
|
||||||
-ms-filter: none !important;
|
|
||||||
}
|
|
||||||
#nav,
|
|
||||||
a,
|
|
||||||
a:visited {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
a[href]:after {
|
|
||||||
content: " (" attr(href) ")";
|
|
||||||
}
|
|
||||||
abbr[title]:after {
|
|
||||||
content: " (" attr(title) ")";
|
|
||||||
}
|
|
||||||
.ir a:after,
|
|
||||||
a[href^="javascript:"]:after,
|
|
||||||
a[href^="#"]:after {
|
|
||||||
content: "";
|
|
||||||
}
|
|
||||||
/*! Don't show links for images, or javascript/internal links */
|
|
||||||
pre,
|
|
||||||
blockquote {
|
|
||||||
border: 0 solid #999;
|
|
||||||
page-break-inside: avoid;
|
|
||||||
}
|
|
||||||
thead {
|
|
||||||
display: table-header-group;
|
|
||||||
}
|
|
||||||
/*! h5bp.com/t */
|
|
||||||
tr,
|
|
||||||
img {
|
|
||||||
page-break-inside: avoid;
|
|
||||||
}
|
|
||||||
img {
|
|
||||||
max-width: 100% !important;
|
|
||||||
}
|
|
||||||
@page {
|
|
||||||
margin: 0.5cm;
|
|
||||||
}
|
|
||||||
h2,
|
|
||||||
h3,
|
|
||||||
p {
|
|
||||||
orphans: 3;
|
|
||||||
widows: 3;
|
|
||||||
}
|
|
||||||
h2,
|
|
||||||
h3 {
|
|
||||||
page-break-after: avoid;
|
|
||||||
}
|
|
||||||
#google_image_div,
|
|
||||||
.DocSiteBanner {
|
|
||||||
display: none !important;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#sideBanner,
|
|
||||||
.DocSite-globalNav {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
.DocSite-sideNav {
|
|
||||||
display: block;
|
|
||||||
margin-bottom: 40px;
|
|
||||||
}
|
|
||||||
.DocSite-nav {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
.ansibleNav {
|
|
||||||
background: #000;
|
|
||||||
padding: 0 20px;
|
|
||||||
width: auto;
|
|
||||||
border-bottom: 1px solid #444;
|
|
||||||
font-size: 14px;
|
|
||||||
z-index: 1;
|
|
||||||
}
|
|
||||||
.ansibleNav ul {
|
|
||||||
list-style: none;
|
|
||||||
padding-left: 0;
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li {
|
|
||||||
padding: 7px 0;
|
|
||||||
border-bottom: 1px solid #444;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li:last-child {
|
|
||||||
border: none;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li a {
|
|
||||||
color: #fff;
|
|
||||||
text-decoration: none;
|
|
||||||
text-transform: uppercase;
|
|
||||||
padding: 6px 0;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li a:hover {
|
|
||||||
color: #5bbdbf;
|
|
||||||
background: 0 0;
|
|
||||||
}
|
|
||||||
h4 {
|
|
||||||
font-size: 105%;
|
|
||||||
}
|
|
||||||
h5 {
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
h6 {
|
|
||||||
font-size: 80%;
|
|
||||||
}
|
|
||||||
@media screen and (min-width: 768px) {
|
|
||||||
.DocSite-globalNav {
|
|
||||||
display: block;
|
|
||||||
position: fixed;
|
|
||||||
}
|
|
||||||
#sideBanner {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
.DocSite-sideNav {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
.DocSite-nav {
|
|
||||||
flex: initial;
|
|
||||||
-webkit-flex: initial;
|
|
||||||
display: flex;
|
|
||||||
display: -webkit-flex;
|
|
||||||
flex-direction: row;
|
|
||||||
-webkit-flex-direction: row;
|
|
||||||
justify-content: flex-start;
|
|
||||||
-webkit-justify-content: flex-start;
|
|
||||||
padding: 15px;
|
|
||||||
background-color: #000;
|
|
||||||
text-decoration: none;
|
|
||||||
font-family: "Open Sans", sans-serif;
|
|
||||||
}
|
|
||||||
.DocSiteNav-logo {
|
|
||||||
width: 28px;
|
|
||||||
height: 28px;
|
|
||||||
margin-right: 8px;
|
|
||||||
margin-top: -6px;
|
|
||||||
position: fixed;
|
|
||||||
z-index: 1;
|
|
||||||
}
|
|
||||||
.DocSiteNav-title {
|
|
||||||
color: #fff;
|
|
||||||
font-size: 20px;
|
|
||||||
position: fixed;
|
|
||||||
margin-left: 40px;
|
|
||||||
margin-top: -4px;
|
|
||||||
z-index: 1;
|
|
||||||
}
|
|
||||||
.ansibleNav {
|
|
||||||
height: 45px;
|
|
||||||
width: 100%;
|
|
||||||
font-size: 13px;
|
|
||||||
padding: 0 60px 0 0;
|
|
||||||
}
|
|
||||||
.ansibleNav ul {
|
|
||||||
float: right;
|
|
||||||
display: flex;
|
|
||||||
flex-wrap: nowrap;
|
|
||||||
margin-top: 13px;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li {
|
|
||||||
padding: 0;
|
|
||||||
border-bottom: none;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li a {
|
|
||||||
color: #fff;
|
|
||||||
text-decoration: none;
|
|
||||||
text-transform: uppercase;
|
|
||||||
padding: 8px 13px;
|
|
||||||
}
|
|
||||||
h4 {
|
|
||||||
font-size: 105%;
|
|
||||||
}
|
|
||||||
h5 {
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
h6 {
|
|
||||||
font-size: 80%;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media screen and (min-width: 768px) {
|
|
||||||
#sideBanner,
|
|
||||||
.DocSite-globalNav {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
.DocSite-sideNav {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
.DocSite-nav {
|
|
||||||
flex: initial;
|
|
||||||
-webkit-flex: initial;
|
|
||||||
display: flex;
|
|
||||||
display: -webkit-flex;
|
|
||||||
flex-direction: row;
|
|
||||||
-webkit-flex-direction: row;
|
|
||||||
justify-content: flex-start;
|
|
||||||
-webkit-justify-content: flex-start;
|
|
||||||
padding: 15px;
|
|
||||||
background-color: #000;
|
|
||||||
text-decoration: none;
|
|
||||||
font-family: "Open Sans", sans-serif;
|
|
||||||
}
|
|
||||||
.DocSiteNav-logo {
|
|
||||||
width: 28px;
|
|
||||||
height: 28px;
|
|
||||||
margin-right: 8px;
|
|
||||||
margin-top: -6px;
|
|
||||||
position: fixed;
|
|
||||||
}
|
|
||||||
.DocSiteNav-title {
|
|
||||||
color: #fff;
|
|
||||||
font-size: 20px;
|
|
||||||
position: fixed;
|
|
||||||
margin-left: 40px;
|
|
||||||
margin-top: -4px;
|
|
||||||
}
|
|
||||||
.ansibleNav {
|
|
||||||
height: 45px;
|
|
||||||
font-size: 13px;
|
|
||||||
padding: 0 60px 0 0;
|
|
||||||
}
|
|
||||||
.ansibleNav ul {
|
|
||||||
float: right;
|
|
||||||
display: flex;
|
|
||||||
flex-wrap: nowrap;
|
|
||||||
margin-top: 13px;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li {
|
|
||||||
padding: 0;
|
|
||||||
border-bottom: none;
|
|
||||||
}
|
|
||||||
.ansibleNav ul li a {
|
|
||||||
color: #fff;
|
|
||||||
text-decoration: none;
|
|
||||||
text-transform: uppercase;
|
|
||||||
padding: 8px 13px;
|
|
||||||
}
|
|
||||||
h4 {
|
|
||||||
font-size: 105%;
|
|
||||||
}
|
|
||||||
h5 {
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
h6 {
|
|
||||||
font-size: 80%;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/* ansibleOptionLink is adapted from h1 .headerlink in sphinx_rtd_theme */
|
|
||||||
/* This definition lives in the antsibull Sphinx extension; we update it here to use the icon from FontAwesome */
|
|
||||||
/* https://github.com/ansible-community/antsibull/blob/main/sphinx_antsibull_ext/css/antsibull-minimal.scss */
|
|
||||||
tr .ansibleOptionLink::after {
|
|
||||||
content: "" !important;
|
|
||||||
font-family: FontAwesome;
|
|
||||||
}
|
|
||||||
tr .ansibleOptionLink {
|
|
||||||
font: normal normal normal 14px/1 FontAwesome;
|
|
||||||
text-rendering: auto;
|
|
||||||
-webkit-font-smoothing: antialiased;
|
|
||||||
-moz-osx-font-smoothing: grayscale;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media screen and (min-width: 767px) {
|
|
||||||
/* Move anchors a bit up so that they aren't hidden by the header bar */
|
|
||||||
section [id] {
|
|
||||||
padding-top: 45px;
|
|
||||||
margin-top: -45px;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Without this,
|
|
||||||
* for example most links in the page's TOC aren't usable anymore, and tables
|
|
||||||
* sometimes overlap the text above
|
|
||||||
* */
|
|
||||||
section a[id], section table[id] {
|
|
||||||
padding-top: 0;
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Assure reading examples does not require horizontal scrolling */
|
|
||||||
.rst-content div[class^="highlight"] pre {
|
|
||||||
white-space: pre-wrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
.rst-content dl dt { margin-bottom: 0; }
|
|
||||||
|
|
||||||
/*! Make sure that environment variable links are blue */
|
|
||||||
.rst-content code.xref.std-envvar { color: #2980b9; }
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load diff
|
Before Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,4 +0,0 @@
|
||||||
.ethical-sidebar,
|
|
||||||
.ethical-footer {
|
|
||||||
border-radius: 0 !important;
|
|
||||||
}
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,156 +0,0 @@
|
||||||
/*
|
|
||||||
* doctools.js
|
|
||||||
* ~~~~~~~~~~~
|
|
||||||
*
|
|
||||||
* Base JavaScript utilities for all Sphinx HTML documentation.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
|
|
||||||
"TEXTAREA",
|
|
||||||
"INPUT",
|
|
||||||
"SELECT",
|
|
||||||
"BUTTON",
|
|
||||||
]);
|
|
||||||
|
|
||||||
const _ready = (callback) => {
|
|
||||||
if (document.readyState !== "loading") {
|
|
||||||
callback();
|
|
||||||
} else {
|
|
||||||
document.addEventListener("DOMContentLoaded", callback);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Small JavaScript module for the documentation.
|
|
||||||
*/
|
|
||||||
const Documentation = {
|
|
||||||
init: () => {
|
|
||||||
Documentation.initDomainIndexTable();
|
|
||||||
Documentation.initOnKeyListeners();
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* i18n support
|
|
||||||
*/
|
|
||||||
TRANSLATIONS: {},
|
|
||||||
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
|
|
||||||
LOCALE: "unknown",
|
|
||||||
|
|
||||||
// gettext and ngettext don't access this so that the functions
|
|
||||||
// can safely bound to a different name (_ = Documentation.gettext)
|
|
||||||
gettext: (string) => {
|
|
||||||
const translated = Documentation.TRANSLATIONS[string];
|
|
||||||
switch (typeof translated) {
|
|
||||||
case "undefined":
|
|
||||||
return string; // no translation
|
|
||||||
case "string":
|
|
||||||
return translated; // translation exists
|
|
||||||
default:
|
|
||||||
return translated[0]; // (singular, plural) translation tuple exists
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
ngettext: (singular, plural, n) => {
|
|
||||||
const translated = Documentation.TRANSLATIONS[singular];
|
|
||||||
if (typeof translated !== "undefined")
|
|
||||||
return translated[Documentation.PLURAL_EXPR(n)];
|
|
||||||
return n === 1 ? singular : plural;
|
|
||||||
},
|
|
||||||
|
|
||||||
addTranslations: (catalog) => {
|
|
||||||
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
|
|
||||||
Documentation.PLURAL_EXPR = new Function(
|
|
||||||
"n",
|
|
||||||
`return (${catalog.plural_expr})`
|
|
||||||
);
|
|
||||||
Documentation.LOCALE = catalog.locale;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* helper function to focus on search bar
|
|
||||||
*/
|
|
||||||
focusSearchBar: () => {
|
|
||||||
document.querySelectorAll("input[name=q]")[0]?.focus();
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initialise the domain index toggle buttons
|
|
||||||
*/
|
|
||||||
initDomainIndexTable: () => {
|
|
||||||
const toggler = (el) => {
|
|
||||||
const idNumber = el.id.substr(7);
|
|
||||||
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
|
|
||||||
if (el.src.substr(-9) === "minus.png") {
|
|
||||||
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
|
|
||||||
toggledRows.forEach((el) => (el.style.display = "none"));
|
|
||||||
} else {
|
|
||||||
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
|
|
||||||
toggledRows.forEach((el) => (el.style.display = ""));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const togglerElements = document.querySelectorAll("img.toggler");
|
|
||||||
togglerElements.forEach((el) =>
|
|
||||||
el.addEventListener("click", (event) => toggler(event.currentTarget))
|
|
||||||
);
|
|
||||||
togglerElements.forEach((el) => (el.style.display = ""));
|
|
||||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
|
|
||||||
},
|
|
||||||
|
|
||||||
initOnKeyListeners: () => {
|
|
||||||
// only install a listener if it is really needed
|
|
||||||
if (
|
|
||||||
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
|
|
||||||
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
|
||||||
)
|
|
||||||
return;
|
|
||||||
|
|
||||||
document.addEventListener("keydown", (event) => {
|
|
||||||
// bail for input elements
|
|
||||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
|
||||||
// bail with special keys
|
|
||||||
if (event.altKey || event.ctrlKey || event.metaKey) return;
|
|
||||||
|
|
||||||
if (!event.shiftKey) {
|
|
||||||
switch (event.key) {
|
|
||||||
case "ArrowLeft":
|
|
||||||
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
|
||||||
|
|
||||||
const prevLink = document.querySelector('link[rel="prev"]');
|
|
||||||
if (prevLink && prevLink.href) {
|
|
||||||
window.location.href = prevLink.href;
|
|
||||||
event.preventDefault();
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case "ArrowRight":
|
|
||||||
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
|
|
||||||
|
|
||||||
const nextLink = document.querySelector('link[rel="next"]');
|
|
||||||
if (nextLink && nextLink.href) {
|
|
||||||
window.location.href = nextLink.href;
|
|
||||||
event.preventDefault();
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// some keyboard layouts may need Shift to get /
|
|
||||||
switch (event.key) {
|
|
||||||
case "/":
|
|
||||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
|
||||||
Documentation.focusSearchBar();
|
|
||||||
event.preventDefault();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// quick alias for translations
|
|
||||||
const _ = Documentation.gettext;
|
|
||||||
|
|
||||||
_ready(Documentation.init);
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
var DOCUMENTATION_OPTIONS = {
|
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
|
||||||
VERSION: '',
|
|
||||||
LANGUAGE: 'en',
|
|
||||||
COLLAPSE_INDEX: false,
|
|
||||||
BUILDER: 'html',
|
|
||||||
FILE_SUFFIX: '.html',
|
|
||||||
LINK_SUFFIX: '.html',
|
|
||||||
HAS_SOURCE: false,
|
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
|
||||||
NAVIGATION_WITH_KEYS: false,
|
|
||||||
SHOW_SEARCH_SUMMARY: true,
|
|
||||||
ENABLE_SEARCH_SHORTCUTS: true,
|
|
||||||
};
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 286 B |
Binary file not shown.
|
Before Width: | Height: | Size: 8.5 KiB |
|
|
@ -1,14 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<!-- Generator: Adobe Illustrator 21.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
|
||||||
<svg version="1.1" id="logo" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
|
||||||
viewBox="30 30 240 240" style="enable-background:new 0 0 300 300;" xml:space="preserve">
|
|
||||||
<style type="text/css">
|
|
||||||
.st0{fill:#FFFFFF;}
|
|
||||||
</style>
|
|
||||||
<title>Ansible-Mark-RGB</title>
|
|
||||||
<path d="M259.8,152.9c0,59-47.8,106.8-106.8,106.8c-59,0-106.8-47.8-106.8-106.8S94,46.1,153,46.1c0,0,0,0,0,0
|
|
||||||
C212,46.1,259.8,93.9,259.8,152.9C259.8,152.9,259.8,152.9,259.8,152.9"/>
|
|
||||||
<path class="st0" d="M154.8,112.9l27.6,68.2l-41.7-32.9L154.8,112.9z M203.9,196.8L161.4,94.5c-1-2.8-3.7-4.6-6.6-4.5
|
|
||||||
c-3-0.1-5.7,1.7-6.8,4.5l-46.7,112.2h16l18.5-46.3l55.1,44.5c2.2,1.8,3.8,2.6,5.9,2.6c4.2,0.1,7.7-3.2,7.8-7.4c0-0.1,0-0.1,0-0.2
|
|
||||||
C204.6,198.9,204.3,197.8,203.9,196.8"/>
|
|
||||||
</svg>
|
|
||||||
|
Before Width: | Height: | Size: 904 B |
Binary file not shown.
|
Before Width: | Height: | Size: 5.1 KiB |
|
|
@ -1 +0,0 @@
|
||||||
<svg id="logo" xmlns="http://www.w3.org/2000/svg" viewBox="30 30 240 240"><title>Ansible-Mark-RGB</title><polygon points="140.692 148.221 182.438 181.102 154.799 112.893 140.692 148.221" fill="#fff"/><path d="M153,46.12714A106.79132,106.79132,0,1,0,259.79286,152.92,106.79751,106.79751,0,0,0,153,46.12714Zm43.82007,161.46533c-2.08093,0-3.67822-.81091-5.89673-2.60413l-55.1178-44.52991-18.46741,46.268h-15.9613L148.03346,94.51422a7.08784,7.08784,0,0,1,6.76587-4.51355,6.85643,6.85643,0,0,1,6.58521,4.51355l42.51025,102.30072a10.11133,10.11133,0,0,1,.72827,3.1488A7.62408,7.62408,0,0,1,196.82008,207.59247Z" fill="#fff"/></svg>
|
|
||||||
|
Before Width: | Height: | Size: 626 B |
|
|
@ -1 +0,0 @@
|
||||||
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
|
||||||
4
pr/104/_static/js/html5shiv-printshiv.min.js
vendored
4
pr/104/_static/js/html5shiv-printshiv.min.js
vendored
|
|
@ -1,4 +0,0 @@
|
||||||
/**
|
|
||||||
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
|
||||||
*/
|
|
||||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
|
|
||||||
4
pr/104/_static/js/html5shiv.min.js
vendored
4
pr/104/_static/js/html5shiv.min.js
vendored
|
|
@ -1,4 +0,0 @@
|
||||||
/**
|
|
||||||
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
|
||||||
*/
|
|
||||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,199 +0,0 @@
|
||||||
/*
|
|
||||||
* language_data.js
|
|
||||||
* ~~~~~~~~~~~~~~~~
|
|
||||||
*
|
|
||||||
* This script contains the language-specific data used by searchtools.js,
|
|
||||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
|
|
||||||
|
|
||||||
|
|
||||||
/* Non-minified version is copied as a separate JS file, is available */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Porter Stemmer
|
|
||||||
*/
|
|
||||||
var Stemmer = function() {
|
|
||||||
|
|
||||||
var step2list = {
|
|
||||||
ational: 'ate',
|
|
||||||
tional: 'tion',
|
|
||||||
enci: 'ence',
|
|
||||||
anci: 'ance',
|
|
||||||
izer: 'ize',
|
|
||||||
bli: 'ble',
|
|
||||||
alli: 'al',
|
|
||||||
entli: 'ent',
|
|
||||||
eli: 'e',
|
|
||||||
ousli: 'ous',
|
|
||||||
ization: 'ize',
|
|
||||||
ation: 'ate',
|
|
||||||
ator: 'ate',
|
|
||||||
alism: 'al',
|
|
||||||
iveness: 'ive',
|
|
||||||
fulness: 'ful',
|
|
||||||
ousness: 'ous',
|
|
||||||
aliti: 'al',
|
|
||||||
iviti: 'ive',
|
|
||||||
biliti: 'ble',
|
|
||||||
logi: 'log'
|
|
||||||
};
|
|
||||||
|
|
||||||
var step3list = {
|
|
||||||
icate: 'ic',
|
|
||||||
ative: '',
|
|
||||||
alize: 'al',
|
|
||||||
iciti: 'ic',
|
|
||||||
ical: 'ic',
|
|
||||||
ful: '',
|
|
||||||
ness: ''
|
|
||||||
};
|
|
||||||
|
|
||||||
var c = "[^aeiou]"; // consonant
|
|
||||||
var v = "[aeiouy]"; // vowel
|
|
||||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
|
||||||
var V = v + "[aeiou]*"; // vowel sequence
|
|
||||||
|
|
||||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
|
||||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
|
||||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
|
||||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
|
||||||
|
|
||||||
this.stemWord = function (w) {
|
|
||||||
var stem;
|
|
||||||
var suffix;
|
|
||||||
var firstch;
|
|
||||||
var origword = w;
|
|
||||||
|
|
||||||
if (w.length < 3)
|
|
||||||
return w;
|
|
||||||
|
|
||||||
var re;
|
|
||||||
var re2;
|
|
||||||
var re3;
|
|
||||||
var re4;
|
|
||||||
|
|
||||||
firstch = w.substr(0,1);
|
|
||||||
if (firstch == "y")
|
|
||||||
w = firstch.toUpperCase() + w.substr(1);
|
|
||||||
|
|
||||||
// Step 1a
|
|
||||||
re = /^(.+?)(ss|i)es$/;
|
|
||||||
re2 = /^(.+?)([^s])s$/;
|
|
||||||
|
|
||||||
if (re.test(w))
|
|
||||||
w = w.replace(re,"$1$2");
|
|
||||||
else if (re2.test(w))
|
|
||||||
w = w.replace(re2,"$1$2");
|
|
||||||
|
|
||||||
// Step 1b
|
|
||||||
re = /^(.+?)eed$/;
|
|
||||||
re2 = /^(.+?)(ed|ing)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(fp[1])) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (re2.test(w)) {
|
|
||||||
var fp = re2.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re2 = new RegExp(s_v);
|
|
||||||
if (re2.test(stem)) {
|
|
||||||
w = stem;
|
|
||||||
re2 = /(at|bl|iz)$/;
|
|
||||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
|
||||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
|
||||||
if (re2.test(w))
|
|
||||||
w = w + "e";
|
|
||||||
else if (re3.test(w)) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
else if (re4.test(w))
|
|
||||||
w = w + "e";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 1c
|
|
||||||
re = /^(.+?)y$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(s_v);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + "i";
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 2
|
|
||||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
suffix = fp[2];
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + step2list[suffix];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 3
|
|
||||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
suffix = fp[2];
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + step3list[suffix];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 4
|
|
||||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
|
||||||
re2 = /^(.+?)(s|t)(ion)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(mgr1);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
else if (re2.test(w)) {
|
|
||||||
var fp = re2.exec(w);
|
|
||||||
stem = fp[1] + fp[2];
|
|
||||||
re2 = new RegExp(mgr1);
|
|
||||||
if (re2.test(stem))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 5
|
|
||||||
re = /^(.+?)e$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(mgr1);
|
|
||||||
re2 = new RegExp(meq1);
|
|
||||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
|
||||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
re = /ll$/;
|
|
||||||
re2 = new RegExp(mgr1);
|
|
||||||
if (re.test(w) && re2.test(w)) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
|
|
||||||
// and turn initial Y back to y
|
|
||||||
if (firstch == "y")
|
|
||||||
w = firstch.toLowerCase() + w.substr(1);
|
|
||||||
return w;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
|
|
@ -1,81 +0,0 @@
|
||||||
pre { line-height: 125%; }
|
|
||||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
|
||||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
|
||||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
|
||||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
|
||||||
.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block }
|
|
||||||
.highlight { background: #f8f8f8; }
|
|
||||||
.highlight .c { color: #6a737d; font-style: italic } /* Comment */
|
|
||||||
.highlight .err { color: #a61717; background-color: #e3d2d2; border: 1px solid #FF0000 } /* Error */
|
|
||||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
|
||||||
.highlight .l { color: #032f62 } /* Literal */
|
|
||||||
.highlight .n { color: #333333 } /* Name */
|
|
||||||
.highlight .o { color: #666666; font-weight: bold } /* Operator */
|
|
||||||
.highlight .p { font-weight: bold } /* Punctuation */
|
|
||||||
.highlight .ch { color: #6a737d; font-style: italic } /* Comment.Hashbang */
|
|
||||||
.highlight .cm { color: #6a737d; font-style: italic } /* Comment.Multiline */
|
|
||||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
|
||||||
.highlight .cpf { color: #6a737d; font-style: italic } /* Comment.PreprocFile */
|
|
||||||
.highlight .c1 { color: #6a737d; font-style: italic } /* Comment.Single */
|
|
||||||
.highlight .cs { color: #999999; font-weight: bold; font-style: italic; background-color: #fff0f0 } /* Comment.Special */
|
|
||||||
.highlight .gd { color: #A00000; background-color: #ffdddd } /* Generic.Deleted */
|
|
||||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
|
||||||
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
|
||||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
|
||||||
.highlight .gi { color: #00A000; background-color: #ddffdd } /* Generic.Inserted */
|
|
||||||
.highlight .go { color: #333333 } /* Generic.Output */
|
|
||||||
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
|
||||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
|
||||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
|
||||||
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
|
|
||||||
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
|
|
||||||
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
|
|
||||||
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
|
|
||||||
.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */
|
|
||||||
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
|
||||||
.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */
|
|
||||||
.highlight .ld { color: #032f62 } /* Literal.Date */
|
|
||||||
.highlight .m { color: #208050 } /* Literal.Number */
|
|
||||||
.highlight .s { color: #4070a0 } /* Literal.String */
|
|
||||||
.highlight .na { color: #008080 } /* Name.Attribute */
|
|
||||||
.highlight .nb { color: #0086b3 } /* Name.Builtin */
|
|
||||||
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
|
||||||
.highlight .no { color: #008080 } /* Name.Constant */
|
|
||||||
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
|
||||||
.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */
|
|
||||||
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
|
||||||
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
|
||||||
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
|
|
||||||
.highlight .nn { color: #555555; font-weight: bold } /* Name.Namespace */
|
|
||||||
.highlight .nx { color: #333333 } /* Name.Other */
|
|
||||||
.highlight .py { color: #333333 } /* Name.Property */
|
|
||||||
.highlight .nt { color: #22863a; font-weight: bold } /* Name.Tag */
|
|
||||||
.highlight .nv { color: #9960b5; font-weight: bold } /* Name.Variable */
|
|
||||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
|
||||||
.highlight .pm { font-weight: bold } /* Punctuation.Marker */
|
|
||||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
|
||||||
.highlight .mb { color: #009999 } /* Literal.Number.Bin */
|
|
||||||
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
|
||||||
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
|
||||||
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
|
||||||
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
|
||||||
.highlight .sa { color: #dd1144 } /* Literal.String.Affix */
|
|
||||||
.highlight .sb { color: #dd1144 } /* Literal.String.Backtick */
|
|
||||||
.highlight .sc { color: #dd1144 } /* Literal.String.Char */
|
|
||||||
.highlight .dl { color: #dd1144 } /* Literal.String.Delimiter */
|
|
||||||
.highlight .sd { color: #dd1144; font-style: italic } /* Literal.String.Doc */
|
|
||||||
.highlight .s2 { color: #dd1144 } /* Literal.String.Double */
|
|
||||||
.highlight .se { color: #dd1144; font-weight: bold } /* Literal.String.Escape */
|
|
||||||
.highlight .sh { color: #dd1144 } /* Literal.String.Heredoc */
|
|
||||||
.highlight .si { color: #dd1144; font-style: italic } /* Literal.String.Interpol */
|
|
||||||
.highlight .sx { color: #dd1144 } /* Literal.String.Other */
|
|
||||||
.highlight .sr { color: #009926 } /* Literal.String.Regex */
|
|
||||||
.highlight .s1 { color: #dd1144 } /* Literal.String.Single */
|
|
||||||
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
|
|
||||||
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
|
||||||
.highlight .fm { color: #06287e; font-weight: bold } /* Name.Function.Magic */
|
|
||||||
.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */
|
|
||||||
.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */
|
|
||||||
.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */
|
|
||||||
.highlight .vm { color: #bb60d5; font-weight: bold } /* Name.Variable.Magic */
|
|
||||||
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
|
||||||
|
|
@ -1,566 +0,0 @@
|
||||||
/*
|
|
||||||
* searchtools.js
|
|
||||||
* ~~~~~~~~~~~~~~~~
|
|
||||||
*
|
|
||||||
* Sphinx JavaScript utilities for the full-text search.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Simple result scoring code.
|
|
||||||
*/
|
|
||||||
if (typeof Scorer === "undefined") {
|
|
||||||
var Scorer = {
|
|
||||||
// Implement the following function to further tweak the score for each result
|
|
||||||
// The function takes a result array [docname, title, anchor, descr, score, filename]
|
|
||||||
// and returns the new score.
|
|
||||||
/*
|
|
||||||
score: result => {
|
|
||||||
const [docname, title, anchor, descr, score, filename] = result
|
|
||||||
return score
|
|
||||||
},
|
|
||||||
*/
|
|
||||||
|
|
||||||
// query matches the full name of an object
|
|
||||||
objNameMatch: 11,
|
|
||||||
// or matches in the last dotted part of the object name
|
|
||||||
objPartialMatch: 6,
|
|
||||||
// Additive scores depending on the priority of the object
|
|
||||||
objPrio: {
|
|
||||||
0: 15, // used to be importantResults
|
|
||||||
1: 5, // used to be objectResults
|
|
||||||
2: -5, // used to be unimportantResults
|
|
||||||
},
|
|
||||||
// Used when the priority is not in the mapping.
|
|
||||||
objPrioDefault: 0,
|
|
||||||
|
|
||||||
// query found in title
|
|
||||||
title: 15,
|
|
||||||
partialTitle: 7,
|
|
||||||
// query found in terms
|
|
||||||
term: 5,
|
|
||||||
partialTerm: 2,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const _removeChildren = (element) => {
|
|
||||||
while (element && element.lastChild) element.removeChild(element.lastChild);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
|
|
||||||
*/
|
|
||||||
const _escapeRegExp = (string) =>
|
|
||||||
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
|
|
||||||
|
|
||||||
const _displayItem = (item, searchTerms) => {
|
|
||||||
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
|
|
||||||
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
|
|
||||||
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
|
||||||
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
|
||||||
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
|
|
||||||
|
|
||||||
const [docName, title, anchor, descr, score, _filename] = item;
|
|
||||||
|
|
||||||
let listItem = document.createElement("li");
|
|
||||||
let requestUrl;
|
|
||||||
let linkUrl;
|
|
||||||
if (docBuilder === "dirhtml") {
|
|
||||||
// dirhtml builder
|
|
||||||
let dirname = docName + "/";
|
|
||||||
if (dirname.match(/\/index\/$/))
|
|
||||||
dirname = dirname.substring(0, dirname.length - 6);
|
|
||||||
else if (dirname === "index/") dirname = "";
|
|
||||||
requestUrl = docUrlRoot + dirname;
|
|
||||||
linkUrl = requestUrl;
|
|
||||||
} else {
|
|
||||||
// normal html builders
|
|
||||||
requestUrl = docUrlRoot + docName + docFileSuffix;
|
|
||||||
linkUrl = docName + docLinkSuffix;
|
|
||||||
}
|
|
||||||
let linkEl = listItem.appendChild(document.createElement("a"));
|
|
||||||
linkEl.href = linkUrl + anchor;
|
|
||||||
linkEl.dataset.score = score;
|
|
||||||
linkEl.innerHTML = title;
|
|
||||||
if (descr)
|
|
||||||
listItem.appendChild(document.createElement("span")).innerHTML =
|
|
||||||
" (" + descr + ")";
|
|
||||||
else if (showSearchSummary)
|
|
||||||
fetch(requestUrl)
|
|
||||||
.then((responseData) => responseData.text())
|
|
||||||
.then((data) => {
|
|
||||||
if (data)
|
|
||||||
listItem.appendChild(
|
|
||||||
Search.makeSearchSummary(data, searchTerms)
|
|
||||||
);
|
|
||||||
});
|
|
||||||
Search.output.appendChild(listItem);
|
|
||||||
};
|
|
||||||
const _finishSearch = (resultCount) => {
|
|
||||||
Search.stopPulse();
|
|
||||||
Search.title.innerText = _("Search Results");
|
|
||||||
if (!resultCount)
|
|
||||||
Search.status.innerText = Documentation.gettext(
|
|
||||||
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
|
|
||||||
);
|
|
||||||
else
|
|
||||||
Search.status.innerText = _(
|
|
||||||
`Search finished, found ${resultCount} page(s) matching the search query.`
|
|
||||||
);
|
|
||||||
};
|
|
||||||
const _displayNextItem = (
|
|
||||||
results,
|
|
||||||
resultCount,
|
|
||||||
searchTerms
|
|
||||||
) => {
|
|
||||||
// results left, load the summary and display it
|
|
||||||
// this is intended to be dynamic (don't sub resultsCount)
|
|
||||||
if (results.length) {
|
|
||||||
_displayItem(results.pop(), searchTerms);
|
|
||||||
setTimeout(
|
|
||||||
() => _displayNextItem(results, resultCount, searchTerms),
|
|
||||||
5
|
|
||||||
);
|
|
||||||
}
|
|
||||||
// search finished, update title and status message
|
|
||||||
else _finishSearch(resultCount);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
|
|
||||||
* custom function per language.
|
|
||||||
*
|
|
||||||
* The regular expression works by splitting the string on consecutive characters
|
|
||||||
* that are not Unicode letters, numbers, underscores, or emoji characters.
|
|
||||||
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
|
|
||||||
*/
|
|
||||||
if (typeof splitQuery === "undefined") {
|
|
||||||
var splitQuery = (query) => query
|
|
||||||
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
|
|
||||||
.filter(term => term) // remove remaining empty strings
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Search Module
|
|
||||||
*/
|
|
||||||
const Search = {
|
|
||||||
_index: null,
|
|
||||||
_queued_query: null,
|
|
||||||
_pulse_status: -1,
|
|
||||||
|
|
||||||
htmlToText: (htmlString) => {
|
|
||||||
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
|
|
||||||
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
|
|
||||||
const docContent = htmlElement.querySelector('[role="main"]');
|
|
||||||
if (docContent !== undefined) return docContent.textContent;
|
|
||||||
console.warn(
|
|
||||||
"Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
|
|
||||||
);
|
|
||||||
return "";
|
|
||||||
},
|
|
||||||
|
|
||||||
init: () => {
|
|
||||||
const query = new URLSearchParams(window.location.search).get("q");
|
|
||||||
document
|
|
||||||
.querySelectorAll('input[name="q"]')
|
|
||||||
.forEach((el) => (el.value = query));
|
|
||||||
if (query) Search.performSearch(query);
|
|
||||||
},
|
|
||||||
|
|
||||||
loadIndex: (url) =>
|
|
||||||
(document.body.appendChild(document.createElement("script")).src = url),
|
|
||||||
|
|
||||||
setIndex: (index) => {
|
|
||||||
Search._index = index;
|
|
||||||
if (Search._queued_query !== null) {
|
|
||||||
const query = Search._queued_query;
|
|
||||||
Search._queued_query = null;
|
|
||||||
Search.query(query);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
hasIndex: () => Search._index !== null,
|
|
||||||
|
|
||||||
deferQuery: (query) => (Search._queued_query = query),
|
|
||||||
|
|
||||||
stopPulse: () => (Search._pulse_status = -1),
|
|
||||||
|
|
||||||
startPulse: () => {
|
|
||||||
if (Search._pulse_status >= 0) return;
|
|
||||||
|
|
||||||
const pulse = () => {
|
|
||||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
|
||||||
Search.dots.innerText = ".".repeat(Search._pulse_status);
|
|
||||||
if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
|
|
||||||
};
|
|
||||||
pulse();
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* perform a search for something (or wait until index is loaded)
|
|
||||||
*/
|
|
||||||
performSearch: (query) => {
|
|
||||||
// create the required interface elements
|
|
||||||
const searchText = document.createElement("h2");
|
|
||||||
searchText.textContent = _("Searching");
|
|
||||||
const searchSummary = document.createElement("p");
|
|
||||||
searchSummary.classList.add("search-summary");
|
|
||||||
searchSummary.innerText = "";
|
|
||||||
const searchList = document.createElement("ul");
|
|
||||||
searchList.classList.add("search");
|
|
||||||
|
|
||||||
const out = document.getElementById("search-results");
|
|
||||||
Search.title = out.appendChild(searchText);
|
|
||||||
Search.dots = Search.title.appendChild(document.createElement("span"));
|
|
||||||
Search.status = out.appendChild(searchSummary);
|
|
||||||
Search.output = out.appendChild(searchList);
|
|
||||||
|
|
||||||
const searchProgress = document.getElementById("search-progress");
|
|
||||||
// Some themes don't use the search progress node
|
|
||||||
if (searchProgress) {
|
|
||||||
searchProgress.innerText = _("Preparing search...");
|
|
||||||
}
|
|
||||||
Search.startPulse();
|
|
||||||
|
|
||||||
// index already loaded, the browser was quick!
|
|
||||||
if (Search.hasIndex()) Search.query(query);
|
|
||||||
else Search.deferQuery(query);
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* execute search (requires search index to be loaded)
|
|
||||||
*/
|
|
||||||
query: (query) => {
|
|
||||||
const filenames = Search._index.filenames;
|
|
||||||
const docNames = Search._index.docnames;
|
|
||||||
const titles = Search._index.titles;
|
|
||||||
const allTitles = Search._index.alltitles;
|
|
||||||
const indexEntries = Search._index.indexentries;
|
|
||||||
|
|
||||||
// stem the search terms and add them to the correct list
|
|
||||||
const stemmer = new Stemmer();
|
|
||||||
const searchTerms = new Set();
|
|
||||||
const excludedTerms = new Set();
|
|
||||||
const highlightTerms = new Set();
|
|
||||||
const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
|
|
||||||
splitQuery(query.trim()).forEach((queryTerm) => {
|
|
||||||
const queryTermLower = queryTerm.toLowerCase();
|
|
||||||
|
|
||||||
// maybe skip this "word"
|
|
||||||
// stopwords array is from language_data.js
|
|
||||||
if (
|
|
||||||
stopwords.indexOf(queryTermLower) !== -1 ||
|
|
||||||
queryTerm.match(/^\d+$/)
|
|
||||||
)
|
|
||||||
return;
|
|
||||||
|
|
||||||
// stem the word
|
|
||||||
let word = stemmer.stemWord(queryTermLower);
|
|
||||||
// select the correct list
|
|
||||||
if (word[0] === "-") excludedTerms.add(word.substr(1));
|
|
||||||
else {
|
|
||||||
searchTerms.add(word);
|
|
||||||
highlightTerms.add(queryTermLower);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
|
|
||||||
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
|
|
||||||
}
|
|
||||||
|
|
||||||
// console.debug("SEARCH: searching for:");
|
|
||||||
// console.info("required: ", [...searchTerms]);
|
|
||||||
// console.info("excluded: ", [...excludedTerms]);
|
|
||||||
|
|
||||||
// array of [docname, title, anchor, descr, score, filename]
|
|
||||||
let results = [];
|
|
||||||
_removeChildren(document.getElementById("search-progress"));
|
|
||||||
|
|
||||||
const queryLower = query.toLowerCase();
|
|
||||||
for (const [title, foundTitles] of Object.entries(allTitles)) {
|
|
||||||
if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
|
||||||
for (const [file, id] of foundTitles) {
|
|
||||||
let score = Math.round(100 * queryLower.length / title.length)
|
|
||||||
results.push([
|
|
||||||
docNames[file],
|
|
||||||
titles[file] !== title ? `${titles[file]} > ${title}` : title,
|
|
||||||
id !== null ? "#" + id : "",
|
|
||||||
null,
|
|
||||||
score,
|
|
||||||
filenames[file],
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// search for explicit entries in index directives
|
|
||||||
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
|
|
||||||
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
|
|
||||||
for (const [file, id] of foundEntries) {
|
|
||||||
let score = Math.round(100 * queryLower.length / entry.length)
|
|
||||||
results.push([
|
|
||||||
docNames[file],
|
|
||||||
titles[file],
|
|
||||||
id ? "#" + id : "",
|
|
||||||
null,
|
|
||||||
score,
|
|
||||||
filenames[file],
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// lookup as object
|
|
||||||
objectTerms.forEach((term) =>
|
|
||||||
results.push(...Search.performObjectSearch(term, objectTerms))
|
|
||||||
);
|
|
||||||
|
|
||||||
// lookup as search terms in fulltext
|
|
||||||
results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
|
|
||||||
|
|
||||||
// let the scorer override scores with a custom scoring function
|
|
||||||
if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
|
|
||||||
|
|
||||||
// now sort the results by score (in opposite order of appearance, since the
|
|
||||||
// display function below uses pop() to retrieve items) and then
|
|
||||||
// alphabetically
|
|
||||||
results.sort((a, b) => {
|
|
||||||
const leftScore = a[4];
|
|
||||||
const rightScore = b[4];
|
|
||||||
if (leftScore === rightScore) {
|
|
||||||
// same score: sort alphabetically
|
|
||||||
const leftTitle = a[1].toLowerCase();
|
|
||||||
const rightTitle = b[1].toLowerCase();
|
|
||||||
if (leftTitle === rightTitle) return 0;
|
|
||||||
return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
|
|
||||||
}
|
|
||||||
return leftScore > rightScore ? 1 : -1;
|
|
||||||
});
|
|
||||||
|
|
||||||
// remove duplicate search results
|
|
||||||
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
|
|
||||||
let seen = new Set();
|
|
||||||
results = results.reverse().reduce((acc, result) => {
|
|
||||||
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
|
|
||||||
if (!seen.has(resultStr)) {
|
|
||||||
acc.push(result);
|
|
||||||
seen.add(resultStr);
|
|
||||||
}
|
|
||||||
return acc;
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
results = results.reverse();
|
|
||||||
|
|
||||||
// for debugging
|
|
||||||
//Search.lastresults = results.slice(); // a copy
|
|
||||||
// console.info("search results:", Search.lastresults);
|
|
||||||
|
|
||||||
// print the results
|
|
||||||
_displayNextItem(results, results.length, searchTerms);
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* search for object names
|
|
||||||
*/
|
|
||||||
performObjectSearch: (object, objectTerms) => {
|
|
||||||
const filenames = Search._index.filenames;
|
|
||||||
const docNames = Search._index.docnames;
|
|
||||||
const objects = Search._index.objects;
|
|
||||||
const objNames = Search._index.objnames;
|
|
||||||
const titles = Search._index.titles;
|
|
||||||
|
|
||||||
const results = [];
|
|
||||||
|
|
||||||
const objectSearchCallback = (prefix, match) => {
|
|
||||||
const name = match[4]
|
|
||||||
const fullname = (prefix ? prefix + "." : "") + name;
|
|
||||||
const fullnameLower = fullname.toLowerCase();
|
|
||||||
if (fullnameLower.indexOf(object) < 0) return;
|
|
||||||
|
|
||||||
let score = 0;
|
|
||||||
const parts = fullnameLower.split(".");
|
|
||||||
|
|
||||||
// check for different match types: exact matches of full name or
|
|
||||||
// "last name" (i.e. last dotted part)
|
|
||||||
if (fullnameLower === object || parts.slice(-1)[0] === object)
|
|
||||||
score += Scorer.objNameMatch;
|
|
||||||
else if (parts.slice(-1)[0].indexOf(object) > -1)
|
|
||||||
score += Scorer.objPartialMatch; // matches in last name
|
|
||||||
|
|
||||||
const objName = objNames[match[1]][2];
|
|
||||||
const title = titles[match[0]];
|
|
||||||
|
|
||||||
// If more than one term searched for, we require other words to be
|
|
||||||
// found in the name/title/description
|
|
||||||
const otherTerms = new Set(objectTerms);
|
|
||||||
otherTerms.delete(object);
|
|
||||||
if (otherTerms.size > 0) {
|
|
||||||
const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
|
|
||||||
if (
|
|
||||||
[...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
|
|
||||||
)
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
let anchor = match[3];
|
|
||||||
if (anchor === "") anchor = fullname;
|
|
||||||
else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
|
|
||||||
|
|
||||||
const descr = objName + _(", in ") + title;
|
|
||||||
|
|
||||||
// add custom score for some objects according to scorer
|
|
||||||
if (Scorer.objPrio.hasOwnProperty(match[2]))
|
|
||||||
score += Scorer.objPrio[match[2]];
|
|
||||||
else score += Scorer.objPrioDefault;
|
|
||||||
|
|
||||||
results.push([
|
|
||||||
docNames[match[0]],
|
|
||||||
fullname,
|
|
||||||
"#" + anchor,
|
|
||||||
descr,
|
|
||||||
score,
|
|
||||||
filenames[match[0]],
|
|
||||||
]);
|
|
||||||
};
|
|
||||||
Object.keys(objects).forEach((prefix) =>
|
|
||||||
objects[prefix].forEach((array) =>
|
|
||||||
objectSearchCallback(prefix, array)
|
|
||||||
)
|
|
||||||
);
|
|
||||||
return results;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* search for full-text terms in the index
|
|
||||||
*/
|
|
||||||
performTermsSearch: (searchTerms, excludedTerms) => {
|
|
||||||
// prepare search
|
|
||||||
const terms = Search._index.terms;
|
|
||||||
const titleTerms = Search._index.titleterms;
|
|
||||||
const filenames = Search._index.filenames;
|
|
||||||
const docNames = Search._index.docnames;
|
|
||||||
const titles = Search._index.titles;
|
|
||||||
|
|
||||||
const scoreMap = new Map();
|
|
||||||
const fileMap = new Map();
|
|
||||||
|
|
||||||
// perform the search on the required terms
|
|
||||||
searchTerms.forEach((word) => {
|
|
||||||
const files = [];
|
|
||||||
const arr = [
|
|
||||||
{ files: terms[word], score: Scorer.term },
|
|
||||||
{ files: titleTerms[word], score: Scorer.title },
|
|
||||||
];
|
|
||||||
// add support for partial matches
|
|
||||||
if (word.length > 2) {
|
|
||||||
const escapedWord = _escapeRegExp(word);
|
|
||||||
Object.keys(terms).forEach((term) => {
|
|
||||||
if (term.match(escapedWord) && !terms[word])
|
|
||||||
arr.push({ files: terms[term], score: Scorer.partialTerm });
|
|
||||||
});
|
|
||||||
Object.keys(titleTerms).forEach((term) => {
|
|
||||||
if (term.match(escapedWord) && !titleTerms[word])
|
|
||||||
arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// no match but word was a required one
|
|
||||||
if (arr.every((record) => record.files === undefined)) return;
|
|
||||||
|
|
||||||
// found search word in contents
|
|
||||||
arr.forEach((record) => {
|
|
||||||
if (record.files === undefined) return;
|
|
||||||
|
|
||||||
let recordFiles = record.files;
|
|
||||||
if (recordFiles.length === undefined) recordFiles = [recordFiles];
|
|
||||||
files.push(...recordFiles);
|
|
||||||
|
|
||||||
// set score for the word in each file
|
|
||||||
recordFiles.forEach((file) => {
|
|
||||||
if (!scoreMap.has(file)) scoreMap.set(file, {});
|
|
||||||
scoreMap.get(file)[word] = record.score;
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// create the mapping
|
|
||||||
files.forEach((file) => {
|
|
||||||
if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
|
|
||||||
fileMap.get(file).push(word);
|
|
||||||
else fileMap.set(file, [word]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// now check if the files don't contain excluded terms
|
|
||||||
const results = [];
|
|
||||||
for (const [file, wordList] of fileMap) {
|
|
||||||
// check if all requirements are matched
|
|
||||||
|
|
||||||
// as search terms with length < 3 are discarded
|
|
||||||
const filteredTermCount = [...searchTerms].filter(
|
|
||||||
(term) => term.length > 2
|
|
||||||
).length;
|
|
||||||
if (
|
|
||||||
wordList.length !== searchTerms.size &&
|
|
||||||
wordList.length !== filteredTermCount
|
|
||||||
)
|
|
||||||
continue;
|
|
||||||
|
|
||||||
// ensure that none of the excluded terms is in the search result
|
|
||||||
if (
|
|
||||||
[...excludedTerms].some(
|
|
||||||
(term) =>
|
|
||||||
terms[term] === file ||
|
|
||||||
titleTerms[term] === file ||
|
|
||||||
(terms[term] || []).includes(file) ||
|
|
||||||
(titleTerms[term] || []).includes(file)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
break;
|
|
||||||
|
|
||||||
// select one (max) score for the file.
|
|
||||||
const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
|
|
||||||
// add result to the result list
|
|
||||||
results.push([
|
|
||||||
docNames[file],
|
|
||||||
titles[file],
|
|
||||||
"",
|
|
||||||
null,
|
|
||||||
score,
|
|
||||||
filenames[file],
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
return results;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* helper function to return a node containing the
|
|
||||||
* search summary for a given text. keywords is a list
|
|
||||||
* of stemmed words.
|
|
||||||
*/
|
|
||||||
makeSearchSummary: (htmlText, keywords) => {
|
|
||||||
const text = Search.htmlToText(htmlText);
|
|
||||||
if (text === "") return null;
|
|
||||||
|
|
||||||
const textLower = text.toLowerCase();
|
|
||||||
const actualStartPosition = [...keywords]
|
|
||||||
.map((k) => textLower.indexOf(k.toLowerCase()))
|
|
||||||
.filter((i) => i > -1)
|
|
||||||
.slice(-1)[0];
|
|
||||||
const startWithContext = Math.max(actualStartPosition - 120, 0);
|
|
||||||
|
|
||||||
const top = startWithContext === 0 ? "" : "...";
|
|
||||||
const tail = startWithContext + 240 < text.length ? "..." : "";
|
|
||||||
|
|
||||||
let summary = document.createElement("p");
|
|
||||||
summary.classList.add("context");
|
|
||||||
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
|
|
||||||
|
|
||||||
return summary;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
_ready(Search.init);
|
|
||||||
|
|
@ -1,144 +0,0 @@
|
||||||
/* Highlighting utilities for Sphinx HTML documentation. */
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
const SPHINX_HIGHLIGHT_ENABLED = true
|
|
||||||
|
|
||||||
/**
|
|
||||||
* highlight a given string on a node by wrapping it in
|
|
||||||
* span elements with the given class name.
|
|
||||||
*/
|
|
||||||
const _highlight = (node, addItems, text, className) => {
|
|
||||||
if (node.nodeType === Node.TEXT_NODE) {
|
|
||||||
const val = node.nodeValue;
|
|
||||||
const parent = node.parentNode;
|
|
||||||
const pos = val.toLowerCase().indexOf(text);
|
|
||||||
if (
|
|
||||||
pos >= 0 &&
|
|
||||||
!parent.classList.contains(className) &&
|
|
||||||
!parent.classList.contains("nohighlight")
|
|
||||||
) {
|
|
||||||
let span;
|
|
||||||
|
|
||||||
const closestNode = parent.closest("body, svg, foreignObject");
|
|
||||||
const isInSVG = closestNode && closestNode.matches("svg");
|
|
||||||
if (isInSVG) {
|
|
||||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
|
||||||
} else {
|
|
||||||
span = document.createElement("span");
|
|
||||||
span.classList.add(className);
|
|
||||||
}
|
|
||||||
|
|
||||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
|
||||||
parent.insertBefore(
|
|
||||||
span,
|
|
||||||
parent.insertBefore(
|
|
||||||
document.createTextNode(val.substr(pos + text.length)),
|
|
||||||
node.nextSibling
|
|
||||||
)
|
|
||||||
);
|
|
||||||
node.nodeValue = val.substr(0, pos);
|
|
||||||
|
|
||||||
if (isInSVG) {
|
|
||||||
const rect = document.createElementNS(
|
|
||||||
"http://www.w3.org/2000/svg",
|
|
||||||
"rect"
|
|
||||||
);
|
|
||||||
const bbox = parent.getBBox();
|
|
||||||
rect.x.baseVal.value = bbox.x;
|
|
||||||
rect.y.baseVal.value = bbox.y;
|
|
||||||
rect.width.baseVal.value = bbox.width;
|
|
||||||
rect.height.baseVal.value = bbox.height;
|
|
||||||
rect.setAttribute("class", className);
|
|
||||||
addItems.push({ parent: parent, target: rect });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else if (node.matches && !node.matches("button, select, textarea")) {
|
|
||||||
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
const _highlightText = (thisNode, text, className) => {
|
|
||||||
let addItems = [];
|
|
||||||
_highlight(thisNode, addItems, text, className);
|
|
||||||
addItems.forEach((obj) =>
|
|
||||||
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Small JavaScript module for the documentation.
|
|
||||||
*/
|
|
||||||
const SphinxHighlight = {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* highlight the search words provided in localstorage in the text
|
|
||||||
*/
|
|
||||||
highlightSearchWords: () => {
|
|
||||||
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
|
|
||||||
|
|
||||||
// get and clear terms from localstorage
|
|
||||||
const url = new URL(window.location);
|
|
||||||
const highlight =
|
|
||||||
localStorage.getItem("sphinx_highlight_terms")
|
|
||||||
|| url.searchParams.get("highlight")
|
|
||||||
|| "";
|
|
||||||
localStorage.removeItem("sphinx_highlight_terms")
|
|
||||||
url.searchParams.delete("highlight");
|
|
||||||
window.history.replaceState({}, "", url);
|
|
||||||
|
|
||||||
// get individual terms from highlight string
|
|
||||||
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
|
||||||
if (terms.length === 0) return; // nothing to do
|
|
||||||
|
|
||||||
// There should never be more than one element matching "div.body"
|
|
||||||
const divBody = document.querySelectorAll("div.body");
|
|
||||||
const body = divBody.length ? divBody[0] : document.querySelector("body");
|
|
||||||
window.setTimeout(() => {
|
|
||||||
terms.forEach((term) => _highlightText(body, term, "highlighted"));
|
|
||||||
}, 10);
|
|
||||||
|
|
||||||
const searchBox = document.getElementById("searchbox");
|
|
||||||
if (searchBox === null) return;
|
|
||||||
searchBox.appendChild(
|
|
||||||
document
|
|
||||||
.createRange()
|
|
||||||
.createContextualFragment(
|
|
||||||
'<p class="highlight-link">' +
|
|
||||||
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
|
|
||||||
_("Hide Search Matches") +
|
|
||||||
"</a></p>"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* helper function to hide the search marks again
|
|
||||||
*/
|
|
||||||
hideSearchWords: () => {
|
|
||||||
document
|
|
||||||
.querySelectorAll("#searchbox .highlight-link")
|
|
||||||
.forEach((el) => el.remove());
|
|
||||||
document
|
|
||||||
.querySelectorAll("span.highlighted")
|
|
||||||
.forEach((el) => el.classList.remove("highlighted"));
|
|
||||||
localStorage.removeItem("sphinx_highlight_terms")
|
|
||||||
},
|
|
||||||
|
|
||||||
initEscapeListener: () => {
|
|
||||||
// only install a listener if it is really needed
|
|
||||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
|
|
||||||
|
|
||||||
document.addEventListener("keydown", (event) => {
|
|
||||||
// bail for input elements
|
|
||||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
|
||||||
// bail with special keys
|
|
||||||
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
|
|
||||||
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
|
|
||||||
SphinxHighlight.hideSearchWords();
|
|
||||||
event.preventDefault();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
_ready(SphinxHighlight.highlightSearchWords);
|
|
||||||
_ready(SphinxHighlight.initEscapeListener);
|
|
||||||
|
|
@ -1,462 +0,0 @@
|
||||||
<!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>prometheus.prometheus.alertmanager role – Prometheus Alertmanager service — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter" href="blackbox_exporter_role.html" />
|
|
||||||
<link rel="prev" title="Prometheus.Prometheus" href="index.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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 current"><a class="current reference internal" href="#">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-alertmanager-service">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Alertmanager service</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-alertmanager-role"></span><section id="prometheus-prometheus-alertmanager-role-prometheus-alertmanager-service">
|
|
||||||
<h1>prometheus.prometheus.alertmanager role – Prometheus Alertmanager service<a class="headerlink" href="#prometheus-prometheus-alertmanager-role-prometheus-alertmanager-service" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.alertmanager</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-alertmanager-service" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Alertmanager service</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-prometheus-alertmanager-service">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Alertmanager service</a><a class="headerlink" href="#entry-point-main-prometheus-alertmanager-service" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy and manage Prometheus <a class="reference external" href="https://github.com/prometheus/alertmanager">alertmanager</a> service using ansible.</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_amtool_config_alertmanager_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-amtool-config-alertmanager-url"><strong>alertmanager_amtool_config_alertmanager_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_amtool_config_alertmanager_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the alertmanager</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"{{</span> <span class="pre">alertmanager_web_external_url</span> <span class="pre">}}"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_amtool_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-amtool-config-file"><strong>alertmanager_amtool_config_file</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_amtool_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Template for amtool config</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"amtool.yml.j2"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_amtool_config_output"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-amtool-config-output"><strong>alertmanager_amtool_config_output</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_amtool_config_output" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Extended output, use <code class="docutils literal notranslate"><span class="pre">""</span></code> for simple output.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"extended"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-binary-local-dir"><strong>alertmanager_binary_local_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Allows to use local packages instead of ones distributed on github.</p>
|
|
||||||
<p>As parameter it takes a directory where <code class="docutils literal notranslate"><span class="pre">alertmanager</span></code> AND <code class="docutils literal notranslate"><span class="pre">amtool</span></code> binaries are stored on host on which ansible is ran.</p>
|
|
||||||
<p>This overrides <em>alertmanager_version</em> parameter</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-binary-url"><strong>alertmanager_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the alertmanager binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_alertmanager_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">alertmanager_version</span> <span class="pre">}}/alertmanager-{{</span> <span class="pre">alertmanager_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-checksums-url"><strong>alertmanager_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the alertmanager checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_alertmanager_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">alertmanager_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_cluster"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-cluster"><strong>alertmanager_cluster</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_cluster" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>HA cluster network configuration. Disabled by default.</p>
|
|
||||||
<p>More information in <a class="reference external" href="https://github.com/prometheus/alertmanager#high-availability">alertmanager readme</a></p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{"listen-address":</span> <span class="pre">""}</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_config_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-config-dir"><strong>alertmanager_config_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_config_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path to directory with alertmanager configuration</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/etc/alertmanager"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-config-file"><strong>alertmanager_config_file</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Variable used to provide custom alertmanager configuration file in form of ansible template</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"alertmanager.yml.j2"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_config_flags_extra"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-config-flags-extra"><strong>alertmanager_config_flags_extra</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_config_flags_extra" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Additional configuration flags passed to prometheus binary at startup</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_db_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-db-dir"><strong>alertmanager_db_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_db_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path to directory with alertmanager database</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/var/lib/alertmanager"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_hipchat_api_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-hipchat-api-url"><strong>alertmanager_hipchat_api_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_hipchat_api_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Hipchat webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_hipchat_auth_token"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-hipchat-auth-token"><strong>alertmanager_hipchat_auth_token</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_hipchat_auth_token" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Hipchat authentication token</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_http_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-http-config"><strong>alertmanager_http_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_http_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Http config for using custom webhooks</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_inhibit_rules"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-inhibit-rules"><strong>alertmanager_inhibit_rules</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_inhibit_rules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of inhibition rules. Same as in <a class="reference external" href="https://prometheus.io/docs/alerting/configuration/#inhibit_rule">official docs</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_opsgenie_api_key"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-opsgenie-api-key"><strong>alertmanager_opsgenie_api_key</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_opsgenie_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Opsgenie webhook key</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_opsgenie_api_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-opsgenie-api-url"><strong>alertmanager_opsgenie_api_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_opsgenie_api_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Opsgenie webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_pagerduty_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-pagerduty-url"><strong>alertmanager_pagerduty_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_pagerduty_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Pagerduty webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_receivers"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-receivers"><strong>alertmanager_receivers</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_receivers" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>A list of notification receivers. Configuration same as in <a class="reference external" href="https://prometheus.io/docs/alerting/configuration/#receiver">official docs</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_resolve_timeout"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-resolve-timeout"><strong>alertmanager_resolve_timeout</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_resolve_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Time after which an alert is declared resolved</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"3m"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_route"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-route"><strong>alertmanager_route</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_route" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Alert routing. More in <a class="reference external" href="https://prometheus.io/docs/alerting/configuration/#route">official docs</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-skip-install"><strong>alertmanager_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Alertmanager installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_slack_api_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-slack-api-url"><strong>alertmanager_slack_api_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_slack_api_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Slack webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_smtp"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-smtp"><strong>alertmanager_smtp</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_smtp" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SMTP (email) configuration</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_template_files"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-template-files"><strong>alertmanager_template_files</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_template_files" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of folders where ansible will look for template files which will be copied to <code class="docutils literal notranslate"><span class="pre">"{{</span> <span class="pre">alertmanager_config_dir</span> <span class="pre">}}/templates/"</span></code>.</p>
|
|
||||||
<p>Files must have <code class="docutils literal notranslate"><span class="pre">*.tmpl</span></code> extension</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">["alertmanager/templates/*.tmpl"]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-version"><strong>alertmanager_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Alertmanager package version. Also accepts `latest` as parameter.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.21.0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_victorops_api_key"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-victorops-api-key"><strong>alertmanager_victorops_api_key</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_victorops_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>VictorOps webhook key</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_victorops_api_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-victorops-api-url"><strong>alertmanager_victorops_api_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_victorops_api_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>VictorOps webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_web_external_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-web-external-url"><strong>alertmanager_web_external_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_web_external_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>External address on which alertmanager is available. Useful when behind reverse proxy. Ex. example.org/alertmanager</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"http://localhost:9093/"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-web-listen-address"><strong>alertmanager_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which alertmanager will be listening</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9093"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_wechat_corp_id"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-wechat-corp-id"><strong>alertmanager_wechat_corp_id</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_wechat_corp_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enterprise WeChat corporation id</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_wechat_secret"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-wechat-secret"><strong>alertmanager_wechat_secret</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_wechat_secret" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enterprise WeChat secret token</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_wechat_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-wechat-url"><strong>alertmanager_wechat_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_wechat_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enterprise WeChat webhook url</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="index.html" class="btn btn-neutral float-left" title="Prometheus.Prometheus" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="blackbox_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,259 +0,0 @@
|
||||||
<!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>prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter" href="mysqld_exporter_role.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.alertmanager role – Prometheus Alertmanager service" href="alertmanager_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Deploy and manage Prometheus blackbox exporter</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role"></span><section id="prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter">
|
|
||||||
<h1>prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter<a class="headerlink" href="#prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.blackbox_exporter</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Deploy and manage Prometheus blackbox exporter</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-deploy-and-manage-prometheus-blackbox-exporter">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Deploy and manage Prometheus blackbox exporter</a><a class="headerlink" href="#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy and manage Prometheus blackbox exporter which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-binary-url"><strong>blackbox_exporter_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the blackbox_exporter binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_blackbox_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">blackbox_exporter_version</span> <span class="pre">}}/blackbox_exporter-{{</span> <span class="pre">blackbox_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch_map[ansible_architecture]</span> <span class="pre">|</span> <span class="pre">default(ansible_architecture)</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_cli_flags"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-cli-flags"><strong>blackbox_exporter_cli_flags</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_cli_flags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Additional configuration flags passed to blackbox exporter binary at startup</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_configuration_modules"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-configuration-modules"><strong>blackbox_exporter_configuration_modules</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_configuration_modules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Endpoints configuration</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{"http_2xx":</span> <span class="pre">{"http":</span> <span class="pre">{"method":</span> <span class="pre">"GET",</span> <span class="pre">"valid_status_codes":</span> <span class="pre">[]},</span> <span class="pre">"prober":</span> <span class="pre">"http",</span> <span class="pre">"timeout":</span> <span class="pre">"5s"}}</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-skip-install"><strong>blackbox_exporter_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Blackbox exporter installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-version"><strong>blackbox_exporter_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Blackbox exporter package version</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.18.0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-web-listen-address"><strong>blackbox_exporter_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which blackbox exporter will be listening</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9115"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="alertmanager_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.alertmanager role – Prometheus Alertmanager service" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="mysqld_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,144 +0,0 @@
|
||||||
<!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>Index of all Collection Environment Variables — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">Index of all Collection Environment Variables</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="index-of-all-collection-environment-variables">
|
|
||||||
<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Permalink to this heading"></a></h1>
|
|
||||||
<p>The following index documents all environment variables declared by plugins in collections.
|
|
||||||
Environment variables used by the ansible-core configuration are documented in <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/config.html#ansible-configuration-settings" title="(in Ansible vdevel)"><span>Ansible Configuration Settings</span></a>.</p>
|
|
||||||
<p>No environment variables have been defined.</p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,197 +0,0 @@
|
||||||
<!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>Prometheus.Prometheus — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.alertmanager role – Prometheus Alertmanager service" href="alertmanager_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="#" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="#">Prometheus.Prometheus Collection</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="#" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">Prometheus.Prometheus</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="prometheus-prometheus">
|
|
||||||
<span id="plugins-in-prometheus-prometheus"></span><h1>Prometheus.Prometheus<a class="headerlink" href="#prometheus-prometheus" title="Permalink to this heading"></a></h1>
|
|
||||||
<p>Collection version 0.5.1</p>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#plugin-index" id="id2">Plugin Index</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#role-index" id="id3">Role Index</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="description">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
|
||||||
<p>Ansible Collection for Prometheus</p>
|
|
||||||
<p><strong>Authors:</strong></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Ben Kochie (<a class="reference external" href="https://github.com/SuperQ">https://github.com/SuperQ</a>)</p></li>
|
|
||||||
<li><p>Garðar Arnarsson (<a class="reference external" href="https://github.com/gardar">https://github.com/gardar</a>)</p></li>
|
|
||||||
<li><p>Paweł Krupa (<a class="reference external" href="https://github.com/paulfantom">https://github.com/paulfantom</a>)</p></li>
|
|
||||||
</ul>
|
|
||||||
<p><strong>Supported ansible-core versions:</strong></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>~= 2.9.0</p></li>
|
|
||||||
<li><p>~= 2.15.0</p></li>
|
|
||||||
<li><p>~= 2.14.0</p></li>
|
|
||||||
<li><p>~= 2.13.0</p></li>
|
|
||||||
<li><p>~= 2.12.0</p></li>
|
|
||||||
<li><p>~= 2.11.0</p></li>
|
|
||||||
<li><p>~= 2.10.0</p></li>
|
|
||||||
</ul>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p><div class="toctree-wrapper compound">
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
<section id="plugin-index">
|
|
||||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h2>
|
|
||||||
<p>There are no plugins in the prometheus.prometheus collection with automatically generated documentation.</p>
|
|
||||||
</section>
|
|
||||||
<section id="role-index">
|
|
||||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Role Index</a><a class="headerlink" href="#role-index" title="Permalink to this heading"></a></h2>
|
|
||||||
<p>These are the roles in the prometheus.prometheus collection:</p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="alertmanager_role.html#ansible-collections-prometheus-prometheus-alertmanager-role"><span class="std std-ref">alertmanager role</span></a> – Prometheus Alertmanager service</p></li>
|
|
||||||
<li><p><a class="reference internal" href="blackbox_exporter_role.html#ansible-collections-prometheus-prometheus-blackbox-exporter-role"><span class="std std-ref">blackbox_exporter role</span></a> – Deploy and manage Prometheus blackbox exporter</p></li>
|
|
||||||
<li><p><a class="reference internal" href="mysqld_exporter_role.html#ansible-collections-prometheus-prometheus-mysqld-exporter-role"><span class="std std-ref">mysqld_exporter role</span></a> – Prometheus MySQLd Exporter</p></li>
|
|
||||||
<li><p><a class="reference internal" href="node_exporter_role.html#ansible-collections-prometheus-prometheus-node-exporter-role"><span class="std std-ref">node_exporter role</span></a> – Prometheus Node Exporter</p></li>
|
|
||||||
<li><p><a class="reference internal" href="prometheus_role.html#ansible-collections-prometheus-prometheus-prometheus-role"><span class="std std-ref">prometheus role</span></a> – Installs and configures prometheus</p></li>
|
|
||||||
<li><p><a class="reference internal" href="snmp_exporter_role.html#ansible-collections-prometheus-prometheus-snmp-exporter-role"><span class="std std-ref">snmp_exporter role</span></a> – Prometheus SNMP exporter</p></li>
|
|
||||||
<li><p><a class="reference internal" href="systemd_exporter_role.html#ansible-collections-prometheus-prometheus-systemd-exporter-role"><span class="std std-ref">systemd_exporter role</span></a> – Prometheus Systemd Exporter</p></li>
|
|
||||||
</ul>
|
|
||||||
<div class="toctree-wrapper compound">
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="alertmanager_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.alertmanager role – Prometheus Alertmanager service" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,366 +0,0 @@
|
||||||
<!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>prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.node_exporter role – Prometheus Node Exporter" href="node_exporter_role.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter" href="blackbox_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-mysqld-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus MySQLd Exporter</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role"></span><section id="prometheus-prometheus-mysqld-exporter-role-prometheus-mysqld-exporter">
|
|
||||||
<h1>prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter<a class="headerlink" href="#prometheus-prometheus-mysqld-exporter-role-prometheus-mysqld-exporter" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.mysqld_exporter</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-mysqld-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus MySQLd Exporter</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-prometheus-mysqld-exporter">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus MySQLd Exporter</a><a class="headerlink" href="#entry-point-main-prometheus-mysqld-exporter" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus/mysqld_exporter">mysqld_exporter</a> using ansible</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_basic_auth_users"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-basic-auth-users"><strong>mysqld_exporter_basic_auth_users</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_basic_auth_users" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-binary-install-dir"><strong>mysqld_exporter_binary_install_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>Directory to install mysqld_exporter binary</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/usr/local/bin"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-binary-local-dir"><strong>mysqld_exporter_binary_local_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
|
|
||||||
<p>The parameter may be set to a directory where the <code class="docutils literal notranslate"><span class="pre">mysqld_exporter</span></code> binary is stored on the host where ansible is run.</p>
|
|
||||||
<p>This overrides the <em>mysqld_exporter_version</em> parameter</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-binary-url"><strong>mysqld_exporter_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the mysqld_exporter binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/prometheus/{{</span> <span class="pre">_mysqld_exporter_repo</span> <span class="pre">}}/download/v{{</span> <span class="pre">mysqld_exporter_version</span> <span class="pre">}}/mysqld_exporter-{{</span> <span class="pre">mysqld_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-checksums-url"><strong>mysqld_exporter_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the mysqld_exporter checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_mysqld_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">mysqld_exporter_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-config-file"><strong>mysqld_exporter_config_file</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>The filename of the exporter mysql config file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"mysqld_exporter.cnf"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_disabled_collectors"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-disabled-collectors"><strong>mysqld_exporter_disabled_collectors</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_disabled_collectors" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of disabled collectors.</p>
|
|
||||||
<p>By default mysqld_exporter disables collectors listed <a class="reference external" href="https://github.com/prometheus/mysqld_exporter#disabled-by-default">here</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_enabled_collectors"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-enabled-collectors"><strong>mysqld_exporter_enabled_collectors</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_enabled_collectors" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of dicts defining additionally enabled collectors and their configuration.</p>
|
|
||||||
<p>It adds collectors to <a class="reference external" href="https://github.com/prometheus/mysqld_exporter#enabled-by-default">those enabled by default</a>.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_host"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-host"><strong>mysqld_exporter_host</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_host" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>The target MySQL host</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-http-server-config"><strong>mysqld_exporter_http_server_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Config for HTTP/2 support.</p>
|
|
||||||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/mysqld_exporter/blob/master/https/README.md#sample-config">mysqld_exporter docs</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_port"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-port"><strong>mysqld_exporter_port</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_port" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>The target MySQL port</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-skip-install"><strong>mysqld_exporter_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>MySQLd installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_socket"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-socket"><strong>mysqld_exporter_socket</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_socket" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>The target MySQL unix socket</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/run/mysqld/mysqld.sock"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-system-group"><strong>mysqld_exporter_system_group</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>System group for MySQLd Exporter</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"mysqld-exp"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-system-user"><strong>mysqld_exporter_system_user</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>MySQLd Exporter user</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"mysqld-exp"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-tls-server-config"><strong>mysqld_exporter_tls_server_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
|
|
||||||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/mysqld_exporter/blob/master/https/README.md#sample-config">mysqld_exporter docs</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-version"><strong>mysqld_exporter_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>MySQLd exporter package version. Also accepts latest as parameter.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"1.1.2"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-web-listen-address"><strong>mysqld_exporter_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which mysqld_exporter will listen</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9104"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--mysqld_exporter_web_telemetry_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-mysqld-exporter-role-parameter-main-mysqld-exporter-web-telemetry-path"><strong>mysqld_exporter_web_telemetry_path</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--mysqld_exporter_web_telemetry_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path under which to expose metrics</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/metrics"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="blackbox_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="node_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.node_exporter role – Prometheus Node Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,346 +0,0 @@
|
||||||
<!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>prometheus.prometheus.node_exporter role – Prometheus Node Exporter — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.prometheus role – Installs and configures prometheus" href="prometheus_role.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter" href="mysqld_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-node-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Node Exporter</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-node-exporter-role"></span><section id="prometheus-prometheus-node-exporter-role-prometheus-node-exporter">
|
|
||||||
<h1>prometheus.prometheus.node_exporter role – Prometheus Node Exporter<a class="headerlink" href="#prometheus-prometheus-node-exporter-role-prometheus-node-exporter" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.node_exporter</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-node-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Node Exporter</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-prometheus-node-exporter">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Node Exporter</a><a class="headerlink" href="#entry-point-main-prometheus-node-exporter" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus/node_exporter">node exporter</a> using ansible</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_basic_auth_users"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-basic-auth-users"><strong>node_exporter_basic_auth_users</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_basic_auth_users" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-binary-install-dir"><strong>node_exporter_binary_install_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>Directory to install node_exporter binary</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/usr/local/bin"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-binary-local-dir"><strong>node_exporter_binary_local_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
|
|
||||||
<p>The parameter may be set to a directory where the <code class="docutils literal notranslate"><span class="pre">node_exporter</span></code> binary is stored on the host where ansible is run.</p>
|
|
||||||
<p>This overrides the <em>node_exporter_version</em> parameter</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-binary-url"><strong>node_exporter_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the node exporter binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_node_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">node_exporter_version</span> <span class="pre">}}/node_exporter-{{</span> <span class="pre">node_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-checksums-url"><strong>node_exporter_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the node exporter checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_node_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">node_exporter_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_disabled_collectors"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-disabled-collectors"><strong>node_exporter_disabled_collectors</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_disabled_collectors" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of disabled collectors.</p>
|
|
||||||
<p>By default node_exporter disables collectors listed <a class="reference external" href="https://github.com/prometheus/node_exporter#disabled-by-default">here</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_enabled_collectors"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-enabled-collectors"><strong>node_exporter_enabled_collectors</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_enabled_collectors" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of dicts defining additionally enabled collectors and their configuration.</p>
|
|
||||||
<p>It adds collectors to <a class="reference external" href="https://github.com/prometheus/node_exporter#enabled-by-default">those enabled by default</a>.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">["systemd",</span> <span class="pre">{"textfile":</span> <span class="pre">{"directory":</span> <span class="pre">"{{</span> <span class="pre">node_exporter_textfile_dir</span> <span class="pre">}}"}}]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-http-server-config"><strong>node_exporter_http_server_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Config for HTTP/2 support.</p>
|
|
||||||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/node_exporter/blob/master/https/README.md#sample-config">node_exporter docs</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-skip-install"><strong>node_exporter_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Node exporter installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-system-group"><strong>node_exporter_system_group</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>System group for node exporter</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"node-exp"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-system-user"><strong>node_exporter_system_user</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>Node exporter user</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"node-exp"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_textfile_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-textfile-dir"><strong>node_exporter_textfile_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_textfile_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Directory used by the <a class="reference external" href="https://github.com/prometheus/node_exporter#textfile-collector">Textfile Collector</a>.</p>
|
|
||||||
<p>To get permissions to write metrics in this directory, users must be in <code class="docutils literal notranslate"><span class="pre">node-exp</span></code> system group.</p>
|
|
||||||
<p><strong>Note:</strong> More information in TROUBLESHOOTING.md guide.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/var/lib/node_exporter"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-tls-server-config"><strong>node_exporter_tls_server_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
|
|
||||||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/node_exporter/blob/master/https/README.md#sample-config">node_exporter docs</a>.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-version"><strong>node_exporter_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Node exporter package version. Also accepts latest as parameter.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"1.1.2"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-web-listen-address"><strong>node_exporter_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which node exporter will listen</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9100"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--node_exporter_web_telemetry_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-node-exporter-role-parameter-main-node-exporter-web-telemetry-path"><strong>node_exporter_web_telemetry_path</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_web_telemetry_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path under which to expose metrics</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/metrics"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="mysqld_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="prometheus_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.prometheus role – Installs and configures prometheus" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Binary file not shown.
|
|
@ -1,428 +0,0 @@
|
||||||
<!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>prometheus.prometheus.prometheus role – Installs and configures prometheus — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter" href="snmp_exporter_role.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.node_exporter role – Prometheus Node Exporter" href="node_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.prometheus role – Installs and configures prometheus</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-installs-and-configures-prometheus">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Installs and configures prometheus</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.prometheus role – Installs and configures prometheus</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-prometheus-role"></span><section id="prometheus-prometheus-prometheus-role-installs-and-configures-prometheus">
|
|
||||||
<h1>prometheus.prometheus.prometheus role – Installs and configures prometheus<a class="headerlink" href="#prometheus-prometheus-prometheus-role-installs-and-configures-prometheus" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.prometheus</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-installs-and-configures-prometheus" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Installs and configures prometheus</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-installs-and-configures-prometheus">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Installs and configures prometheus</a><a class="headerlink" href="#entry-point-main-installs-and-configures-prometheus" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus monitoring system configuration and management</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_relabel_configs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-relabel-configs"><strong>prometheus_alert_relabel_configs</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_relabel_configs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Alert relabeling rules. This should be specified as list in yaml format.</p>
|
|
||||||
<p>It is compatible with the official <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs">alert_relabel_configs</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_rules"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-rules"><strong>prometheus_alert_rules</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_rules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Full list of alerting rules which will be copied to <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/rules/ansible_managed.rules</span></code>.</p>
|
|
||||||
<p>Alerting rules can be also provided by other files located in <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/rules/</span></code> which have <code class="docutils literal notranslate"><span class="pre">*.rules</span></code> extension</p>
|
|
||||||
<p>Please see default values in role defaults/main.yml</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_rules_files"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-rules-files"><strong>prometheus_alert_rules_files</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_rules_files" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of folders where ansible will look for files containing alerting rules which will be copied to <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/rules/</span></code>.</p>
|
|
||||||
<p>Files must have <code class="docutils literal notranslate"><span class="pre">*.rules</span></code> extension</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">["prometheus/rules/*.rules"]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alertmanager_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alertmanager-config"><strong>prometheus_alertmanager_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alertmanager_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Configuration responsible for pointing where alertmanagers are. This should be specified as list in yaml format.</p>
|
|
||||||
<p>It is compatible with the official <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config">alertmanager_config</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-binary-local-dir"><strong>prometheus_binary_local_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Allows to use local packages instead of ones distributed on github.</p>
|
|
||||||
<p>As parameter it takes a directory where <em>prometheus</em> AND <em>promtool</em> binaries are stored on host on which ansible is ran.</p>
|
|
||||||
<p>This overrides <em>prometheus_version</em> parameter</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-binary-url"><strong>prometheus_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the prometheus binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_prometheus_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}/</span> <span class="pre">prometheus-{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-checksums-url"><strong>prometheus_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the prometheus checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_prometheus_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-dir"><strong>prometheus_config_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path to directory with prometheus configuration</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/etc/prometheus"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-file"><strong>prometheus_config_file</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Variable used to provide custom prometheus configuration file in form of ansible template</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"prometheus.yml.j2"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_flags_extra"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-flags-extra"><strong>prometheus_config_flags_extra</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_flags_extra" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Additional configuration flags passed to prometheus binary at startup</p>
|
|
||||||
<p>Example: prometheus_config_flags_extra: { storage.tsdb.retention: 15d, alertmanager.timeout: 10s }</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_db_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-db-dir"><strong>prometheus_db_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_db_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Path to directory with prometheus database</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/var/lib/prometheus"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_external_labels"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-external-labels"><strong>prometheus_external_labels</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_external_labels" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Provide map of additional labels which will be added to any time series or alerts when communicating with external systems</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{"environment":</span> <span class="pre">"{{</span> <span class="pre">ansible_fqdn</span> <span class="pre">|</span> <span class="pre">default(ansible_host)</span> <span class="pre">|</span> <span class="pre">default(inventory_hostname)</span> <span class="pre">}}"}</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_global"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-global"><strong>prometheus_global</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_global" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Prometheus global config. It is compatible with the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file">official configuration</a></p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{"evaluation_interval":</span> <span class="pre">"15s",</span> <span class="pre">"scrape_interval":</span> <span class="pre">"60s",</span> <span class="pre">"scrape_timeout":</span> <span class="pre">"15s"}</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_metrics_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-metrics-path"><strong>prometheus_metrics_path</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_metrics_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Prometheus external metrics path</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/{{</span> <span class="pre">(prometheus_web_external_url</span> <span class="pre">+</span> <span class="pre">'/metrics')</span> <span class="pre">|</span> <span class="pre">regex_replace('^(.*://)?(.*?)/')</span> <span class="pre">}}"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_read_only_dirs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-read-only-dirs"><strong>prometheus_read_only_dirs</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_read_only_dirs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Additional paths that Prometheus is allowed to read (useful for SSL certs outside of the config directory)</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_remote_read"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-remote-read"><strong>prometheus_remote_read</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_remote_read" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Remote read. It is compatible with the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read">official configuration</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_remote_write"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-remote-write"><strong>prometheus_remote_write</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_remote_write" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Remote write. Compatible with the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write">official configuration</a></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_scrape_configs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-scrape-configs"><strong>prometheus_scrape_configs</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_scrape_configs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Prometheus scrape jobs provided in same format as in the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config">official docs</a></p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[{"job_name":</span> <span class="pre">"prometheus",</span> <span class="pre">"metrics_path":</span> <span class="pre">"{{</span> <span class="pre">prometheus_metrics_path</span> <span class="pre">}}",</span> <span class="pre">"static_configs":</span> <span class="pre">[{"targets":</span> <span class="pre">["{{</span> <span class="pre">ansible_fqdn</span> <span class="pre">|</span> <span class="pre">default(ansible_host)</span> <span class="pre">|</span> <span class="pre">default('localhost')</span> <span class="pre">}}:9090"]}]},</span> <span class="pre">{"file_sd_configs":</span> <span class="pre">[{"files":</span> <span class="pre">["{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/file_sd/node.yml"]}],</span> <span class="pre">"job_name":</span> <span class="pre">"node"}]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-skip-install"><strong>prometheus_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Prometheus installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_static_targets_files"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-static-targets-files"><strong>prometheus_static_targets_files</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_static_targets_files" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>List of folders where ansible will look for files containing custom static target configuration files which will be copied to <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/file_sd/</span></code>.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">["prometheus/targets/*.yml",</span> <span class="pre">"prometheus/targets/*.json"]</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_storage_retention"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-storage-retention"><strong>prometheus_storage_retention</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_storage_retention" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Data retention period</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"30d"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_storage_retention_size"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-storage-retention-size"><strong>prometheus_storage_retention_size</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_storage_retention_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Data retention period by size</p>
|
|
||||||
<p>Maximum number of bytes that can be stored for blocks.</p>
|
|
||||||
<p>Units supported: KB, MB, GB, TB, PB.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_targets"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-targets"><strong>prometheus_targets</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_targets" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Targets which will be scraped.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-version"><strong>prometheus_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Prometheus package version. Also accepts <code class="docutils literal notranslate"><span class="pre">latest</span></code> as parameter.</p>
|
|
||||||
<p>Only prometheus 2.x is supported</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"2.27.0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_web_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-web-config"><strong>prometheus_web_config</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_web_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>A Prometheus <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">web config yaml</a> for configuring TLS and auth.</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_web_external_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-web-external-url"><strong>prometheus_web_external_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_web_external_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>External address on which prometheus is available. Useful when behind reverse proxy. Ex. `http://example.org/prometheus`</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-web-listen-address"><strong>prometheus_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--prometheus_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which prometheus will be listening</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9090"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="node_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.node_exporter role – Prometheus Node Exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="snmp_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,158 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html class="writer-html5" lang="en" >
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>Search — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<script src="_static/searchtools.js"></script>
|
|
||||||
<script src="_static/language_data.js"></script>
|
|
||||||
<link rel="search" title="Search" href="#" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="#" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">Search</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">
|
|
||||||
|
|
||||||
<noscript>
|
|
||||||
<div id="fallback" class="admonition warning">
|
|
||||||
<p class="last">
|
|
||||||
Please activate JavaScript to enable the search functionality.
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</noscript>
|
|
||||||
|
|
||||||
|
|
||||||
<div id="search-results">
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
<script>
|
|
||||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<script id="searchindexloader"></script>
|
|
||||||
<!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,268 +0,0 @@
|
||||||
<!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>prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="next" title="prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter" href="systemd_exporter_role.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.prometheus role – Installs and configures prometheus" href="prometheus_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-snmp-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus SNMP exporter</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-snmp-exporter-role"></span><section id="prometheus-prometheus-snmp-exporter-role-prometheus-snmp-exporter">
|
|
||||||
<h1>prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter<a class="headerlink" href="#prometheus-prometheus-snmp-exporter-role-prometheus-snmp-exporter" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.snmp_exporter</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-snmp-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus SNMP exporter</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-prometheus-snmp-exporter">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus SNMP exporter</a><a class="headerlink" href="#entry-point-main-prometheus-snmp-exporter" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy and manage prometheus <a class="reference external" href="https://github.com/prometheus/snmp_exporter">SNMP exporter</a> using ansible.</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-binary-url"><strong>snmp_exporter_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the snmp exporter binaries .tar.gz file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_snmp_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">snmp_exporter_version</span> <span class="pre">}}/snmp_exporter-{{</span> <span class="pre">snmp_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch_map[ansible_architecture]</span> <span class="pre">|</span> <span class="pre">default(ansible_architecture)</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-checksums-url"><strong>snmp_exporter_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the snmp exporter checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_snmp_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">snmp_exporter_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-config-file"><strong>snmp_exporter_config_file</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>If this is empty, role will download snmp.yml file from <a class="reference external" href="https://github.com/prometheus/snmp_exporter">https://github.com/prometheus/snmp_exporter</a>.</p>
|
|
||||||
<p>Otherwise this should contain path to file with custom snmp exporter configuration</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_log_level"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-log-level"><strong>snmp_exporter_log_level</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SNMP exporter service log level</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"info"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-skip-install"><strong>snmp_exporter_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SNMP exporter installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-version"><strong>snmp_exporter_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SNMP exporter package version</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.19.0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-web-listen-address"><strong>snmp_exporter_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which SNMP exporter will be listening</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9116"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="prometheus_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.prometheus role – Installs and configures prometheus" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
<a href="systemd_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,336 +0,0 @@
|
||||||
<!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>prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter — Prometheus.Prometheus Collection documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|
||||||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/sphinx_highlight.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="prev" title="prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter" href="snmp_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
<div class="DocSite-globalNav ansibleNav">
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|
||||||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
|
||||||
|
|
||||||
<img class="DocSiteNav-logo"
|
|
||||||
src="_static/images/Ansible-Mark-RGB_White.png"
|
|
||||||
alt="Ansible Logo">
|
|
||||||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
|
||||||
</a>
|
|
||||||
<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="index.html" class="icon icon-home">
|
|
||||||
Prometheus.Prometheus Collection
|
|
||||||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|
||||||
|
|
||||||
<div class="version">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<label class="sr-only" for="q">Search docs:</label>
|
|
||||||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="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="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a><ul>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-systemd-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Systemd Exporter</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</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="index.html">Prometheus.Prometheus Collection</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
||||||
<li class="breadcrumb-item active">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</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">
|
|
||||||
|
|
||||||
<span class="target" id="ansible-collections-prometheus-prometheus-systemd-exporter-role"></span><section id="prometheus-prometheus-systemd-exporter-role-prometheus-systemd-exporter">
|
|
||||||
<h1>prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter<a class="headerlink" href="#prometheus-prometheus-systemd-exporter-role-prometheus-systemd-exporter" title="Permalink to this heading"></a></h1>
|
|
||||||
<div class="admonition note">
|
|
||||||
<p class="admonition-title">Note</p>
|
|
||||||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.5.1).</p>
|
|
||||||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
|
||||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.systemd_exporter</span></code>.</p>
|
|
||||||
</div>
|
|
||||||
<nav class="contents local" id="contents">
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-systemd-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Systemd Exporter</a></p>
|
|
||||||
<ul>
|
|
||||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|
||||||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<section id="entry-point-main-prometheus-systemd-exporter">
|
|
||||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Systemd Exporter</a><a class="headerlink" href="#entry-point-main-prometheus-systemd-exporter" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="synopsis">
|
|
||||||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus-community/systemd_exporter">systemd exporter</a> using ansible.</p></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section id="parameters">
|
|
||||||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h3>
|
|
||||||
<table class="ansible-option-table docutils align-default" style="width: 100%">
|
|
||||||
<thead>
|
|
||||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|
||||||
<th class="head"><p>Comments</p></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-binary-install-dir"><strong>systemd_exporter_binary_install_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>Directory to install systemd_exporter binary</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/usr/local/bin"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-binary-local-dir"><strong>systemd_exporter_binary_local_dir</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Allows to use local packages instead of ones distributed on github.</p>
|
|
||||||
<p>As parameter it takes a directory where <code class="docutils literal notranslate"><span class="pre">systemd_exporter</span></code> binary is stored on host on which ansible is run.</p>
|
|
||||||
<p>This overrides <em>systemd_exporter_version</em> parameter</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-binary-url"><strong>systemd_exporter_binary_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the systemd exporter binaries .tar.gz file”</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_systemd_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">systemd_exporter_version</span> <span class="pre">}}/systemd_exporter-{{</span> <span class="pre">systemd_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-checksums-url"><strong>systemd_exporter_checksums_url</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>URL of the systemd exporter checksums file</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_systemd_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">systemd_exporter_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_enable_file_descriptor_size"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-enable-file-descriptor-size"><strong>systemd_exporter_enable_file_descriptor_size</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_enable_file_descriptor_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enables file descriptor size metrics. This feature will cause exporter to run as root as it needs access to /proc/X/fd”</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_enable_ip_accounting"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-enable-ip-accounting"><strong>systemd_exporter_enable_ip_accounting</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_enable_ip_accounting" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enables service ip accounting metrics. This feature only works with systemd 235 and above”</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_enable_restart_count"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-enable-restart-count"><strong>systemd_exporter_enable_restart_count</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_enable_restart_count" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Enables service restart count metrics. This feature only works with systemd 235 and above”</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-skip-install"><strong>systemd_exporter_skip_install</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SystemD exporter installation tasks gets skipped when set to true.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
||||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|
||||||
</ul>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-system-group"><strong>systemd_exporter_system_group</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>System group for systemd exporter</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"systemd-exporter"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-system-user"><strong>systemd_exporter_system_user</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
|
||||||
<p>Systemd exporter user</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"systemd-exporter"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_unit_allowlist"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-unit-allowlist"><strong>systemd_exporter_unit_allowlist</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_unit_allowlist" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Include some systemd units. Expects a regex. More in <strong>ERROR while parsing</strong>: While parsing L() at index 54: Cannot find comma separating parameter 1 from the next one</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_unit_denylist"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-unit-denylist"><strong>systemd_exporter_unit_denylist</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_unit_denylist" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Exclude some systemd units. Expects a regex. More in <strong>ERROR while parsing</strong>: While parsing L() at index 54: Cannot find comma separating parameter 1 from the next one</p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-version"><strong>systemd_exporter_version</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>SystemD exporter package version. Also accepts latest as parameter.</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.4.0"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-web-listen-address"><strong>systemd_exporter_web_listen_address</strong></p>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|
||||||
</div></td>
|
|
||||||
<td><div class="ansible-option-cell"><p>Address on which systemd exporter will listen”</p>
|
|
||||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9558"</span></code></p>
|
|
||||||
</div></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
<section id="authors">
|
|
||||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|
||||||
<ul class="simple">
|
|
||||||
<li><p>Prometheus Community</p></li>
|
|
||||||
</ul>
|
|
||||||
<section id="collection-links">
|
|
||||||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h4>
|
|
||||||
<p class="ansible-links">
|
|
||||||
<a href="https://github.com/prometheus-community/ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
||||||
<a href="https://prometheus.io" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
|
|
||||||
<a href="https://github.com/prometheus-community/ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
||||||
</p></section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="snmp_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
Reference in a new issue