Docsite
This commit is contained in:
parent
40042ba2a7
commit
ce77d4b1aa
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.
BIN
build-docs/doctrees/collections/grafana/grafana/index.doctree
Normal file
BIN
build-docs/doctrees/collections/grafana/grafana/index.doctree
Normal file
Binary file not shown.
BIN
build-docs/doctrees/collections/grafana/index.doctree
Normal file
BIN
build-docs/doctrees/collections/grafana/index.doctree
Normal file
Binary file not shown.
BIN
build-docs/doctrees/collections/index.doctree
Normal file
BIN
build-docs/doctrees/collections/index.doctree
Normal file
Binary file not shown.
BIN
build-docs/doctrees/collections/index_module.doctree
Normal file
BIN
build-docs/doctrees/collections/index_module.doctree
Normal file
Binary file not shown.
BIN
build-docs/doctrees/environment.pickle
Normal file
BIN
build-docs/doctrees/environment.pickle
Normal file
Binary file not shown.
BIN
build-docs/doctrees/index.doctree
Normal file
BIN
build-docs/doctrees/index.doctree
Normal file
Binary file not shown.
4
build-docs/html/.buildinfo
Normal file
4
build-docs/html/.buildinfo
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# 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: e5cff9da6df9636f8df45949fedfe1be
|
||||||
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
134
build-docs/html/_static/_sphinx_javascript_frameworks_compat.js
Normal file
134
build-docs/html/_static/_sphinx_javascript_frameworks_compat.js
Normal file
@ -0,0 +1,134 @@
|
|||||||
|
/*
|
||||||
|
* _sphinx_javascript_frameworks_compat.js
|
||||||
|
* ~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Compatability shim for jQuery and underscores.js.
|
||||||
|
*
|
||||||
|
* WILL BE REMOVED IN Sphinx 6.0
|
||||||
|
* xref RemovedInSphinx60Warning
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* select a different prefix for underscore
|
||||||
|
*/
|
||||||
|
$u = _.noConflict();
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urldecode strings
|
||||||
|
*
|
||||||
|
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||||
|
*/
|
||||||
|
jQuery.urldecode = function(x) {
|
||||||
|
if (!x) {
|
||||||
|
return x
|
||||||
|
}
|
||||||
|
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urlencode strings
|
||||||
|
*/
|
||||||
|
jQuery.urlencode = encodeURIComponent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function returns the parsed url parameters of the
|
||||||
|
* current request. Multiple values per key are supported,
|
||||||
|
* it will always return arrays of strings for the value parts.
|
||||||
|
*/
|
||||||
|
jQuery.getQueryParameters = function(s) {
|
||||||
|
if (typeof s === 'undefined')
|
||||||
|
s = document.location.search;
|
||||||
|
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||||
|
var result = {};
|
||||||
|
for (var i = 0; i < parts.length; i++) {
|
||||||
|
var tmp = parts[i].split('=', 2);
|
||||||
|
var key = jQuery.urldecode(tmp[0]);
|
||||||
|
var value = jQuery.urldecode(tmp[1]);
|
||||||
|
if (key in result)
|
||||||
|
result[key].push(value);
|
||||||
|
else
|
||||||
|
result[key] = [value];
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlight a given string on a jquery object by wrapping it in
|
||||||
|
* span elements with the given class name.
|
||||||
|
*/
|
||||||
|
jQuery.fn.highlightText = function(text, className) {
|
||||||
|
function highlight(node, addItems) {
|
||||||
|
if (node.nodeType === 3) {
|
||||||
|
var val = node.nodeValue;
|
||||||
|
var pos = val.toLowerCase().indexOf(text);
|
||||||
|
if (pos >= 0 &&
|
||||||
|
!jQuery(node.parentNode).hasClass(className) &&
|
||||||
|
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||||
|
var span;
|
||||||
|
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||||
|
if (isInSVG) {
|
||||||
|
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||||
|
} else {
|
||||||
|
span = document.createElement("span");
|
||||||
|
span.className = className;
|
||||||
|
}
|
||||||
|
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||||
|
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||||
|
document.createTextNode(val.substr(pos + text.length)),
|
||||||
|
node.nextSibling));
|
||||||
|
node.nodeValue = val.substr(0, pos);
|
||||||
|
if (isInSVG) {
|
||||||
|
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||||
|
var bbox = node.parentElement.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": node.parentNode,
|
||||||
|
"target": rect});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (!jQuery(node).is("button, select, textarea")) {
|
||||||
|
jQuery.each(node.childNodes, function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var addItems = [];
|
||||||
|
var result = this.each(function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
for (var i = 0; i < addItems.length; ++i) {
|
||||||
|
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* backward compatibility for jQuery.browser
|
||||||
|
* This will be supported until firefox bug is fixed.
|
||||||
|
*/
|
||||||
|
if (!jQuery.browser) {
|
||||||
|
jQuery.uaMatch = function(ua) {
|
||||||
|
ua = ua.toLowerCase();
|
||||||
|
|
||||||
|
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(msie) ([\w.]+)/.exec(ua) ||
|
||||||
|
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||||
|
[];
|
||||||
|
|
||||||
|
return {
|
||||||
|
browser: match[ 1 ] || "",
|
||||||
|
version: match[ 2 ] || "0"
|
||||||
|
};
|
||||||
|
};
|
||||||
|
jQuery.browser = {};
|
||||||
|
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||||
|
}
|
3
build-docs/html/_static/antsibull-minimal.css
Normal file
3
build-docs/html/_static/antsibull-minimal.css
Normal file
File diff suppressed because one or more lines are too long
899
build-docs/html/_static/basic.css
Normal file
899
build-docs/html/_static/basic.css
Normal file
@ -0,0 +1,899 @@
|
|||||||
|
/*
|
||||||
|
* basic.css
|
||||||
|
* ~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Sphinx stylesheet -- basic theme.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2022 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;
|
||||||
|
}
|
||||||
|
a.brackets:before,
|
||||||
|
span.brackets > a:before{
|
||||||
|
content: "[";
|
||||||
|
}
|
||||||
|
|
||||||
|
a.brackets:after,
|
||||||
|
span.brackets > a:after {
|
||||||
|
content: "]";
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
div.admonition, div.topic, blockquote {
|
||||||
|
clear: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- topics ---------------------------------------------------------------- */
|
||||||
|
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,
|
||||||
|
div.topic > :last-child,
|
||||||
|
div.admonition > :last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sidebar::after,
|
||||||
|
aside.sidebar::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;
|
||||||
|
}
|
||||||
|
dl.footnote > dt,
|
||||||
|
dl.citation > dt {
|
||||||
|
float: left;
|
||||||
|
margin-right: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd,
|
||||||
|
dl.citation > dd {
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd:after,
|
||||||
|
dl.citation > dd: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 > dt:after {
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
487
build-docs/html/_static/css/ansible.css
Normal file
487
build-docs/html/_static/css/ansible.css
Normal file
@ -0,0 +1,487 @@
|
|||||||
|
@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
|
||||||
|
* */
|
||||||
|
section a[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; }
|
1
build-docs/html/_static/css/badge_only.css
Normal file
1
build-docs/html/_static/css/badge_only.css
Normal file
@ -0,0 +1 @@
|
|||||||
|
.fa:before{-webkit-font-smoothing:antialiased}.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}}
|
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Bold.woff
Normal file
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Bold.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Bold.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Bold.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Regular.woff
Normal file
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Regular.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Regular.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/Roboto-Slab-Regular.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.eot
Normal file
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
build-docs/html/_static/css/fonts/fontawesome-webfont.svg
Normal file
2671
build-docs/html/_static/css/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load Diff
After Width: | Height: | Size: 434 KiB |
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.ttf
Normal file
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.woff
Normal file
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-bold-italic.woff
Normal file
BIN
build-docs/html/_static/css/fonts/lato-bold-italic.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-bold-italic.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/lato-bold-italic.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-bold.woff
Normal file
BIN
build-docs/html/_static/css/fonts/lato-bold.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-bold.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/lato-bold.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-normal-italic.woff
Normal file
BIN
build-docs/html/_static/css/fonts/lato-normal-italic.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-normal-italic.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/lato-normal-italic.woff2
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-normal.woff
Normal file
BIN
build-docs/html/_static/css/fonts/lato-normal.woff
Normal file
Binary file not shown.
BIN
build-docs/html/_static/css/fonts/lato-normal.woff2
Normal file
BIN
build-docs/html/_static/css/fonts/lato-normal.woff2
Normal file
Binary file not shown.
4
build-docs/html/_static/css/rtd-ethical-ads.css
Normal file
4
build-docs/html/_static/css/rtd-ethical-ads.css
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
.ethical-sidebar,
|
||||||
|
.ethical-footer {
|
||||||
|
border-radius: 0 !important;
|
||||||
|
}
|
4
build-docs/html/_static/css/theme.css
Normal file
4
build-docs/html/_static/css/theme.css
Normal file
File diff suppressed because one or more lines are too long
264
build-docs/html/_static/doctools.js
Normal file
264
build-docs/html/_static/doctools.js
Normal file
@ -0,0 +1,264 @@
|
|||||||
|
/*
|
||||||
|
* doctools.js
|
||||||
|
* ~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Base JavaScript utilities for all Sphinx HTML documentation.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const _ready = (callback) => {
|
||||||
|
if (document.readyState !== "loading") {
|
||||||
|
callback();
|
||||||
|
} else {
|
||||||
|
document.addEventListener("DOMContentLoaded", callback);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 Documentation = {
|
||||||
|
init: () => {
|
||||||
|
Documentation.highlightSearchWords();
|
||||||
|
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;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlight the search words provided in the url in the text
|
||||||
|
*/
|
||||||
|
highlightSearchWords: () => {
|
||||||
|
const highlight =
|
||||||
|
new URLSearchParams(window.location.search).get("highlight") || "";
|
||||||
|
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:Documentation.hideSearchWords()">' +
|
||||||
|
Documentation.gettext("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"));
|
||||||
|
const url = new URL(window.location);
|
||||||
|
url.searchParams.delete("highlight");
|
||||||
|
window.history.replaceState({}, "", url);
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
|
||||||
|
const blacklistedElements = new Set([
|
||||||
|
"TEXTAREA",
|
||||||
|
"INPUT",
|
||||||
|
"SELECT",
|
||||||
|
"BUTTON",
|
||||||
|
]);
|
||||||
|
document.addEventListener("keydown", (event) => {
|
||||||
|
if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements
|
||||||
|
if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys
|
||||||
|
|
||||||
|
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;
|
||||||
|
case "Escape":
|
||||||
|
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
||||||
|
Documentation.hideSearchWords();
|
||||||
|
event.preventDefault();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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);
|
14
build-docs/html/_static/documentation_options.js
Normal file
14
build-docs/html/_static/documentation_options.js
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
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,
|
||||||
|
};
|
BIN
build-docs/html/_static/file.png
Normal file
BIN
build-docs/html/_static/file.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 286 B |
14
build-docs/html/_static/images/Ansible-Mark-RGB_Black.svg
Normal file
14
build-docs/html/_static/images/Ansible-Mark-RGB_Black.svg
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<?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="0 0 300 300" 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>
|
After Width: | Height: | Size: 902 B |
@ -0,0 +1 @@
|
|||||||
|
<svg id="logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 300 300"><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>
|
After Width: | Height: | Size: 624 B |
10881
build-docs/html/_static/jquery-3.6.0.js
vendored
Normal file
10881
build-docs/html/_static/jquery-3.6.0.js
vendored
Normal file
File diff suppressed because it is too large
Load Diff
2
build-docs/html/_static/jquery.js
vendored
Normal file
2
build-docs/html/_static/jquery.js
vendored
Normal file
File diff suppressed because one or more lines are too long
1
build-docs/html/_static/js/badge_only.js
Normal file
1
build-docs/html/_static/js/badge_only.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
!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
build-docs/html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
4
build-docs/html/_static/js/html5shiv-printshiv.min.js
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/**
|
||||||
|
* @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
build-docs/html/_static/js/html5shiv.min.js
vendored
Normal file
4
build-docs/html/_static/js/html5shiv.min.js
vendored
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/**
|
||||||
|
* @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);
|
1
build-docs/html/_static/js/theme.js
Normal file
1
build-docs/html/_static/js/theme.js
Normal file
File diff suppressed because one or more lines are too long
199
build-docs/html/_static/language_data.js
Normal file
199
build-docs/html/_static/language_data.js
Normal file
@ -0,0 +1,199 @@
|
|||||||
|
/*
|
||||||
|
* 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-2022 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
BIN
build-docs/html/_static/minus.png
Normal file
BIN
build-docs/html/_static/minus.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 90 B |
BIN
build-docs/html/_static/plus.png
Normal file
BIN
build-docs/html/_static/plus.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 90 B |
80
build-docs/html/_static/pygments.css
Normal file
80
build-docs/html/_static/pygments.css
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
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 .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 */
|
530
build-docs/html/_static/searchtools.js
Normal file
530
build-docs/html/_static/searchtools.js
Normal file
@ -0,0 +1,530 @@
|
|||||||
|
/*
|
||||||
|
* searchtools.js
|
||||||
|
* ~~~~~~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Sphinx JavaScript utilities for the full-text search.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2022 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, highlightTerms, 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] = 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;
|
||||||
|
}
|
||||||
|
const params = new URLSearchParams();
|
||||||
|
params.set("highlight", [...highlightTerms].join(" "));
|
||||||
|
let linkEl = listItem.appendChild(document.createElement("a"));
|
||||||
|
linkEl.href = linkUrl + "?" + params.toString() + anchor;
|
||||||
|
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, highlightTerms)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
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,
|
||||||
|
highlightTerms,
|
||||||
|
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(), highlightTerms, searchTerms);
|
||||||
|
setTimeout(
|
||||||
|
() => _displayNextItem(results, resultCount, highlightTerms, 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) => {
|
||||||
|
// 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);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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"));
|
||||||
|
|
||||||
|
// 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, highlightTerms, 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 docNames = Search._index.docnames;
|
||||||
|
const filenames = Search._index.filenames;
|
||||||
|
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, highlightWords is the list of normal, unstemmed
|
||||||
|
* words. the first one is used to find the occurrence, the
|
||||||
|
* latter for highlighting it.
|
||||||
|
*/
|
||||||
|
makeSearchSummary: (htmlText, keywords, highlightWords) => {
|
||||||
|
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;
|
||||||
|
|
||||||
|
highlightWords.forEach((highlightWord) =>
|
||||||
|
_highlightText(summary, highlightWord, "highlighted")
|
||||||
|
);
|
||||||
|
|
||||||
|
return summary;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
_ready(Search.init);
|
2042
build-docs/html/_static/underscore-1.13.1.js
Normal file
2042
build-docs/html/_static/underscore-1.13.1.js
Normal file
File diff suppressed because it is too large
Load Diff
6
build-docs/html/_static/underscore.js
Normal file
6
build-docs/html/_static/underscore.js
Normal file
File diff suppressed because one or more lines are too long
@ -0,0 +1,353 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting" href="alert_notification_policy_module.html" />
|
||||||
|
<link rel="prev" title="Grafana.Grafana" 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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana</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-grafana-grafana-alert-contact-point-module"></span><section id="grafana-grafana-alert-contact-point-module-manage-alerting-contact-points-in-grafana">
|
||||||
|
<h1>grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana<a class="headerlink" href="#grafana-grafana-alert-contact-point-module-manage-alerting-contact-points-in-grafana" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.alert_contact_point</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create, Update and delete Contact points using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-DisableResolveMessage"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-disableresolvemessage"><strong>DisableResolveMessage</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-DisableResolveMessage" 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>When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">no</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">yes</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-grafana_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-grafana-api-key"><strong>grafana_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-grafana_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Grafana API Key used to authenticate with Grafana.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the contact point</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-settings"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-settings"><strong>settings</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-settings" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Contact point settings</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-type"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-type"><strong>type</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Contact point type</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-uid"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-parameter-uid"><strong>uid</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-uid" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Sets the UID of the Contact point.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create/Update Alerting contact point</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">alert_contact_point</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ops-email</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">uid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">opsemail</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">email</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">settings</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> addresses</span><span class="p">:</span><span class="w"> </span><span class="s">"ops@mydomain.com,devs@mydomain.com"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">}</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">grafana_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete Alerting contact point</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">alert_contact_point</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ops-email</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">uid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">opsemail</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">email</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">settings</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> addresses</span><span class="p">:</span><span class="w"> </span><span class="s">"ops@mydomain.com,devs@mydomain.com"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">}</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">grafana_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output"><strong>output</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Dict object containing Contact point information information</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/disableResolveMessage"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output-disableresolvemessage"><strong>disableResolveMessage</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/disableResolveMessage" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name for the contact point</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/settings"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output-settings"><strong>settings</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/settings" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Contains contact point settings</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/type"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output-type"><strong>type</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/type" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The type of contact point</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/uid"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-contact-point-module-return-output-uid"><strong>uid</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/uid" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The UID for the contact point</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></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="Grafana.Grafana" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="alert_notification_policy_module.html" class="btn btn-neutral float-right" title="grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,405 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys" href="cloud_api_key_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana" href="alert_contact_point_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting</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-grafana-grafana-alert-notification-policy-module"></span><section id="grafana-grafana-alert-notification-policy-module-sets-the-notification-policy-tree-in-grafana-alerting">
|
||||||
|
<h1>grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting<a class="headerlink" href="#grafana-grafana-alert-notification-policy-module-sets-the-notification-policy-tree-in-grafana-alerting" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.alert_notification_policy</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Set the notification policy tree using Ansible</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-Continue"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-continue"><strong>Continue</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-Continue" 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>Continue matching subsequent sibling nodes if set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">no</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">yes</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-grafana_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-grafana-api-key"><strong>grafana_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-grafana_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Grafana API Key used to authenticate with Grafana.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-GroupByStr"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-groupbystr"><strong>GroupByStr</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-GroupByStr" 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 string.</p>
|
||||||
|
<p>Group alerts when you receive a notification based on labels. If empty it will be inherited from the parent policy.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">[]</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-groupInterval"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-groupinterval"><strong>groupInterval</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-groupInterval" 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 wait time to send a batch of new alerts for that group after the first notification was sent. Inherited from the parent policy if empty.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“5m”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-groupWait"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-groupwait"><strong>groupWait</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-groupWait" 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 wait time until the initial notification is sent for a new group created by an incoming alert. Inherited from the parent policy if empty.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“30s”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-MuteTimeIntervals"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-mutetimeintervals"><strong>MuteTimeIntervals</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-MuteTimeIntervals" 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 string.</p>
|
||||||
|
<p>Add mute timing to policy</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">[]</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-objectMatchers"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-objectmatchers"><strong>objectMatchers</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-objectMatchers" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-repeatInterval"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-repeatinterval"><strong>repeatInterval</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-repeatInterval" 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 waiting time to resend an alert after they have successfully been sent.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“4h”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-root_policy_receiver"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-root-policy-receiver"><strong>root_policy_receiver</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-root_policy_receiver" 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>Name of the contact point to set as the default receiver</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“grafana-default-email”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-Routes"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-routes"><strong>Routes</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-Routes" 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> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>List of objects</p>
|
||||||
|
<p>A Route is a node that contains definitions of how to handle alerts.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-parameter-stack-slug"><strong>stack_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud stack to which the notification policies will be added</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Set Notification policy tree</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">alert_notification_policy</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">grafana_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">routes</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> receiver</span><span class="p">:</span><span class="w"> </span><span class="nv">myReceiver</span><span class="p p-Indicator">,</span><span class="w"></span>
|
||||||
|
<span class="nt"> object_matchers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[[</span><span class="s">"env"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"="</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"Production"</span><span class="p p-Indicator">]],</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">}</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Set nested Notification policies</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">alert_notification_policy</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">routes</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> receiver</span><span class="p">:</span><span class="w"> </span><span class="nv">myReceiver</span><span class="p p-Indicator">,</span><span class="w"></span>
|
||||||
|
<span class="nt"> object_matchers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[[</span><span class="s">"env"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"="</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"Production"</span><span class="p p-Indicator">],[</span><span class="s">"team"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"="</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"ops"</span><span class="p p-Indicator">]],</span><span class="w"></span>
|
||||||
|
<span class="nt"> routes</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> receiver</span><span class="p">:</span><span class="w"> </span><span class="nv">myReceiver2</span><span class="p p-Indicator">,</span><span class="w"></span>
|
||||||
|
<span class="nt"> object_matchers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[[</span><span class="s">"region"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"="</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"eu"</span><span class="p p-Indicator">]],</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">}</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">},</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">{</span><span class="w"></span>
|
||||||
|
<span class="nt"> receiver</span><span class="p">:</span><span class="w"> </span><span class="nv">myReceiver3</span><span class="p p-Indicator">,</span><span class="w"></span>
|
||||||
|
<span class="nt"> object_matchers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[[</span><span class="s">"env"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"="</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"Staging"</span><span class="p p-Indicator">]]</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">}</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">grafana_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output"><strong>output</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Dict object containing Notification tree information</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/group_interval"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-group-interval"><strong>group_interval</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/group_interval" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The waiting time to send a batch of new alerts for that group after the first notification was sent. This is of the parent policy.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/group_wait"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-group-wait"><strong>group_wait</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/group_wait" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The waiting time until the initial notification is sent for a new group created by an incoming alert. This is of the parent policy.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/provenance"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-provenance"><strong>provenance</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/provenance" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/receiver"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-receiver"><strong>receiver</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/receiver" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the default contact point</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/repeat_interval"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-repeat-interval"><strong>repeat_interval</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/repeat_interval" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The waiting time to resend an alert after they have successfully been sent. This is of the parent policy</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/routes"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-alert-notification-policy-module-return-output-routes"><strong>routes</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/routes" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-cell"><p>The entire notification tree returned as a list</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="alert_contact_point_module.html" class="btn btn-neutral float-left" title="grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cloud_api_key_module.html" class="btn btn-neutral float-right" title="grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,276 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins" href="cloud_plugin_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting" href="alert_notification_policy_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys</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-grafana-grafana-cloud-api-key-module"></span><section id="grafana-grafana-cloud-api-key-module-manage-grafana-cloud-api-keys">
|
||||||
|
<h1>grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys<a class="headerlink" href="#grafana-grafana-cloud-api-key-module-manage-grafana-cloud-api-keys" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.cloud_api_key</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create and delete Grafana Cloud API keys using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-existing_cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-existing-cloud-api-key"><strong>existing_cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-existing_cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-fail_if_already_created"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-fail-if-already-created"><strong>fail_if_already_created</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-fail_if_already_created" 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>If set to True, the task will fail if the API key with same name already exists in the Organization.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-choices-entry">no</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-default-bold">yes</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud API key.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-org_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-org-slug"><strong>org_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-org_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud organization in which Cloud API key will be created</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-role"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-role"><strong>role</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-role" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Role to be associated with the CLoud API key.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-api-key-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create Grafana Cloud API key</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">key_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Admin</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">org_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">org_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">existing_cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">fail_if_already_created</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete Grafana Cloud API key</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">key_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">org_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">org_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">existing_cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="alert_notification_policy_module.html" class="btn btn-neutral float-left" title="grafana.grafana.alert_notification_policy module – Sets the notification policy tree in Grafana Alerting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cloud_plugin_module.html" class="btn btn-neutral float-right" title="grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,318 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.cloud_stack module – Manage Grafana Cloud stack" href="cloud_stack_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys" href="cloud_api_key_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins</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-grafana-grafana-cloud-plugin-module"></span><section id="grafana-grafana-cloud-plugin-module-manage-grafana-cloud-plugins">
|
||||||
|
<h1>grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins<a class="headerlink" href="#grafana-grafana-cloud-plugin-module-manage-grafana-cloud-plugins" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.cloud_plugin</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create, Update and delete Grafana Cloud stacks using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-parameter-cloud-api-key"><strong>cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-parameter-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the plugin, e.g. grafana-github-datasource .</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-parameter-stack-slug"><strong>stack_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud stack to which the plugin will be added</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-version"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-parameter-version"><strong>version</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-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>Version of the plugin to install. Defaults to latest.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“latest”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create/Update a plugin</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_plugin</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">grafana-github-datasource</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1.0.14</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete a Grafana Cloud stack</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_plugin</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">grafana-github-datasource</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-current_version"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-return-current-version"><strong>current_version</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-current_version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Current version of the plugin</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-latest_version"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-return-latest-version"><strong>latest_version</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-latest_version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Latest version available for the plugin</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-pluginId"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-return-pluginid"><strong>pluginId</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-pluginId" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Id for the Plugin</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-pluginName"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-return-pluginname"><strong>pluginName</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-pluginName" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the plugin</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-pluginSlug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-plugin-module-return-pluginslug"><strong>pluginSlug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-pluginSlug" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Slug for the Plugin</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cloud_api_key_module.html" class="btn btn-neutral float-left" title="grafana.grafana.cloud_api_key module – Manage Grafana Cloud API keys" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cloud_stack_module.html" class="btn btn-neutral float-right" title="grafana.grafana.cloud_stack module – Manage Grafana Cloud stack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,376 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.cloud_stack module – Manage Grafana Cloud stack — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.dashboard module – Manage Dashboards in Grafana" href="dashboard_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins" href="cloud_plugin_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.cloud_stack module – Manage Grafana Cloud stack</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-grafana-grafana-cloud-stack-module"></span><section id="grafana-grafana-cloud-stack-module-manage-grafana-cloud-stack">
|
||||||
|
<h1>grafana.grafana.cloud_stack module – Manage Grafana Cloud stack<a class="headerlink" href="#grafana-grafana-cloud-stack-module-manage-grafana-cloud-stack" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.cloud_stack</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create and delete Grafana Cloud stacks using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-cloud-api-key"><strong>cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of stack. Conventionally matches the URL of the instance. For example, “<stack_slug>.grafana.net”.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-org_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-org-slug"><strong>org_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-org_slug" 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>Name of the organization under which Cloud stack is created.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-region"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-region"><strong>region</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-region" 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>Choose a region for your stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">us</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">us-azure</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">eu</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">au</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">eu-azure</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">prod-ap-southeast-0</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">prod-gb-south-0</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">prod-eu-west-3</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-stack-slug"><strong>stack_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Subdomain of the Grafana instance. For example, if slug is <stack_slug>, the instance URL will be <a class="reference external" href="https:/">https:/</a>/<stack_slug>.grafana.net</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-parameter-url"><strong>url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-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>If you use a custom domain for the instance, you can provide it here. For example, “<a class="reference external" href="https://grafana.yourdoman.io">https://grafana.yourdoman.io</a>”.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“https://<stack_slug>.grafana.net”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Grafana Cloud stack</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_stack</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">company_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">slug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">company_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://grafana.company_name.com</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete a Grafana Cloud stack</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_stack</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">company_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">slug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">company_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-alertmanager_name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-alertmanager-name"><strong>alertmanager_name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-alertmanager_name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the alertmanager instance</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-alertmanager_url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-alertmanager-url"><strong>alertmanager_url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-alertmanager_url" title="Permalink to this return value"></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 instance</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-cluster_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-cluster-slug"><strong>cluster_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-cluster_slug" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Slug for the cluster where the Grafana stack is deployed</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-id"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-id"><strong>id</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>ID of the Grafana Cloud stack</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-loki_url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-loki-url"><strong>loki_url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-loki_url" title="Permalink to this return value"></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 for the Loki instance</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-orgID"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-orgid"><strong>orgID</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-orgID" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>ID of the Grafana Cloud organization</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-prometheus_url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-prometheus-url"><strong>prometheus_url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-prometheus_url" title="Permalink to this return value"></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 for the Prometheus instance</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-tempo_url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-tempo-url"><strong>tempo_url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-tempo_url" title="Permalink to this return value"></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 for the Tempo instance</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-cloud-stack-module-return-url"><strong>url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-url" title="Permalink to this return value"></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 Grafana Cloud stack</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cloud_plugin_module.html" class="btn btn-neutral float-left" title="grafana.grafana.cloud_plugin module – Manage Grafana Cloud Plugins" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="dashboard_module.html" class="btn btn-neutral float-right" title="grafana.grafana.dashboard module – Manage Dashboards in Grafana" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,341 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.dashboard module – Manage Dashboards in Grafana — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.datasource module – Manage Data sources in Grafana" href="datasource_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.cloud_stack module – Manage Grafana Cloud stack" href="cloud_stack_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.dashboard module – Manage Dashboards in Grafana</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-grafana-grafana-dashboard-module"></span><section id="grafana-grafana-dashboard-module-manage-dashboards-in-grafana">
|
||||||
|
<h1>grafana.grafana.dashboard module – Manage Dashboards in Grafana<a class="headerlink" href="#grafana-grafana-dashboard-module-manage-dashboards-in-grafana" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.dashboard</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create, Update and delete Dashboards using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-parameter-cloud-api-key"><strong>cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-dashboard"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-parameter-dashboard"><strong>dashboard</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-dashboard" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>JSON source code for dashboard</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-parameter-stack-slug"><strong>stack_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud stack to which the notification policies will be added</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create/Update a dashboard</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">dashboard</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'dashboard.json'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete dashboard</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">dashboard</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'dashboard.json'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output"><strong>output</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Dict object containing folder information</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/id"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-id"><strong>id</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The ID for the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/message"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-message"><strong>message</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/message" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The message returned after the operation on the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is absent and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-slug"><strong>slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/slug" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The slug for the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/status"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-status"><strong>status</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/status" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The status of the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/title"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-title"><strong>title</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/title" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is absent and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/uid"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-uid"><strong>uid</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/uid" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The UID for the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-url"><strong>url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/url" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The endpoint for the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/version"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-dashboard-module-return-output-version"><strong>version</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The version of the dashboard</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cloud_stack_module.html" class="btn btn-neutral float-left" title="grafana.grafana.cloud_stack module – Manage Grafana Cloud stack" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="datasource_module.html" class="btn btn-neutral float-right" title="grafana.grafana.datasource module – Manage Data sources in Grafana" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
@ -0,0 +1,309 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.datasource module – Manage Data sources in Grafana — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.folder module – Manage Folders in Grafana" href="folder_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.dashboard module – Manage Dashboards in Grafana" href="dashboard_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.datasource module – Manage Data sources in Grafana</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-grafana-grafana-datasource-module"></span><section id="grafana-grafana-datasource-module-manage-data-sources-in-grafana">
|
||||||
|
<h1>grafana.grafana.datasource module – Manage Data sources in Grafana<a class="headerlink" href="#grafana-grafana-datasource-module-manage-data-sources-in-grafana" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.datasource</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create, Update and delete Data sources using Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-parameter-cloud-api-key"><strong>cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-datasource"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-parameter-datasource"><strong>datasource</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-datasource" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>JSON source code for the Data source</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-parameter-stack-slug"><strong>stack_slug</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Name of the Grafana Cloud stack to which the notification policies will be added</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create/Update Data sources</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'datasource.json'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete Data sources</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">datasource</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'datasource.json'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-return-output"><strong>output</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Dict object containing Data source information</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/datasource"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-return-output-datasource"><strong>datasource</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/datasource" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The response body content for the data source configuration.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/id"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-return-output-id"><strong>id</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The ID assigned to the data source</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/message"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-return-output-message"><strong>message</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/message" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The message returned after the operation on the Data source</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/name"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-datasource-module-return-output-name"><strong>name</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the data source defined in the JSON source code</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="dashboard_module.html" class="btn btn-neutral float-left" title="grafana.grafana.dashboard module – Manage Dashboards in Grafana" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="folder_module.html" class="btn btn-neutral float-right" title="grafana.grafana.folder module – Manage Folders in Grafana" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
407
build-docs/html/collections/grafana/grafana/folder_module.html
Normal file
407
build-docs/html/collections/grafana/grafana/folder_module.html
Normal file
@ -0,0 +1,407 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>grafana.grafana.folder module – Manage Folders in Grafana — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="Index of all Modules" href="../../index_module.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.datasource module – Manage Data sources in Grafana" href="datasource_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Grafana.Grafana</a><ul class="current">
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="index.html#description">Description</a></li>
|
||||||
|
<li class="toctree-l4 current"><a class="reference internal" href="index.html#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li><a href="index.html">Grafana.Grafana</a> »</li>
|
||||||
|
<li>grafana.grafana.folder module – Manage Folders in Grafana</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-grafana-grafana-folder-module"></span><section id="grafana-grafana-folder-module-manage-folders-in-grafana">
|
||||||
|
<h1>grafana.grafana.folder module – Manage Folders in Grafana<a class="headerlink" href="#grafana-grafana-folder-module-manage-folders-in-grafana" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="admonition note">
|
||||||
|
<p class="admonition-title">Note</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/grafana/grafana">grafana.grafana collection</a> (version 0.0.6).</p>
|
||||||
|
<p>You might already have this collection installed if you are using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package.
|
||||||
|
It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||||
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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">grafana.grafana</span></code>.</p>
|
||||||
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">grafana.grafana.folder</span></code>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 0.0.1: </span>of grafana.grafana</p>
|
||||||
|
</div>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||||
|
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="synopsis">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Create, Update and delete Folders via Ansible.</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="parameters">
|
||||||
|
<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
||||||
|
<table class="colwidths-auto 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-cloud_api_key"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-parameter-cloud-api-key"><strong>cloud_api_key</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>CLoud API Key to authenticate with Grafana Cloud.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-overwrite"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-parameter-overwrite"><strong>overwrite</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-overwrite" 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>Set to false if you dont want to overwrite existing folder with newer version.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <span class="ansible-option-default">“yes”</span></p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-parameter-state"><strong>state</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State for the Grafana CLoud stack.</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><span class="ansible-option-default-bold">present</span> <span class="ansible-option-default">← (default)</span></p></li>
|
||||||
|
<li><p><span class="ansible-option-choices-entry">absent</span></p></li>
|
||||||
|
</ul>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-title"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-parameter-title"><strong>title</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-title" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>The title of the folder.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-uid"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-parameter-uid"><strong>uid</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-uid" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>unique identifier for your folder.</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section id="examples">
|
||||||
|
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
||||||
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create/Update a Folder in Grafana</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">folder</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">folder_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">uid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">folder_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">overwrite</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span><span class="w"></span>
|
||||||
|
|
||||||
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete a Folder in Grafana</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">folder</span><span class="p">:</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">uid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">folder_name</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">stack_slug</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">stack_slug</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">cloud_api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">grafana_cloud_api_key</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span>
|
||||||
|
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span><span class="w"></span>
|
||||||
|
</pre></div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section id="return-values">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||||
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||||
|
<th class="head"><p>Description</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output"><strong>output</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-cell"><p>Dict object containing folder information</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> On success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/canAdmin"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-canadmin"><strong>canAdmin</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/canAdmin" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Boolean value specifying if current user can admin in folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/canDelete"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-candelete"><strong>canDelete</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/canDelete" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Boolean value specifying if current user can delete the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/canEdit"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-canedit"><strong>canEdit</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/canEdit" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Boolean value specifying if current user can edit in folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/canSave"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-cansave"><strong>canSave</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/canSave" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Boolean value specifying if current user can save in folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/created"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-created"><strong>created</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/created" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The date when folder was created</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/createdBy"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-createdby"><strong>createdBy</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/createdBy" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the user who created the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/hasAcl"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-hasacl"><strong>hasAcl</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/hasAcl" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Boolean value specifying if folder has acl</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/id"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-id"><strong>id</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The ID for the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/message"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-message"><strong>message</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/message" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The message returned after the operation on the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is absent and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/title"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-title"><strong>title</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/title" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/uid"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-uid"><strong>uid</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/uid" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The UID for the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/updated"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-updated"><strong>updated</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/updated" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The date when the folder was last updated</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/updatedBy"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-updatedby"><strong>updatedBy</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/updatedBy" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The name of the user who last updated the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/url"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-url"><strong>url</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/url" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The URl for the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-output/version"></div><p class="ansible-option-title" id="ansible-collections-grafana-grafana-folder-module-return-output-version"><strong>version</strong></p>
|
||||||
|
<a class="ansibleOptionLink" href="#return-output/version" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The version of the folder</p>
|
||||||
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> state is present and on success</p>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<section id="authors">
|
||||||
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Ishan Jain (@ishanjainn)</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section id="collection-links">
|
||||||
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||||
|
</p></section>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="datasource_module.html" class="btn btn-neutral float-left" title="grafana.grafana.datasource module – Manage Data sources in Grafana" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="../../index_module.html" class="btn btn-neutral float-right" title="Index of all Modules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
198
build-docs/html/collections/grafana/grafana/index.html
Normal file
198
build-docs/html/collections/grafana/grafana/index.html
Normal file
@ -0,0 +1,198 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Grafana.Grafana — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../../_static/underscore.js"></script>
|
||||||
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../../_static/doctools.js"></script>
|
||||||
|
<script src="../../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../../search.html" />
|
||||||
|
<link rel="next" title="grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana" href="alert_contact_point_module.html" />
|
||||||
|
<link rel="prev" title="Collections in the Grafana Namespace" 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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Collections in the Grafana Namespace</a><ul class="current">
|
||||||
|
<li class="toctree-l3 current"><a class="current reference internal" href="#">Grafana.Grafana</a><ul>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#description">Description</a></li>
|
||||||
|
<li class="toctree-l4"><a class="reference internal" href="#plugin-index">Plugin Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../../index.html">Collection Index</a> »</li>
|
||||||
|
<li><a href="../index.html">Collections in the Grafana Namespace</a> »</li>
|
||||||
|
<li>Grafana.Grafana</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="grafana-grafana">
|
||||||
|
<span id="plugins-in-grafana-grafana"></span><h1>Grafana.Grafana<a class="headerlink" href="#grafana-grafana" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>Collection version 0.0.6</p>
|
||||||
|
<div class="contents local topic" 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>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<section id="description">
|
||||||
|
<h2><a class="toc-backref" href="#id1">Description</a><a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>Ansible collection to manage Grafana resources</p>
|
||||||
|
<p><strong>Authors:</strong></p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p>Grafana Labs <grafana.com></p></li>
|
||||||
|
<li><p>Ishan Jain <<a class="reference external" href="mailto:ishan.jain%40grafana.com">ishan<span>.</span>jain<span>@</span>grafana<span>.</span>com</a>></p></li>
|
||||||
|
</ul>
|
||||||
|
<p class="ansible-links">
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||||
|
<a href="https://github.com/grafana/grafana-ansible-collection" 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">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h2>
|
||||||
|
<p>These are the plugins in the grafana.grafana collection:</p>
|
||||||
|
<section id="modules">
|
||||||
|
<h3>Modules<a class="headerlink" href="#modules" title="Permalink to this heading"></a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="alert_contact_point_module.html#ansible-collections-grafana-grafana-alert-contact-point-module"><span class="std std-ref">alert_contact_point module</span></a> – Manage Alerting Contact points in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="alert_notification_policy_module.html#ansible-collections-grafana-grafana-alert-notification-policy-module"><span class="std std-ref">alert_notification_policy module</span></a> – Sets the notification policy tree in Grafana Alerting</p></li>
|
||||||
|
<li><p><a class="reference internal" href="cloud_api_key_module.html#ansible-collections-grafana-grafana-cloud-api-key-module"><span class="std std-ref">cloud_api_key module</span></a> – Manage Grafana Cloud API keys</p></li>
|
||||||
|
<li><p><a class="reference internal" href="cloud_plugin_module.html#ansible-collections-grafana-grafana-cloud-plugin-module"><span class="std std-ref">cloud_plugin module</span></a> – Manage Grafana Cloud Plugins</p></li>
|
||||||
|
<li><p><a class="reference internal" href="cloud_stack_module.html#ansible-collections-grafana-grafana-cloud-stack-module"><span class="std std-ref">cloud_stack module</span></a> – Manage Grafana Cloud stack</p></li>
|
||||||
|
<li><p><a class="reference internal" href="dashboard_module.html#ansible-collections-grafana-grafana-dashboard-module"><span class="std std-ref">dashboard module</span></a> – Manage Dashboards in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="datasource_module.html#ansible-collections-grafana-grafana-datasource-module"><span class="std std-ref">datasource module</span></a> – Manage Data sources in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="folder_module.html#ansible-collections-grafana-grafana-folder-module"><span class="std std-ref">folder module</span></a> – Manage Folders in Grafana</p></li>
|
||||||
|
</ul>
|
||||||
|
<div class="admonition seealso">
|
||||||
|
<p class="admonition-title">See also</p>
|
||||||
|
<p>List of <a class="reference internal" href="../../index.html#list-of-collections"><span class="std std-ref">collections</span></a> with docs hosted here.</p>
|
||||||
|
</div>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
</div>
|
||||||
|
</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="Collections in the Grafana Namespace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="alert_contact_point_module.html" class="btn btn-neutral float-right" title="grafana.grafana.alert_contact_point module – Manage Alerting Contact points in Grafana" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
155
build-docs/html/collections/grafana/index.html
Normal file
155
build-docs/html/collections/grafana/index.html
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Collections in the Grafana Namespace — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
<link rel="next" title="Grafana.Grafana" href="grafana/index.html" />
|
||||||
|
<link rel="prev" title="Collection Index" 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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Collection Index</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Collections in the Grafana Namespace</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="grafana/index.html">Grafana.Grafana</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="../index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li><a href="../index.html">Collection Index</a> »</li>
|
||||||
|
<li>Collections in the Grafana Namespace</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="collections-in-the-grafana-namespace">
|
||||||
|
<span id="list-of-collections-grafana"></span><h1>Collections in the Grafana Namespace<a class="headerlink" href="#collections-in-the-grafana-namespace" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>These are the collections documented here in the <strong>grafana</strong> namespace.</p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="grafana/index.html#plugins-in-grafana-grafana"><span class="std std-ref">grafana.grafana</span></a></p></li>
|
||||||
|
</ul>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
</div>
|
||||||
|
</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="Collection Index" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="grafana/index.html" class="btn btn-neutral float-right" title="Grafana.Grafana" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
151
build-docs/html/collections/index.html
Normal file
151
build-docs/html/collections/index.html
Normal file
@ -0,0 +1,151 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Collection Index — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../_static/underscore.js"></script>
|
||||||
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../_static/doctools.js"></script>
|
||||||
|
<script src="../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
|
<link rel="next" title="Collections in the Grafana Namespace" href="grafana/index.html" />
|
||||||
|
<link rel="prev" title="Welcome to my Ansible collection documentation" 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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Collection Index</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="grafana/index.html">Collections in the Grafana Namespace</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li>Collection Index</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="collection-index">
|
||||||
|
<span id="list-of-collections"></span><h1>Collection Index<a class="headerlink" href="#collection-index" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>These are the collections documented here.</p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/index.html#plugins-in-grafana-grafana"><span class="std std-ref">grafana.grafana</span></a></p></li>
|
||||||
|
</ul>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
</div>
|
||||||
|
</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="Welcome to my Ansible collection documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="grafana/index.html" class="btn btn-neutral float-right" title="Collections in the Grafana Namespace" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
156
build-docs/html/collections/index_module.html
Normal file
156
build-docs/html/collections/index_module.html
Normal file
@ -0,0 +1,156 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Index of all Modules — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="../_static/underscore.js"></script>
|
||||||
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="../_static/doctools.js"></script>
|
||||||
|
<script src="../_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
|
<link rel="prev" title="grafana.grafana.folder module – Manage Folders in Grafana" href="grafana/grafana/folder_module.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="../_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="index.html">Collection Index</a></li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Index of all Modules</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="#grafana-grafana">grafana.grafana</a></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">Ansible collections</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"></a> »</li>
|
||||||
|
<li>Index of all Modules</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-modules">
|
||||||
|
<span id="list-of-module-plugins"></span><h1>Index of all Modules<a class="headerlink" href="#index-of-all-modules" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="grafana-grafana">
|
||||||
|
<h2>grafana.grafana<a class="headerlink" href="#grafana-grafana" title="Permalink to this heading"></a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/alert_contact_point_module.html#ansible-collections-grafana-grafana-alert-contact-point-module"><span class="std std-ref">grafana.grafana.alert_contact_point</span></a> – Manage Alerting Contact points in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/alert_notification_policy_module.html#ansible-collections-grafana-grafana-alert-notification-policy-module"><span class="std std-ref">grafana.grafana.alert_notification_policy</span></a> – Sets the notification policy tree in Grafana Alerting</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/cloud_api_key_module.html#ansible-collections-grafana-grafana-cloud-api-key-module"><span class="std std-ref">grafana.grafana.cloud_api_key</span></a> – Manage Grafana Cloud API keys</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/cloud_plugin_module.html#ansible-collections-grafana-grafana-cloud-plugin-module"><span class="std std-ref">grafana.grafana.cloud_plugin</span></a> – Manage Grafana Cloud Plugins</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/cloud_stack_module.html#ansible-collections-grafana-grafana-cloud-stack-module"><span class="std std-ref">grafana.grafana.cloud_stack</span></a> – Manage Grafana Cloud stack</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/dashboard_module.html#ansible-collections-grafana-grafana-dashboard-module"><span class="std std-ref">grafana.grafana.dashboard</span></a> – Manage Dashboards in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/datasource_module.html#ansible-collections-grafana-grafana-datasource-module"><span class="std std-ref">grafana.grafana.datasource</span></a> – Manage Data sources in Grafana</p></li>
|
||||||
|
<li><p><a class="reference internal" href="grafana/grafana/folder_module.html#ansible-collections-grafana-grafana-folder-module"><span class="std std-ref">grafana.grafana.folder</span></a> – Manage Folders in Grafana</p></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="grafana/grafana/folder_module.html" class="btn btn-neutral float-left" title="grafana.grafana.folder module – Manage Folders in Grafana" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
156
build-docs/html/index.html
Normal file
156
build-docs/html/index.html
Normal file
@ -0,0 +1,156 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Welcome to my Ansible collection documentation — Ansible collections 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.svg"/>
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="Collection Index" href="collections/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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index.html">Collection Index</a></li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index_module.html">Index of all Modules</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="#">Ansible collections</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"></a> »</li>
|
||||||
|
<li>Welcome to my Ansible collection documentation</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">
|
||||||
|
|
||||||
|
<p># Copyright (c) Ansible Project
|
||||||
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or <a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0.txt">https://www.gnu.org/licenses/gpl-3.0.txt</a>)
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later</p>
|
||||||
|
<section id="welcome-to-my-ansible-collection-documentation">
|
||||||
|
<span id="docsite-root-index"></span><h1>Welcome to my Ansible collection documentation<a class="headerlink" href="#welcome-to-my-ansible-collection-documentation" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>This docsite contains documentation of grafana.grafana.</p>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index.html">Collection Index</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index_module.html">Index of all Modules</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="collections/index.html" class="btn btn-neutral float-right" title="Collection Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright Ansible 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>
|
BIN
build-docs/html/objects.inv
Normal file
BIN
build-docs/html/objects.inv
Normal file
Binary file not shown.
154
build-docs/html/search.html
Normal file
154
build-docs/html/search.html
Normal file
@ -0,0 +1,154 @@
|
|||||||
|
<!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 — Ansible collections 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.svg"/>
|
||||||
|
|
||||||
|
<!--[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/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.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="/" style="padding-bottom: 30px;">
|
||||||
|
|
||||||
|
<img class="DocSiteNav-logo"
|
||||||
|
src="_static/images/Ansible-Mark-RGB_White.svg"
|
||||||
|
alt="Ansible Logo">
|
||||||
|
<div class="DocSiteNav-title">Ansible Collections Documentation</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"> Ansible collections
|
||||||
|
</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">
|
||||||
|
<input type="text" class="st-default-search-input" 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">
|
||||||
|
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index.html">Collection Index</a></li>
|
||||||
|
</ul>
|
||||||
|
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="collections/index_module.html">Index of all Modules</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">Ansible collections</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"></a> »</li>
|
||||||
|
<li>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 Ansible 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>
|
1
build-docs/html/searchindex.js
Normal file
1
build-docs/html/searchindex.js
Normal file
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user