diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-18 05:52:35 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-18 05:52:35 +0000 |
| commit | 7fec0b69a082aaeec72fee0612766aa42f6b1b4d (patch) | |
| tree | efb569b86ca4da888717f5433e757145fa322e08 /ansible_collections/containers/podman/docs | |
| parent | Releasing progress-linux version 7.7.0+dfsg-3~progress7.99u1. (diff) | |
| download | ansible-7fec0b69a082aaeec72fee0612766aa42f6b1b4d.tar.xz ansible-7fec0b69a082aaeec72fee0612766aa42f6b1b4d.zip | |
Merging upstream version 9.4.0+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/containers/podman/docs')
43 files changed, 8214 insertions, 7506 deletions
diff --git a/ansible_collections/containers/podman/docs/_static/alabaster.css b/ansible_collections/containers/podman/docs/_static/alabaster.css index 0eddaeb07..517d0b29c 100644 --- a/ansible_collections/containers/podman/docs/_static/alabaster.css +++ b/ansible_collections/containers/podman/docs/_static/alabaster.css @@ -419,7 +419,9 @@ table.footnote td { } dl { - margin: 0; + margin-left: 0; + margin-right: 0; + margin-top: 0; padding: 0; } diff --git a/ansible_collections/containers/podman/docs/_static/antsibull-minimal.css b/ansible_collections/containers/podman/docs/_static/antsibull-minimal.css index 6f2872704..3b17984c1 100644 --- a/ansible_collections/containers/podman/docs/_static/antsibull-minimal.css +++ b/ansible_collections/containers/podman/docs/_static/antsibull-minimal.css @@ -1,2 +1,3 @@ @charset "UTF-8"; -/* Copyright (c) Ansible and contributors */table.documentation-table{border-bottom:1px solid #000;border-right:1px solid #000}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid #000;border-top:1px solid #000}table.documentation-table td.elbow-placeholder{border-left:1px solid #000;border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}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}table.documentation-table tr .ansibleOptionLink{display:inline-block;visibility:hidden}table.documentation-table tr .ansibleOptionLink:after{content:"π"}table.documentation-table tr:hover .ansibleOptionLink:after{visibility:visible}
\ No newline at end of file +/* Copyright (c) Ansible and contributors */ +/* GNU General Public License v3.0+ (see https://www.gnu.org/licenses/gpl-3.0.txt) */.ansible-links{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-align:center;-webkit-align-items:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}.ansible-links>*{margin:2px 4px!important}.ansible-links>li{list-style:none!important}.ansible-links>li>p{display:inline}.ansible-links a{display:block;padding:4px 12px;cursor:pointer;border-radius:3px;background-color:#5bbdbf;color:#fff}.ansible-links a:active,.ansible-links a:focus,.ansible-links a:hover{background-color:#91d9db}.ansible-links a:focus{outline:3px solid #204748}table.documentation-table{border-bottom:1px solid #000;border-right:1px solid #000}table.documentation-table th{background-color:#6ab0de}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid #000;border-top:1px solid #000}table.documentation-table td.elbow-placeholder{border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table tr .ansibleOptionLink{display:inline-block}table.documentation-table tr .ansibleOptionLink:after{content:"π";opacity:0}table.documentation-table tr:hover .ansibleOptionLink:after{opacity:1}table.documentation-table tr:nth-child(odd){background-color:#fff}table.documentation-table tr:nth-child(2n){background-color:#e7f2fa}table.ansible-option-table{display:table;border-color:#000!important;height:1px}table.ansible-option-table tr{height:100%}table.ansible-option-table td,table.ansible-option-table th{border-color:#000!important;border-bottom:none!important;vertical-align:top!important}table.ansible-option-table th>p{font-size:medium!important}table.ansible-option-table thead tr{background-color:#6ab0de}table.ansible-option-table tbody .row-odd td{background-color:#fff!important}table.ansible-option-table tbody .row-even td{background-color:#e7f2fa!important}table.ansible-option-table ul>li>p{margin:0!important}table.ansible-option-table ul>li>div[class^=highlight]{margin-bottom:4px!important}table.ansible-option-table p.ansible-option-title{display:inline}table.ansible-option-table .ansible-option-type-line{font-size:small;margin-bottom:0}table.ansible-option-table .ansible-option-elements,table.ansible-option-table .ansible-option-type{color:purple}table.ansible-option-table .ansible-option-required{color:red}table.ansible-option-table .ansible-option-versionadded{font-size:small;color:#006400}table.ansible-option-table .ansible-option-aliases{color:#006400;white-space:normal}table.ansible-option-table .ansible-option-line{margin-top:8px}table.ansible-option-table .ansible-option-choices-default-mark,table.ansible-option-table .ansible-option-default,table.ansible-option-table .ansible-option-default-bold{color:#00f}table.ansible-option-table .ansible-option-sample{color:#00f;word-wrap:break-word;word-break:break-all}table.ansible-option-table .ansible-option-sample-bold{color:#000}table.ansible-option-table .ansible-attribute-support-none{color:red}table.ansible-option-table .ansible-attribute-support-partial{color:#a5a500}table.ansible-option-table .ansible-attribute-support-full{color:green}table.ansible-option-table .ansibleOptionLink{display:inline-block}table.ansible-option-table .ansibleOptionLink:after{content:"π";opacity:0}table.ansible-option-table p{margin:0 0 8px}table.ansible-option-table tr:hover .ansibleOptionLink:after{opacity:1}table.ansible-option-table td{padding:0!important;white-space:normal}table.ansible-option-table td>div.ansible-option-cell{padding:8px 16px;border-top:1px solid #000}table.ansible-option-table td:first-child{height:inherit;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:first-child>div.ansible-option-cell{height:inherit;-webkit-box-flex:1;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;white-space:nowrap;max-width:100%}table.ansible-option-table .ansible-option-indent{margin-left:2em;border-right:1px solid #000}table.ansible-option-table .ansible-attribute-support-label{display:none}@media (max-width:1200px){table.ansible-option-table{display:block;height:unset;border:none!important}table.ansible-option-table thead{display:none}table.ansible-option-table tbody,table.ansible-option-table td,table.ansible-option-table tr{display:block;border:none!important}table.ansible-option-table tbody .row-even td,table.ansible-option-table tbody .row-odd td{background-color:unset!important}table.ansible-option-table td>div.ansible-option-cell{border-top:none}table.ansible-option-table td:first-child>div.ansible-option-cell{background-color:#e7f2fa!important}table.ansible-option-table td:not(:first-child){display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row}table.ansible-option-table td:not(:first-child)>div.ansible-option-cell{margin-left:1em}table.ansible-option-table .ansible-option-indent,table.ansible-option-table .ansible-option-indent-desc{margin-left:1em;border:none;border-right:3px solid #e7f2fa}table.ansible-option-table .ansible-attribute-support-label{display:unset}}.ansible-version-added{font-style:italic}.ansible-option-value a.reference.external,.ansible-option-value a.reference.external:hover,.ansible-option-value a.reference.internal,.ansible-option-value a.reference.internal:hover,.ansible-option a.reference.external,.ansible-option a.reference.external:hover,.ansible-option a.reference.internal,.ansible-option a.reference.internal:hover,.ansible-return-value a.reference.external,.ansible-return-value a.reference.external:hover,.ansible-return-value a.reference.internal,.ansible-return-value a.reference.internal:hover{color:unset}
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/_static/basic.css b/ansible_collections/containers/podman/docs/_static/basic.css index 7d5974c32..7577acb1a 100644 --- a/ansible_collections/containers/podman/docs/_static/basic.css +++ b/ansible_collections/containers/podman/docs/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { 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, @@ -334,11 +324,17 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } + +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +373,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +382,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -609,25 +609,6 @@ ul.simple p { margin-bottom: 0; } -/* Docutils 0.17 and older (footnotes & citations) */ -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; -} - -/* Docutils 0.18+ (footnotes & citations) */ aside.footnote > span, div.citation > span { float: left; @@ -652,8 +633,6 @@ div.citation > p:last-of-type:after { clear: both; } -/* Footnotes & citations ends */ - dl.field-list { display: grid; grid-template-columns: fit-content(30%) auto; @@ -666,10 +645,6 @@ dl.field-list > dt { padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; margin-top: 0em; diff --git a/ansible_collections/containers/podman/docs/_static/doctools.js b/ansible_collections/containers/podman/docs/_static/doctools.js index c3db08d1c..d06a71d75 100644 --- a/ansible_collections/containers/podman/docs/_static/doctools.js +++ b/ansible_collections/containers/podman/docs/_static/doctools.js @@ -4,12 +4,19 @@ * * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ "use strict"; +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + const _ready = (callback) => { if (document.readyState !== "loading") { callback(); @@ -19,72 +26,10 @@ const _ready = (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(); }, @@ -127,51 +72,6 @@ const Documentation = { }, /** - * 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: () => { @@ -210,15 +110,11 @@ const Documentation = { ) 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 + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; if (!event.shiftKey) { switch (event.key) { @@ -240,10 +136,6 @@ const Documentation = { event.preventDefault(); } break; - case "Escape": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.hideSearchWords(); - event.preventDefault(); } } diff --git a/ansible_collections/containers/podman/docs/_static/documentation_options.js b/ansible_collections/containers/podman/docs/_static/documentation_options.js index a750e4d5e..b57ae3b83 100644 --- a/ansible_collections/containers/podman/docs/_static/documentation_options.js +++ b/ansible_collections/containers/podman/docs/_static/documentation_options.js @@ -10,5 +10,5 @@ var DOCUMENTATION_OPTIONS = { SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false, SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: false, + ENABLE_SEARCH_SHORTCUTS: true, };
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/_static/language_data.js b/ansible_collections/containers/podman/docs/_static/language_data.js index 2e22b06ab..250f5665f 100644 --- a/ansible_collections/containers/podman/docs/_static/language_data.js +++ b/ansible_collections/containers/podman/docs/_static/language_data.js @@ -5,7 +5,7 @@ * 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. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/ansible_collections/containers/podman/docs/_static/pygments.css b/ansible_collections/containers/podman/docs/_static/pygments.css index 87f8bd121..9abe04ba5 100644 --- a/ansible_collections/containers/podman/docs/_static/pygments.css +++ b/ansible_collections/containers/podman/docs/_static/pygments.css @@ -54,6 +54,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ .highlight .mb { color: #990000 } /* Literal.Number.Bin */ .highlight .mf { color: #990000 } /* Literal.Number.Float */ diff --git a/ansible_collections/containers/podman/docs/_static/searchtools.js b/ansible_collections/containers/podman/docs/_static/searchtools.js index ac4d5861f..97d56a74d 100644 --- a/ansible_collections/containers/podman/docs/_static/searchtools.js +++ b/ansible_collections/containers/podman/docs/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -57,14 +57,14 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, highlightTerms, searchTerms) => { +const _displayItem = (item, searchTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const [docName, title, anchor, descr] = item; + const [docName, title, anchor, descr, score, _filename] = item; let listItem = document.createElement("li"); let requestUrl; @@ -82,13 +82,12 @@ const _displayItem = (item, highlightTerms, searchTerms) => { 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.href = linkUrl + anchor; + linkEl.dataset.score = score; linkEl.innerHTML = title; if (descr) - listItem.appendChild(document.createElement("span")).innerText = + listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; else if (showSearchSummary) fetch(requestUrl) @@ -96,7 +95,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => { .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, highlightTerms) + Search.makeSearchSummary(data, searchTerms) ); }); Search.output.appendChild(listItem); @@ -116,15 +115,14 @@ const _finishSearch = (resultCount) => { 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); + _displayItem(results.pop(), searchTerms); setTimeout( - () => _displayNextItem(results, resultCount, highlightTerms, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms), 5 ); } @@ -155,10 +153,8 @@ const Search = { _pulse_status: -1, htmlToText: (htmlString) => { - const htmlElement = document - .createRange() - .createContextualFragment(htmlString); - _removeChildren(htmlElement.querySelectorAll(".headerlink")); + 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( @@ -239,6 +235,12 @@ const Search = { * execute search (requires search index to be loaded) */ query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + // stem the search terms and add them to the correct list const stemmer = new Stemmer(); const searchTerms = new Set(); @@ -266,6 +268,10 @@ const Search = { } }); + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + // console.debug("SEARCH: searching for:"); // console.info("required: ", [...searchTerms]); // console.info("excluded: ", [...excludedTerms]); @@ -274,6 +280,40 @@ const Search = { let results = []; _removeChildren(document.getElementById("search-progress")); + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + // lookup as object objectTerms.forEach((term) => results.push(...Search.performObjectSearch(term, objectTerms)) @@ -320,7 +360,7 @@ const Search = { // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, highlightTerms, searchTerms); + _displayNextItem(results, results.length, searchTerms); }, /** @@ -401,8 +441,8 @@ const Search = { // prepare search const terms = Search._index.terms; const titleTerms = Search._index.titleterms; - const docNames = Search._index.docnames; const filenames = Search._index.filenames; + const docNames = Search._index.docnames; const titles = Search._index.titles; const scoreMap = new Map(); @@ -499,16 +539,15 @@ const Search = { /** * 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. + * of stemmed words. */ - makeSearchSummary: (htmlText, keywords, highlightWords) => { - const text = Search.htmlToText(htmlText).toLowerCase(); + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); if (text === "") return null; + const textLower = text.toLowerCase(); const actualStartPosition = [...keywords] - .map((k) => text.indexOf(k.toLowerCase())) + .map((k) => textLower.indexOf(k.toLowerCase())) .filter((i) => i > -1) .slice(-1)[0]; const startWithContext = Math.max(actualStartPosition - 120, 0); @@ -516,13 +555,9 @@ const Search = { const top = startWithContext === 0 ? "" : "..."; const tail = startWithContext + 240 < text.length ? "..." : ""; - let summary = document.createElement("div"); + let summary = document.createElement("p"); summary.classList.add("context"); - summary.innerText = top + text.substr(startWithContext, 240).trim() + tail; - - highlightWords.forEach((highlightWord) => - _highlightText(summary, highlightWord, "highlighted") - ); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; return summary; }, diff --git a/ansible_collections/containers/podman/docs/_static/sphinx_highlight.js b/ansible_collections/containers/podman/docs/_static/sphinx_highlight.js new file mode 100644 index 000000000..aae669d7e --- /dev/null +++ b/ansible_collections/containers/podman/docs/_static/sphinx_highlight.js @@ -0,0 +1,144 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + parent.insertBefore( + span, + parent.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '<p class="highlight-link">' + + '<a href="javascript:SphinxHighlight.hideSearchWords()">' + + _("Hide Search Matches") + + "</a></p>" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(SphinxHighlight.highlightSearchWords); +_ready(SphinxHighlight.initEscapeListener); diff --git a/ansible_collections/containers/podman/docs/buildah_connection.html b/ansible_collections/containers/podman/docs/buildah_connection.html index e0df468d9..0d16691d4 100644 --- a/ansible_collections/containers/podman/docs/buildah_connection.html +++ b/ansible_collections/containers/podman/docs/buildah_connection.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.buildah β Interact with an existing buildah container — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.buildah connection β Interact with an existing buildah container — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman connection β Interact with an existing podman container" href="podman_connection.html" /> + <link rel="prev" title="containers.podman.podman_unshare become β Run tasks using podman unshare" href="podman_unshare_become.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,93 +33,89 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-buildah-connection"></span><div class="section" id="containers-podman-buildah-interact-with-an-existing-buildah-container"> -<h1>containers.podman.buildah β Interact with an existing buildah container<a class="headerlink" href="#containers-podman-buildah-interact-with-an-existing-buildah-container" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-buildah-connection"></span><section id="containers-podman-buildah-connection-interact-with-an-existing-buildah-container"> +<h1>containers.podman.buildah connection β Interact with an existing buildah container<a class="headerlink" href="#containers-podman-buildah-connection-interact-with-an-existing-buildah-container" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This connection plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.buildah</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Run commands or put/fetch files to an existing container using buildah tool.</p></li> </ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-buildah-connection-parameter-remote-addr"><strong>remote_addr</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_addr" 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 ID of the container you want to access.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"inventory_hostname"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul class="simple"> +<li><p>Variable: ansible_host</p></li> +<li><p>Variable: inventory_hostname</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-buildah-connection-parameter-remote-user"><strong>remote_user</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>User specified via name or ID which is used to execute commands inside the container.</p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span> +<span class="n">remote_user</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> </div> -<div class="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 border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th>Configuration</th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_addr"></div> - <b>remote_addr</b> - <a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"inventory_hostname"</div> - </td> - <td> - <div> - var: ansible_host - </div> - </td> - <td> - <div>The ID of the container you want to access.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_user"></div> - <b>remote_user</b> - <a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div> ini entries: - <p> - [defaults]<br>remote_user = None - </p> - </div> - <div> - env:ANSIBLE_REMOTE_USER - </div> - <div> - var: ansible_user - </div> - </td> - <td> - <div>User specified via name or ID which is used to execute commands inside the container.</div> - </td> - </tr> - </table> -<br/><div class="section" id="authors"> +</li> +<li><p>Environment variable: <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_USER</span></code></p></li> +<li><p>Variable: ansible_user</p></li> +</ul> +</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>Tomas Tomecek (@TomasTomecek)</p></li> </ul> +<div class="admonition hint"> +<p class="admonition-title">Hint</p> +<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p> </div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -137,11 +134,48 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_unshare_become.html" title="previous chapter">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> + <li>Next: <a href="podman_connection.html" title="next chapter">containers.podman.podman connection β Interact with an existing podman container</a></li> </ul></li> </ul> </div> @@ -171,8 +205,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/buildah_connection.rst.txt" diff --git a/ansible_collections/containers/podman/docs/environment_variables.html b/ansible_collections/containers/podman/docs/environment_variables.html new file mode 100644 index 000000000..2fc11f2c2 --- /dev/null +++ b/ansible_collections/containers/podman/docs/environment_variables.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>Index of all Collection Environment Variables — Python documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="index-of-all-collection-environment-variables"> +<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Permalink to this heading">ΒΆ</a></h1> +<p>The following index documents all environment variables declared by plugins in collections. +Environment variables used by the ansible-core configuration are documented in <span class="xref std std-ref">ansible_configuration_settings</span>.</p> +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_BECOME_PASS"> +<span class="sig-name descname"><span class="pre">ANSIBLE_BECOME_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_BECOME_PASS" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>Password to pass to sudo</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> +</dd></dl> + +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXECUTABLE"> +<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXECUTABLE" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>Executable for podman command.</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> +</dd></dl> + +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXTRA_ARGS"> +<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXTRA_ARGS" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>Extra arguments to pass to the podman command line.</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> +</dd></dl> + +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_EXE"> +<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_EXE</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_EXE" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>Sudo executable</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> +</dd></dl> + +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_PASS"> +<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_PASS" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>Password to pass to sudo</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> +</dd></dl> + +<dl class="std envvar"> +<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_USER"> +<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_USER</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_USER" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>User you βbecomeβ to execute the task (βrootβ is not a valid value here).</p> +<p><em>Used by:</em> +<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> +</dd></dl> + +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="index.html">Python</a></h1> + + + + + + + + +<h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> + + | + <a href="_sources/environment_variables.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/genindex.html b/ansible_collections/containers/podman/docs/genindex.html index 93bf0742d..312e433c8 100644 --- a/ansible_collections/containers/podman/docs/genindex.html +++ b/ansible_collections/containers/podman/docs/genindex.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -10,10 +9,8 @@ <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="#" /> <link rel="search" title="Search" href="search.html" /> @@ -36,8 +33,65 @@ <h1 id="index">Index</h1> <div class="genindex-jumpbox"> + <a href="#A"><strong>A</strong></a> + | <a href="#E"><strong>E</strong></a> </div> +<h2 id="A">A</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="podman_unshare_become.html#index-0">ANSIBLE_BECOME_EXE</a> +</li> + <li><a href="podman_unshare_become.html#index-2">ANSIBLE_BECOME_PASS</a> +</li> + <li><a href="podman_unshare_become.html#index-4">ANSIBLE_BECOME_USER</a> +</li> + <li><a href="podman_connection.html#index-0">ANSIBLE_PODMAN_EXECUTABLE</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="podman_connection.html#index-1">ANSIBLE_PODMAN_EXTRA_ARGS</a> +</li> + <li><a href="buildah_connection.html#index-0">ANSIBLE_REMOTE_USER</a>, <a href="podman_connection.html#index-2">[1]</a> +</li> + <li><a href="podman_unshare_become.html#index-1">ANSIBLE_SUDO_EXE</a> +</li> + <li><a href="podman_unshare_become.html#index-3">ANSIBLE_SUDO_PASS</a> +</li> + <li><a href="podman_unshare_become.html#index-5">ANSIBLE_SUDO_USER</a> +</li> + </ul></td> +</tr></table> + +<h2 id="E">E</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + environment variable + + <ul> + <li><a href="podman_unshare_become.html#index-0">ANSIBLE_BECOME_EXE</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_BECOME_PASS">ANSIBLE_BECOME_PASS</a>, <a href="podman_unshare_become.html#index-2">[1]</a> +</li> + <li><a href="podman_unshare_become.html#index-4">ANSIBLE_BECOME_USER</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXECUTABLE">ANSIBLE_PODMAN_EXECUTABLE</a>, <a href="podman_connection.html#index-0">[1]</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXTRA_ARGS">ANSIBLE_PODMAN_EXTRA_ARGS</a>, <a href="podman_connection.html#index-1">[1]</a> +</li> + <li><a href="buildah_connection.html#index-0">ANSIBLE_REMOTE_USER</a>, <a href="podman_connection.html#index-2">[1]</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_EXE">ANSIBLE_SUDO_EXE</a>, <a href="podman_unshare_become.html#index-1">[1]</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_PASS">ANSIBLE_SUDO_PASS</a>, <a href="podman_unshare_become.html#index-3">[1]</a> +</li> + <li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_USER">ANSIBLE_SUDO_USER</a>, <a href="podman_unshare_become.html#index-5">[1]</a> +</li> + </ul></li> + </ul></td> +</tr></table> + </div> @@ -56,6 +110,41 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> @@ -90,8 +179,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> </div> diff --git a/ansible_collections/containers/podman/docs/index.html b/ansible_collections/containers/podman/docs/index.html index 8ded11c9a..ec765ccb4 100644 --- a/ansible_collections/containers/podman/docs/index.html +++ b/ansible_collections/containers/podman/docs/index.html @@ -1,21 +1,21 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + <title>Containers.Podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_container module β Manage podman containers" href="podman_container_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,60 +32,89 @@ <div class="body" role="main"> - <div class="section" id="containers-podman"> + <section id="containers-podman"> <span id="plugins-in-containers-podman"></span><h1>Containers.Podman<a class="headerlink" href="#containers-podman" title="Permalink to this heading">ΒΆ</a></h1> -<p>Collection version 1.10.1</p> -<div class="toctree-wrapper compound"> -</div> -<div class="section" id="plugin-index"> -<h2>Plugin Index<a class="headerlink" href="#plugin-index" title="Permalink to this heading">ΒΆ</a></h2> -<p>These are the plugins in the containers.podman collection</p> -<div class="section" id="become-plugins"> -<h3>Become Plugins<a class="headerlink" href="#become-plugins" title="Permalink to this heading">ΒΆ</a></h3> +<p>Collection version 1.11.0</p> +<nav class="contents local" id="contents"> <ul class="simple"> -<li><p><a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">podman_unshare</span></a> β Run tasks using podman unshare</p></li> +<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> -<div class="section" id="connection-plugins"> -<h3>Connection Plugins<a class="headerlink" href="#connection-plugins" title="Permalink to this heading">ΒΆ</a></h3> +</nav> +<section id="description"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Permalink to this heading">ΒΆ</a></h2> +<p>Podman container Ansible modules</p> +<p><strong>Authors:</strong></p> <ul class="simple"> -<li><p><a class="reference internal" href="buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">buildah</span></a> β Interact with an existing buildah container</p></li> -<li><p><a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">podman</span></a> β Interact with an existing podman container</p></li> +<li><p>Sagi Shnaidman <<a class="reference external" href="mailto:sshnaidm%40redhat.com">sshnaidm<span>@</span>redhat<span>.</span>com</a>></p></li> +<li><p>Ansible team</p></li> </ul> +<p><strong>Supported ansible-core versions:</strong></p> +<ul class="simple"> +<li><p>2.8 or newer</p></li> +</ul> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +<div class="toctree-wrapper compound"> </div> -<div class="section" id="modules"> +</section> +<section id="plugin-index"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading">ΒΆ</a></h2> +<p>These are the plugins in the containers.podman 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="podman_container_module.html#ansible-collections-containers-podman-podman-container-module"><span class="std std-ref">podman_container</span></a> β Manage podman containers</p></li> -<li><p><a class="reference internal" href="podman_container_info_module.html#ansible-collections-containers-podman-podman-container-info-module"><span class="std std-ref">podman_container_info</span></a> β Gather facts about containers using podman</p></li> -<li><p><a class="reference internal" href="podman_containers_module.html#ansible-collections-containers-podman-podman-containers-module"><span class="std std-ref">podman_containers</span></a> β Manage podman containers in a batch</p></li> -<li><p><a class="reference internal" href="podman_export_module.html#ansible-collections-containers-podman-podman-export-module"><span class="std std-ref">podman_export</span></a> β Export a podman container</p></li> -<li><p><a class="reference internal" href="podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module"><span class="std std-ref">podman_generate_systemd</span></a> β Generate systemd unit from a pod or a container</p></li> -<li><p><a class="reference internal" href="podman_image_module.html#ansible-collections-containers-podman-podman-image-module"><span class="std std-ref">podman_image</span></a> β Pull images for use by podman</p></li> -<li><p><a class="reference internal" href="podman_image_info_module.html#ansible-collections-containers-podman-podman-image-info-module"><span class="std std-ref">podman_image_info</span></a> β Gather info about images using podman</p></li> -<li><p><a class="reference internal" href="podman_import_module.html#ansible-collections-containers-podman-podman-import-module"><span class="std std-ref">podman_import</span></a> β Import Podman container from a tar file.</p></li> -<li><p><a class="reference internal" href="podman_load_module.html#ansible-collections-containers-podman-podman-load-module"><span class="std std-ref">podman_load</span></a> β Load image from a tar file.</p></li> -<li><p><a class="reference internal" href="podman_login_module.html#ansible-collections-containers-podman-podman-login-module"><span class="std std-ref">podman_login</span></a> β Login to a container registry using podman</p></li> -<li><p><a class="reference internal" href="podman_login_info_module.html#ansible-collections-containers-podman-podman-login-info-module"><span class="std std-ref">podman_login_info</span></a> β Return the logged-in user if any for a given registry</p></li> -<li><p><a class="reference internal" href="podman_logout_module.html#ansible-collections-containers-podman-podman-logout-module"><span class="std std-ref">podman_logout</span></a> β Log out of a container registry using podman</p></li> -<li><p><a class="reference internal" href="podman_network_module.html#ansible-collections-containers-podman-podman-network-module"><span class="std std-ref">podman_network</span></a> β Manage podman networks</p></li> -<li><p><a class="reference internal" href="podman_network_info_module.html#ansible-collections-containers-podman-podman-network-info-module"><span class="std std-ref">podman_network_info</span></a> β Gather info about podman networks</p></li> -<li><p><a class="reference internal" href="podman_play_module.html#ansible-collections-containers-podman-podman-play-module"><span class="std std-ref">podman_play</span></a> β Play kubernetes YAML file using podman</p></li> -<li><p><a class="reference internal" href="podman_pod_module.html#ansible-collections-containers-podman-podman-pod-module"><span class="std std-ref">podman_pod</span></a> β Manage Podman pods</p></li> -<li><p><a class="reference internal" href="podman_pod_info_module.html#ansible-collections-containers-podman-podman-pod-info-module"><span class="std std-ref">podman_pod_info</span></a> β Gather info about podman pods</p></li> -<li><p><a class="reference internal" href="podman_save_module.html#ansible-collections-containers-podman-podman-save-module"><span class="std std-ref">podman_save</span></a> β Saves podman image to tar file</p></li> -<li><p><a class="reference internal" href="podman_secret_module.html#ansible-collections-containers-podman-podman-secret-module"><span class="std std-ref">podman_secret</span></a> β Manage podman secrets</p></li> -<li><p><a class="reference internal" href="podman_tag_module.html#ansible-collections-containers-podman-podman-tag-module"><span class="std std-ref">podman_tag</span></a> β Add an additional name to a local image</p></li> -<li><p><a class="reference internal" href="podman_volume_module.html#ansible-collections-containers-podman-podman-volume-module"><span class="std std-ref">podman_volume</span></a> β Manage Podman volumes</p></li> -<li><p><a class="reference internal" href="podman_volume_info_module.html#ansible-collections-containers-podman-podman-volume-info-module"><span class="std std-ref">podman_volume_info</span></a> β Gather info about podman volumes</p></li> +<li><p><a class="reference internal" href="podman_container_module.html#ansible-collections-containers-podman-podman-container-module"><span class="std std-ref">podman_container module</span></a> β Manage podman containers</p></li> +<li><p><a class="reference internal" href="podman_container_exec_module.html#ansible-collections-containers-podman-podman-container-exec-module"><span class="std std-ref">podman_container_exec module</span></a> β Executes a command in a running container.</p></li> +<li><p><a class="reference internal" href="podman_container_info_module.html#ansible-collections-containers-podman-podman-container-info-module"><span class="std std-ref">podman_container_info module</span></a> β Gather facts about containers using podman</p></li> +<li><p><a class="reference internal" href="podman_containers_module.html#ansible-collections-containers-podman-podman-containers-module"><span class="std std-ref">podman_containers module</span></a> β Manage podman containers in a batch</p></li> +<li><p><a class="reference internal" href="podman_export_module.html#ansible-collections-containers-podman-podman-export-module"><span class="std std-ref">podman_export module</span></a> β Export a podman container</p></li> +<li><p><a class="reference internal" href="podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module"><span class="std std-ref">podman_generate_systemd module</span></a> β Generate systemd unit from a pod or a container</p></li> +<li><p><a class="reference internal" href="podman_image_module.html#ansible-collections-containers-podman-podman-image-module"><span class="std std-ref">podman_image module</span></a> β Pull images for use by podman</p></li> +<li><p><a class="reference internal" href="podman_image_info_module.html#ansible-collections-containers-podman-podman-image-info-module"><span class="std std-ref">podman_image_info module</span></a> β Gather info about images using podman</p></li> +<li><p><a class="reference internal" href="podman_import_module.html#ansible-collections-containers-podman-podman-import-module"><span class="std std-ref">podman_import module</span></a> β Import Podman container from a tar file.</p></li> +<li><p><a class="reference internal" href="podman_load_module.html#ansible-collections-containers-podman-podman-load-module"><span class="std std-ref">podman_load module</span></a> β Load image from a tar file.</p></li> +<li><p><a class="reference internal" href="podman_login_module.html#ansible-collections-containers-podman-podman-login-module"><span class="std std-ref">podman_login module</span></a> β Login to a container registry using podman</p></li> +<li><p><a class="reference internal" href="podman_login_info_module.html#ansible-collections-containers-podman-podman-login-info-module"><span class="std std-ref">podman_login_info module</span></a> β Return the logged-in user if any for a given registry</p></li> +<li><p><a class="reference internal" href="podman_logout_module.html#ansible-collections-containers-podman-podman-logout-module"><span class="std std-ref">podman_logout module</span></a> β Log out of a container registry using podman</p></li> +<li><p><a class="reference internal" href="podman_network_module.html#ansible-collections-containers-podman-podman-network-module"><span class="std std-ref">podman_network module</span></a> β Manage podman networks</p></li> +<li><p><a class="reference internal" href="podman_network_info_module.html#ansible-collections-containers-podman-podman-network-info-module"><span class="std std-ref">podman_network_info module</span></a> β Gather info about podman networks</p></li> +<li><p><a class="reference internal" href="podman_play_module.html#ansible-collections-containers-podman-podman-play-module"><span class="std std-ref">podman_play module</span></a> β Play kubernetes YAML file using podman</p></li> +<li><p><a class="reference internal" href="podman_pod_module.html#ansible-collections-containers-podman-podman-pod-module"><span class="std std-ref">podman_pod module</span></a> β Manage Podman pods</p></li> +<li><p><a class="reference internal" href="podman_pod_info_module.html#ansible-collections-containers-podman-podman-pod-info-module"><span class="std std-ref">podman_pod_info module</span></a> β Gather info about podman pods</p></li> +<li><p><a class="reference internal" href="podman_prune_module.html#ansible-collections-containers-podman-podman-prune-module"><span class="std std-ref">podman_prune module</span></a> β Allows to prune various podman objects</p></li> +<li><p><a class="reference internal" href="podman_runlabel_module.html#ansible-collections-containers-podman-podman-runlabel-module"><span class="std std-ref">podman_runlabel module</span></a> β Run given label from given image</p></li> +<li><p><a class="reference internal" href="podman_save_module.html#ansible-collections-containers-podman-podman-save-module"><span class="std std-ref">podman_save module</span></a> β Saves podman image to tar file</p></li> +<li><p><a class="reference internal" href="podman_secret_module.html#ansible-collections-containers-podman-podman-secret-module"><span class="std std-ref">podman_secret module</span></a> β Manage podman secrets</p></li> +<li><p><a class="reference internal" href="podman_secret_info_module.html#ansible-collections-containers-podman-podman-secret-info-module"><span class="std std-ref">podman_secret_info module</span></a> β Gather info about podman secrets</p></li> +<li><p><a class="reference internal" href="podman_tag_module.html#ansible-collections-containers-podman-podman-tag-module"><span class="std std-ref">podman_tag module</span></a> β Add an additional name to a local image</p></li> +<li><p><a class="reference internal" href="podman_volume_module.html#ansible-collections-containers-podman-podman-volume-module"><span class="std std-ref">podman_volume module</span></a> β Manage Podman volumes</p></li> +<li><p><a class="reference internal" href="podman_volume_info_module.html#ansible-collections-containers-podman-podman-volume-info-module"><span class="std std-ref">podman_volume_info module</span></a> β Gather info about podman volumes</p></li> </ul> -<div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p>List of <span class="xref std std-ref">collections</span> with docs hosted here.</p> -</div> +<div class="toctree-wrapper compound"> </div> +</section> +<section id="become-plugins"> +<h3>Become Plugins<a class="headerlink" href="#become-plugins" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="simple"> +<li><p><a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">podman_unshare become</span></a> β Run tasks using podman unshare</p></li> +</ul> +<div class="toctree-wrapper compound"> </div> +</section> +<section id="connection-plugins"> +<h3>Connection Plugins<a class="headerlink" href="#connection-plugins" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="simple"> +<li><p><a class="reference internal" href="buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">buildah connection</span></a> β Interact with an existing buildah container</p></li> +<li><p><a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">podman connection</span></a> β Interact with an existing podman container</p></li> +</ul> +<div class="toctree-wrapper compound"> </div> +</section> +</section> +</section> </div> @@ -104,11 +133,47 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="#">Documentation overview</a><ul> + <li>Next: <a href="podman_container_module.html" title="next chapter">containers.podman.podman_container module β Manage podman containers</a></li> </ul></li> </ul> </div> @@ -138,8 +203,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/index.rst.txt" diff --git a/ansible_collections/containers/podman/docs/objects.inv b/ansible_collections/containers/podman/docs/objects.inv Binary files differindex 9f05c4b6e..4800e7a8b 100644 --- a/ansible_collections/containers/podman/docs/objects.inv +++ b/ansible_collections/containers/podman/docs/objects.inv diff --git a/ansible_collections/containers/podman/docs/podman_connection.html b/ansible_collections/containers/podman/docs/podman_connection.html index 8b58713f4..666200432 100644 --- a/ansible_collections/containers/podman/docs/podman_connection.html +++ b/ansible_collections/containers/podman/docs/podman_connection.html @@ -1,21 +1,21 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman β Interact with an existing podman container — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman connection β Interact with an existing podman container — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="prev" title="containers.podman.buildah connection β Interact with an existing buildah container" href="buildah_connection.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,152 +32,122 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-connection"></span><div class="section" id="containers-podman-podman-interact-with-an-existing-podman-container"> -<h1>containers.podman.podman β Interact with an existing podman container<a class="headerlink" href="#containers-podman-podman-interact-with-an-existing-podman-container" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-connection"></span><section id="containers-podman-podman-connection-interact-with-an-existing-podman-container"> +<h1>containers.podman.podman connection β Interact with an existing podman container<a class="headerlink" href="#containers-podman-podman-connection-interact-with-an-existing-podman-container" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This connection plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Run commands or put/fetch files to an existing container using podman tool.</p></li> </ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-podman_executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-executable"><strong>podman_executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-podman_executable" 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>Executable for podman command.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul class="simple"> +<li><p>Environment variable: <span class="target" id="index-0"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXECUTABLE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></code></a></p></li> +<li><p>Variable: ansible_podman_executable</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-podman_extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-extra-args"><strong>podman_extra_args</strong></p> +<a class="ansibleOptionLink" href="#parameter-podman_extra_args" 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>Extra arguments to pass to the podman command line.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span> +<span class="n">podman_extra_args</span> <span class="o">=</span> <span class="s2">""</span> +</pre></div> +</div> +</li> +<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXTRA_ARGS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></code></a></p></li> +<li><p>Variable: ansible_podman_extra_args</p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-addr"><strong>remote_addr</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_addr" 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 ID of the container you want to access.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"inventory_hostname"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul class="simple"> +<li><p>Variable: ansible_host</p></li> +<li><p>Variable: inventory_hostname</p></li> +<li><p>Variable: ansible_podman_host</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-user"><strong>remote_user</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set <code class="docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_TMP</span></code> to a path that exits inside the container and is writable by Ansible.</p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span> +<span class="n">remote_user</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> </div> -<div class="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 border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th>Configuration</th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-podman_executable"></div> - <b>podman_executable</b> - <a class="ansibleOptionLink" href="#parameter-podman_executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div> - env:ANSIBLE_PODMAN_EXECUTABLE - </div> - <div> - var: ansible_podman_executable - </div> - </td> - <td> - <div>Executable for podman command.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-podman_extra_args"></div> - <b>podman_extra_args</b> - <a class="ansibleOptionLink" href="#parameter-podman_extra_args" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">""</div> - </td> - <td> - <div> ini entries: - <p> - [defaults]<br>podman_extra_args = - </p> - </div> - <div> - env:ANSIBLE_PODMAN_EXTRA_ARGS - </div> - <div> - var: ansible_podman_extra_args - </div> - </td> - <td> - <div>Extra arguments to pass to the podman command line.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_addr"></div> - <b>remote_addr</b> - <a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"inventory_hostname"</div> - </td> - <td> - <div> - var: ansible_host - </div> - <div> - var: inventory_hostname - </div> - <div> - var: ansible_podman_host - </div> - </td> - <td> - <div>The ID of the container you want to access.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_user"></div> - <b>remote_user</b> - <a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div> ini entries: - <p> - [defaults]<br>remote_user = None - </p> - </div> - <div> - env:ANSIBLE_REMOTE_USER - </div> - <div> - var: ansible_user - </div> - </td> - <td> - <div>User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set <code>ANSIBLE_REMOTE_TMP</code> to a path that exits inside the container and is writable by Ansible.</div> - </td> - </tr> - </table> -<br/><div class="section" id="authors"> +</li> +<li><p>Environment variable: <span class="target" id="index-2"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_USER</span></code></p></li> +<li><p>Variable: ansible_user</p></li> +</ul> +</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>Tomas Tomecek (@TomasTomecek)</p></li> </ul> +<div class="admonition hint"> +<p class="admonition-title">Hint</p> +<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p> </div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -196,11 +166,47 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="buildah_connection.html" title="previous chapter">containers.podman.buildah connection β Interact with an existing buildah container</a></li> </ul></li> </ul> </div> @@ -230,8 +236,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_connection.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_container_exec_module.html b/ansible_collections/containers/podman/docs/podman_container_exec_module.html new file mode 100644 index 000000000..6f99748d8 --- /dev/null +++ b/ansible_collections/containers/podman/docs/podman_container_exec_module.html @@ -0,0 +1,363 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_container_exec module β Executes a command in a running container. — Python documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_container_info module β Gather facts about containers using podman" href="podman_container_info_module.html" /> + <link rel="prev" title="containers.podman.podman_container module β Manage podman containers" href="podman_container_module.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <span class="target" id="ansible-collections-containers-podman-podman-container-exec-module"></span><section id="containers-podman-podman-container-exec-module-executes-a-command-in-a-running-container"> +<h1>containers.podman.podman_container_exec module β Executes a command in a running container.<a class="headerlink" href="#containers-podman-podman-container-exec-module-executes-a-command-in-a-running-container" 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/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-container-exec-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> +<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_container_exec</span></code>.</p> +</div> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> +<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> +<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li> +<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li> +<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li> +</ul> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +<ul class="simple"> +<li><p>Executes a command in a running container.</p></li> +</ul> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-container-exec-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +<p>The below requirements are needed on the host that executes this module.</p> +<ul class="simple"> +<li><p>podman</p></li> +</ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-argv"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-argv"><strong>argv</strong></p> +<a class="ansibleOptionLink" href="#parameter-argv" 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>Passes the command as a list rather than a string.</p> +<p>One of the <em>command</em> or <em>args</em> is required.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-command"><strong>command</strong></p> +<a class="ansibleOptionLink" href="#parameter-command" 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 command to run in the container.</p> +<p>One of the <em>command</em> or <em>args</em> is required.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-detach"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-detach"><strong>detach</strong></p> +<a class="ansibleOptionLink" href="#parameter-detach" 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 true, the command runs in the background.</p> +<p>The exec session is automatically removed when it completes.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-env"><strong>env</strong></p> +<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set environment variables.</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-containers-podman-podman-container-exec-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 container where the command is executed.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-privileged"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-privileged"><strong>privileged</strong></p> +<a class="ansibleOptionLink" href="#parameter-privileged" 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>Give extended privileges to the container.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tty"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-tty"><strong>tty</strong></p> +<a class="ansibleOptionLink" href="#parameter-tty" 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>Allocate a pseudo-TTY.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-user"><strong>user</strong></p> +<a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>The username or UID used and, optionally, the groupname or GID for the specified command.</p> +<p>Both user and group may be symbolic or numeric.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-workdir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-workdir"><strong>workdir</strong></p> +<a class="ansibleOptionLink" href="#parameter-workdir" 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>Working directory inside the container.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="notes"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<ul class="simple"> +<li><p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-exec.1.html">the Podman documentation</a> for details of podman-exec(1).</p></li> +</ul> +</div> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">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">Execute a command with workdir</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</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">ubi8</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"cat</span><span class="nv"> </span><span class="s">redhat-release"</span> +<span class="w"> </span><span class="nt">workdir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc</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">Execute a command with a list of args and environment variables</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</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">test_container</span> +<span class="w"> </span><span class="nt">argv</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/bin/sh</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-c</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">echo $HELLO $BYE</span> +<span class="w"> </span><span class="nt">env</span><span class="p">:</span> +<span class="w"> </span><span class="nt">HELLO</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hello world</span> +<span class="w"> </span><span class="nt">BYE</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">goodbye world</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">Execute command in background by using detach</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</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">detach_container</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"cat</span><span class="nv"> </span><span class="s">redhat-release"</span> +<span class="w"> </span><span class="nt">detach</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> +</pre></div> +</div> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> +<table class="longtable 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-exec_id"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-exec-id"><strong>exec_id</strong></p> +<a class="ansibleOptionLink" href="#return-exec_id" 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>The ID of the exec session.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success and <em>detach=true</em></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-rc"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-rc"><strong>rc</strong></p> +<a class="ansibleOptionLink" href="#return-rc" 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>The exit code of the command executed in the container.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">0</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-stderr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-stderr"><strong>stderr</strong></p> +<a class="ansibleOptionLink" href="#return-stderr" 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>The standard output of the command executed in the container.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-stdout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-stdout"><strong>stdout</strong></p> +<a class="ansibleOptionLink" href="#return-stdout" 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>The standard output of the command executed in the container.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> 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>Takuya Nishimura (@nishipy)</p></li> +</ul> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="index.html">Python</a></h1> + + + + + + + + +<h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_container_module.html" title="previous chapter">containers.podman.podman_container module β Manage podman containers</a></li> + <li>Next: <a href="podman_container_info_module.html" title="next chapter">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> + + | + <a href="_sources/podman_container_exec_module.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/podman_container_info_module.html b/ansible_collections/containers/podman/docs/podman_container_info_module.html index 806352e28..ff1441845 100644 --- a/ansible_collections/containers/podman/docs/podman_container_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_container_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_container_info β Gather facts about containers using podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_container_info module β Gather facts about containers using podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_containers module β Manage podman containers in a batch" href="podman_containers_module.html" /> + <link rel="prev" title="containers.podman.podman_container_exec module β Executes a command in a running container." href="podman_container_exec_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,19 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-container-info-module"></span><div class="section" id="containers-podman-podman-container-info-gather-facts-about-containers-using-podman"> -<h1>containers.podman.podman_container_info β Gather facts about containers using podman<a class="headerlink" href="#containers-podman-podman-container-info-gather-facts-about-containers-using-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-container-info-module"></span><section id="containers-podman-podman-container-info-module-gather-facts-about-containers-using-podman"> +<h1>containers.podman.podman_container_info module β Gather facts about containers using podman<a class="headerlink" href="#containers-podman-podman-container-info-module-gather-facts-about-containers-using-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-container-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_container_info</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -49,123 +54,110 @@ <li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Gather facts about containers using <code class="docutils literal notranslate"><span class="pre">podman</span></code></p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-container-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>List of container names to gather facts about. If no name is given return facts about all containers.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="notes"> -<h2><a class="toc-backref" href="#id4">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-container-info-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">list</span> / <span class="ansible-option-elements">elements=string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>List of container names to gather facts about. If no name is given return facts about all containers.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="notes"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> <div class="admonition note"> <p class="admonition-title">Note</p> <ul class="simple"> <li><p>Podman may require elevated privileges in order to run properly.</p></li> </ul> </div> -</div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id5">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">Gather facts for all containers</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container_info</span><span class="p">:</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">Gather facts on a specific container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container_info</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">web1</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">Gather facts on several containers</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container_info</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="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web1</span><span class="w"></span> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">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">Gather facts for all containers</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_info</span><span class="p">:</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">Gather facts on a specific container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_info</span><span class="p">:</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">web1</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">Gather facts on several containers</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container_info</span><span class="p">:</span> +<span class="w"> </span><span class="nt">name</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web1</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id6">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-containers"></div> - <b>containers</b> - <a class="ansibleOptionLink" href="#return-containers" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td>always</td> - <td> - <div>Facts from all or specificed containers</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'AppArmorProfile': '', 'Args': ['--single-child', '--', 'kolla_start'], 'BoundingCaps': ['CAP_CHOWN', 'CAP_DAC_OVERRIDE', 'CAP_FSETID', 'CAP_FOWNER', 'CAP_MKNOD', 'CAP_NET_RAW', 'CAP_SETGID', 'CAP_SETUID', 'CAP_SETFCAP', 'CAP_SETPCAP', 'CAP_NET_BIND_SERVICE', 'CAP_SYS_CHROOT', 'CAP_KILL', 'CAP_AUDIT_WRITE'], 'Config': {'Annotations': {'io.kubernetes.cri-o.ContainerType': 'sandbox', 'io.kubernetes.cri-o.TTY': 'false', 'io.podman.annotations.autoremove': 'FALSE', 'io.podman.annotations.init': 'FALSE', 'io.podman.annotations.privileged': 'FALSE', 'io.podman.annotations.publish-all': 'FALSE'}, 'AttachStderr': False, 'AttachStdin': False, 'AttachStdout': False, 'Cmd': ['kolla_start'], 'Domainname': '', 'Entrypoint': 'dumb-init --single-child --', 'Env': ['PATH=/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'TERM=xterm', 'HOSTNAME=', 'container=oci', 'KOLLA_INSTALL_METATYPE=rdo', 'KOLLA_BASE_DISTRO=centos', 'KOLLA_INSTALL_TYPE=binary', 'KOLLA_DISTRO_PYTHON_VERSION=2.7', 'KOLLA_BASE_ARCH=x86_64'], 'Hostname': 'c5c39e813703', 'Image': 'docker.io/tripleomaster/centos-haproxy:latest', 'Labels': {'build-date': '20190919', 'kolla_version': '8.1.0', 'name': 'haproxy', 'org.label-schema.build-date': '20190801', 'org.label-schema.license': 'GPLv2', 'org.label-schema.name': 'CentOS Base Image', 'org.label-schema.schema-version': '1.0', 'org.label-schema.vendor': 'CentOS'}, 'OnBuild': None, 'OpenStdin': False, 'StdinOnce': False, 'StopSignal': 15, 'Tty': False, 'User': '', 'Volumes': None, 'WorkingDir': '/'}, 'Created': '2019-10-01T12:51:00.233106443Z', 'Dependencies': [], 'Driver': 'overlay', 'EffectiveCaps': ['CAP_CHOWN', 'CAP_DAC_OVERRIDE', 'CAP_FSETID', 'CAP_FOWNER', 'CAP_MKNOD', 'CAP_NET_RAW', 'CAP_SETGID', 'CAP_SETUID', 'CAP_SETFCAP', 'CAP_SETPCAP', 'CAP_NET_BIND_SERVICE', 'CAP_SYS_CHROOT', 'CAP_KILL', 'CAP_AUDIT_WRITE'], 'ExecIDs': [], 'ExitCommand': ['/usr/bin/podman', '--root', '/var/lib/containers/storage', '--runroot', '/var/run/containers/storage', '--log-level', 'error', '--cgroup-manager', 'systemd', '--tmpdir', '/var/run/libpod', '--runtime', 'runc', '--storage-driver', 'overlay', '--events-backend', 'journald', 'container', 'cleanup', 'c9e813703f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f'], 'GraphDriver': {'Name': 'overlay'}, 'HostConfig': {'AutoRemove': False, 'Binds': [], 'BlkioDeviceReadBps': None, 'BlkioDeviceReadIOps': None, 'BlkioDeviceWriteBps': None, 'BlkioDeviceWriteIOps': None, 'BlkioWeight': 0, 'BlkioWeightDevice': None, 'CapAdd': [], 'CapDrop': [], 'Cgroup': '', 'CgroupParent': '', 'ConsoleSize': [0, 0], 'ContainerIDFile': '', 'CpuCount': 0, 'CpuPercent': 0, 'CpuPeriod': 0, 'CpuQuota': 0, 'CpuRealtimePeriod': 0, 'CpuRealtimeRuntime': 0, 'CpuShares': 0, 'CpusetCpus': '', 'CpusetMems': '', 'Devices': [], 'DiskQuota': 0, 'Dns': [], 'DnsOptions': [], 'DnsSearch': [], 'ExtraHosts': [], 'GroupAdd': [], 'IOMaximumBandwidth': 0, 'IOMaximumIOps': 0, 'IpcMode': '', 'Isolation': '', 'KernelMemory': 0, 'Links': None, 'LogConfig': {'Config': None, 'Type': 'k8s-file'}, 'Memory': 0, 'MemoryReservation': 0, 'MemorySwap': 0, 'MemorySwappiness': -1, 'NanoCpus': 0, 'NetworkMode': 'default', 'OomKillDisable': False, 'OomScoreAdj': 0, 'PidMode': '', 'PidsLimit': 0, 'PortBindings': {}, 'Privileged': False, 'PublishAllPorts': False, 'ReadonlyRootfs': False, 'RestartPolicy': {'MaximumRetryCount': 0, 'Name': ''}, 'Runtime': 'oci', 'SecurityOpt': [], 'ShmSize': 65536000, 'Tmpfs': {}, 'UTSMode': '', 'Ulimits': [{'Hard': 1048576, 'Name': 'RLIMIT_NOFILE', 'Soft': 1048576}, {'Hard': 1048576, 'Name': 'RLIMIT_NPROC', 'Soft': 1048576}], 'UsernsMode': '', 'VolumeDriver': '', 'VolumesFrom': None}, 'HostnamePath': '', 'HostsPath': '', 'Id': 'c5c39f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f', 'Image': '0e267acda67d0ebd643e900d820a91b961d859743039e620191ca1', 'ImageName': 'docker.io/tripleomaster/centos-haproxy:latest', 'IsInfra': False, 'MountLabel': 'system_u:object_r:svirt_sandbox_file_t:s0:c78,c866', 'Mounts': [], 'Name': 'haproxy', 'Namespace': '', 'NetworkSettings': {'Bridge': '', 'EndpointID': '', 'Gateway': '', 'GlobalIPv6Address': '', 'GlobalIPv6PrefixLen': 0, 'HairpinMode': False, 'IPAddress': '', 'IPPrefixLen': 0, 'IPv6Gateway': '', 'LinkLocalIPv6Address': '', 'LinkLocalIPv6PrefixLen': 0, 'MacAddress': '', 'Ports': [], 'SandboxID': '', 'SandboxKey': '', 'SecondaryIPAddresses': None, 'SecondaryIPv6Addresses': None}, 'OCIRuntime': 'runc', 'Path': 'dumb-init', 'Pod': '', 'ProcessLabel': 'system_u:system_r:svirt_lxc_net_t:s0:c785,c866', 'ResolvConfPath': '', 'RestartCount': 0, 'Rootfs': '', 'State': {'Dead': False, 'Error': '', 'ExitCode': 0, 'FinishedAt': '0001-01-01T00:00:00Z', 'Healthcheck': {'FailingStreak': 0, 'Log': None, 'Status': ''}, 'OOMKilled': False, 'OciVersion': '1.0.1-dev', 'Paused': False, 'Pid': 0, 'Restarting': False, 'Running': False, 'StartedAt': '0001-01-01T00:00:00Z', 'Status': 'configured'}}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-containers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-info-module-return-containers"><strong>containers</strong></p> +<a class="ansibleOptionLink" href="#return-containers" 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=dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Facts from all or specified containers</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"AppArmorProfile":</span> <span class="pre">"",</span> <span class="pre">"Args":</span> <span class="pre">["--single-child",</span> <span class="pre">"--",</span> <span class="pre">"kolla_start"],</span> <span class="pre">"BoundingCaps":</span> <span class="pre">["CAP_CHOWN",</span> <span class="pre">"CAP_DAC_OVERRIDE",</span> <span class="pre">"CAP_FSETID",</span> <span class="pre">"CAP_FOWNER",</span> <span class="pre">"CAP_MKNOD",</span> <span class="pre">"CAP_NET_RAW",</span> <span class="pre">"CAP_SETGID",</span> <span class="pre">"CAP_SETUID",</span> <span class="pre">"CAP_SETFCAP",</span> <span class="pre">"CAP_SETPCAP",</span> <span class="pre">"CAP_NET_BIND_SERVICE",</span> <span class="pre">"CAP_SYS_CHROOT",</span> <span class="pre">"CAP_KILL",</span> <span class="pre">"CAP_AUDIT_WRITE"],</span> <span class="pre">"Config":</span> <span class="pre">{"Annotations":</span> <span class="pre">{"io.kubernetes.cri-o.ContainerType":</span> <span class="pre">"sandbox",</span> <span class="pre">"io.kubernetes.cri-o.TTY":</span> <span class="pre">"false",</span> <span class="pre">"io.podman.annotations.autoremove":</span> <span class="pre">"FALSE",</span> <span class="pre">"io.podman.annotations.init":</span> <span class="pre">"FALSE",</span> <span class="pre">"io.podman.annotations.privileged":</span> <span class="pre">"FALSE",</span> <span class="pre">"io.podman.annotations.publish-all":</span> <span class="pre">"FALSE"},</span> <span class="pre">"AttachStderr":</span> <span class="pre">false,</span> <span class="pre">"AttachStdin":</span> <span class="pre">false,</span> <span class="pre">"AttachStdout":</span> <span class="pre">false,</span> <span class="pre">"Cmd":</span> <span class="pre">["kolla_start"],</span> <span class="pre">"Domainname":</span> <span class="pre">"",</span> <span class="pre">"Entrypoint":</span> <span class="pre">"dumb-init</span> <span class="pre">--single-child</span> <span class="pre">--",</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",</span> <span class="pre">"TERM=xterm",</span> <span class="pre">"HOSTNAME=",</span> <span class="pre">"container=oci",</span> <span class="pre">"KOLLA_INSTALL_METATYPE=rdo",</span> <span class="pre">"KOLLA_BASE_DISTRO=centos",</span> <span class="pre">"KOLLA_INSTALL_TYPE=binary",</span> <span class="pre">"KOLLA_DISTRO_PYTHON_VERSION=2.7",</span> <span class="pre">"KOLLA_BASE_ARCH=x86_64"],</span> <span class="pre">"Hostname":</span> <span class="pre">"c5c39e813703",</span> <span class="pre">"Image":</span> <span class="pre">"docker.io/tripleomaster/centos-haproxy:latest",</span> <span class="pre">"Labels":</span> <span class="pre">{"build-date":</span> <span class="pre">"20190919",</span> <span class="pre">"kolla_version":</span> <span class="pre">"8.1.0",</span> <span class="pre">"name":</span> <span class="pre">"haproxy",</span> <span class="pre">"org.label-schema.build-date":</span> <span class="pre">"20190801",</span> <span class="pre">"org.label-schema.license":</span> <span class="pre">"GPLv2",</span> <span class="pre">"org.label-schema.name":</span> <span class="pre">"CentOS</span> <span class="pre">Base</span> <span class="pre">Image",</span> <span class="pre">"org.label-schema.schema-version":</span> <span class="pre">"1.0",</span> <span class="pre">"org.label-schema.vendor":</span> <span class="pre">"CentOS"},</span> <span class="pre">"OnBuild":</span> <span class="pre">null,</span> <span class="pre">"OpenStdin":</span> <span class="pre">false,</span> <span class="pre">"StdinOnce":</span> <span class="pre">false,</span> <span class="pre">"StopSignal":</span> <span class="pre">15,</span> <span class="pre">"Tty":</span> <span class="pre">false,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Volumes":</span> <span class="pre">null,</span> <span class="pre">"WorkingDir":</span> <span class="pre">"/"},</span> <span class="pre">"Created":</span> <span class="pre">"2019-10-01T12:51:00.233106443Z",</span> <span class="pre">"Dependencies":</span> <span class="pre">[],</span> <span class="pre">"Driver":</span> <span class="pre">"overlay",</span> <span class="pre">"EffectiveCaps":</span> <span class="pre">["CAP_CHOWN",</span> <span class="pre">"CAP_DAC_OVERRIDE",</span> <span class="pre">"CAP_FSETID",</span> <span class="pre">"CAP_FOWNER",</span> <span class="pre">"CAP_MKNOD",</span> <span class="pre">"CAP_NET_RAW",</span> <span class="pre">"CAP_SETGID",</span> <span class="pre">"CAP_SETUID",</span> <span class="pre">"CAP_SETFCAP",</span> <span class="pre">"CAP_SETPCAP",</span> <span class="pre">"CAP_NET_BIND_SERVICE",</span> <span class="pre">"CAP_SYS_CHROOT",</span> <span class="pre">"CAP_KILL",</span> <span class="pre">"CAP_AUDIT_WRITE"],</span> <span class="pre">"ExecIDs":</span> <span class="pre">[],</span> <span class="pre">"ExitCommand":</span> <span class="pre">["/usr/bin/podman",</span> <span class="pre">"--root",</span> <span class="pre">"/var/lib/containers/storage",</span> <span class="pre">"--runroot",</span> <span class="pre">"/var/run/containers/storage",</span> <span class="pre">"--log-level",</span> <span class="pre">"error",</span> <span class="pre">"--cgroup-manager",</span> <span class="pre">"systemd",</span> <span class="pre">"--tmpdir",</span> <span class="pre">"/var/run/libpod",</span> <span class="pre">"--runtime",</span> <span class="pre">"runc",</span> <span class="pre">"--storage-driver",</span> <span class="pre">"overlay",</span> <span class="pre">"--events-backend",</span> <span class="pre">"journald",</span> <span class="pre">"container",</span> <span class="pre">"cleanup",</span> <span class="pre">"c9e813703f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f"],</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"HostConfig":</span> <span class="pre">{"AutoRemove":</span> <span class="pre">false,</span> <span class="pre">"Binds":</span> <span class="pre">[],</span> <span class="pre">"BlkioDeviceReadBps":</span> <span class="pre">null,</span> <span class="pre">"BlkioDeviceReadIOps":</span> <span class="pre">null,</span> <span class="pre">"BlkioDeviceWriteBps":</span> <span class="pre">null,</span> <span class="pre">"BlkioDeviceWriteIOps":</span> <span class="pre">null,</span> <span class="pre">"BlkioWeight":</span> <span class="pre">0,</span> <span class="pre">"BlkioWeightDevice":</span> <span class="pre">null,</span> <span class="pre">"CapAdd":</span> <span class="pre">[],</span> <span class="pre">"CapDrop":</span> <span class="pre">[],</span> <span class="pre">"Cgroup":</span> <span class="pre">"",</span> <span class="pre">"CgroupParent":</span> <span class="pre">"",</span> <span class="pre">"ConsoleSize":</span> <span class="pre">[0,</span> <span class="pre">0],</span> <span class="pre">"ContainerIDFile":</span> <span class="pre">"",</span> <span class="pre">"CpuCount":</span> <span class="pre">0,</span> <span class="pre">"CpuPercent":</span> <span class="pre">0,</span> <span class="pre">"CpuPeriod":</span> <span class="pre">0,</span> <span class="pre">"CpuQuota":</span> <span class="pre">0,</span> <span class="pre">"CpuRealtimePeriod":</span> <span class="pre">0,</span> <span class="pre">"CpuRealtimeRuntime":</span> <span class="pre">0,</span> <span class="pre">"CpuShares":</span> <span class="pre">0,</span> <span class="pre">"CpusetCpus":</span> <span class="pre">"",</span> <span class="pre">"CpusetMems":</span> <span class="pre">"",</span> <span class="pre">"Devices":</span> <span class="pre">[],</span> <span class="pre">"DiskQuota":</span> <span class="pre">0,</span> <span class="pre">"Dns":</span> <span class="pre">[],</span> <span class="pre">"DnsOptions":</span> <span class="pre">[],</span> <span class="pre">"DnsSearch":</span> <span class="pre">[],</span> <span class="pre">"ExtraHosts":</span> <span class="pre">[],</span> <span class="pre">"GroupAdd":</span> <span class="pre">[],</span> <span class="pre">"IOMaximumBandwidth":</span> <span class="pre">0,</span> <span class="pre">"IOMaximumIOps":</span> <span class="pre">0,</span> <span class="pre">"IpcMode":</span> <span class="pre">"",</span> <span class="pre">"Isolation":</span> <span class="pre">"",</span> <span class="pre">"KernelMemory":</span> <span class="pre">0,</span> <span class="pre">"Links":</span> <span class="pre">null,</span> <span class="pre">"LogConfig":</span> <span class="pre">{"Config":</span> <span class="pre">null,</span> <span class="pre">"Type":</span> <span class="pre">"k8s-file"},</span> <span class="pre">"Memory":</span> <span class="pre">0,</span> <span class="pre">"MemoryReservation":</span> <span class="pre">0,</span> <span class="pre">"MemorySwap":</span> <span class="pre">0,</span> <span class="pre">"MemorySwappiness":</span> <span class="pre">-1,</span> <span class="pre">"NanoCpus":</span> <span class="pre">0,</span> <span class="pre">"NetworkMode":</span> <span class="pre">"default",</span> <span class="pre">"OomKillDisable":</span> <span class="pre">false,</span> <span class="pre">"OomScoreAdj":</span> <span class="pre">0,</span> <span class="pre">"PidMode":</span> <span class="pre">"",</span> <span class="pre">"PidsLimit":</span> <span class="pre">0,</span> <span class="pre">"PortBindings":</span> <span class="pre">{},</span> <span class="pre">"Privileged":</span> <span class="pre">false,</span> <span class="pre">"PublishAllPorts":</span> <span class="pre">false,</span> <span class="pre">"ReadonlyRootfs":</span> <span class="pre">false,</span> <span class="pre">"RestartPolicy":</span> <span class="pre">{"MaximumRetryCount":</span> <span class="pre">0,</span> <span class="pre">"Name":</span> <span class="pre">""},</span> <span class="pre">"Runtime":</span> <span class="pre">"oci",</span> <span class="pre">"SecurityOpt":</span> <span class="pre">[],</span> <span class="pre">"ShmSize":</span> <span class="pre">65536000,</span> <span class="pre">"Tmpfs":</span> <span class="pre">{},</span> <span class="pre">"UTSMode":</span> <span class="pre">"",</span> <span class="pre">"Ulimits":</span> <span class="pre">[{"Hard":</span> <span class="pre">1048576,</span> <span class="pre">"Name":</span> <span class="pre">"RLIMIT_NOFILE",</span> <span class="pre">"Soft":</span> <span class="pre">1048576},</span> <span class="pre">{"Hard":</span> <span class="pre">1048576,</span> <span class="pre">"Name":</span> <span class="pre">"RLIMIT_NPROC",</span> <span class="pre">"Soft":</span> <span class="pre">1048576}],</span> <span class="pre">"UsernsMode":</span> <span class="pre">"",</span> <span class="pre">"VolumeDriver":</span> <span class="pre">"",</span> <span class="pre">"VolumesFrom":</span> <span class="pre">null},</span> <span class="pre">"HostnamePath":</span> <span class="pre">"",</span> <span class="pre">"HostsPath":</span> <span class="pre">"",</span> <span class="pre">"Id":</span> <span class="pre">"c5c39f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f",</span> <span class="pre">"Image":</span> <span class="pre">"0e267acda67d0ebd643e900d820a91b961d859743039e620191ca1",</span> <span class="pre">"ImageName":</span> <span class="pre">"docker.io/tripleomaster/centos-haproxy:latest",</span> <span class="pre">"IsInfra":</span> <span class="pre">false,</span> <span class="pre">"MountLabel":</span> <span class="pre">"system_u:object_r:svirt_sandbox_file_t:s0:c78,c866",</span> <span class="pre">"Mounts":</span> <span class="pre">[],</span> <span class="pre">"Name":</span> <span class="pre">"haproxy",</span> <span class="pre">"Namespace":</span> <span class="pre">"",</span> <span class="pre">"NetworkSettings":</span> <span class="pre">{"Bridge":</span> <span class="pre">"",</span> <span class="pre">"EndpointID":</span> <span class="pre">"",</span> <span class="pre">"Gateway":</span> <span class="pre">"",</span> <span class="pre">"GlobalIPv6Address":</span> <span class="pre">"",</span> <span class="pre">"GlobalIPv6PrefixLen":</span> <span class="pre">0,</span> <span class="pre">"HairpinMode":</span> <span class="pre">false,</span> <span class="pre">"IPAddress":</span> <span class="pre">"",</span> <span class="pre">"IPPrefixLen":</span> <span class="pre">0,</span> <span class="pre">"IPv6Gateway":</span> <span class="pre">"",</span> <span class="pre">"LinkLocalIPv6Address":</span> <span class="pre">"",</span> <span class="pre">"LinkLocalIPv6PrefixLen":</span> <span class="pre">0,</span> <span class="pre">"MacAddress":</span> <span class="pre">"",</span> <span class="pre">"Ports":</span> <span class="pre">[],</span> <span class="pre">"SandboxID":</span> <span class="pre">"",</span> <span class="pre">"SandboxKey":</span> <span class="pre">"",</span> <span class="pre">"SecondaryIPAddresses":</span> <span class="pre">null,</span> <span class="pre">"SecondaryIPv6Addresses":</span> <span class="pre">null},</span> <span class="pre">"OCIRuntime":</span> <span class="pre">"runc",</span> <span class="pre">"Path":</span> <span class="pre">"dumb-init",</span> <span class="pre">"Pod":</span> <span class="pre">"",</span> <span class="pre">"ProcessLabel":</span> <span class="pre">"system_u:system_r:svirt_lxc_net_t:s0:c785,c866",</span> <span class="pre">"ResolvConfPath":</span> <span class="pre">"",</span> <span class="pre">"RestartCount":</span> <span class="pre">0,</span> <span class="pre">"Rootfs":</span> <span class="pre">"",</span> <span class="pre">"State":</span> <span class="pre">{"Dead":</span> <span class="pre">false,</span> <span class="pre">"Error":</span> <span class="pre">"",</span> <span class="pre">"ExitCode":</span> <span class="pre">0,</span> <span class="pre">"FinishedAt":</span> <span class="pre">"0001-01-01T00:00:00Z",</span> <span class="pre">"Healthcheck":</span> <span class="pre">{"FailingStreak":</span> <span class="pre">0,</span> <span class="pre">"Log":</span> <span class="pre">null,</span> <span class="pre">"Status":</span> <span class="pre">""},</span> <span class="pre">"OOMKilled":</span> <span class="pre">false,</span> <span class="pre">"OciVersion":</span> <span class="pre">"1.0.1-dev",</span> <span class="pre">"Paused":</span> <span class="pre">false,</span> <span class="pre">"Pid":</span> <span class="pre">0,</span> <span class="pre">"Restarting":</span> <span class="pre">false,</span> <span class="pre">"Running":</span> <span class="pre">false,</span> <span class="pre">"StartedAt":</span> <span class="pre">"0001-01-01T00:00:00Z",</span> <span class="pre">"Status":</span> <span class="pre">"configured"}}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> <li><p>Emilien Macchi (@EmilienM)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -184,11 +176,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_container_exec_module.html" title="previous chapter">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> + <li>Next: <a href="podman_containers_module.html" title="next chapter">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> </ul></li> </ul> </div> @@ -218,8 +247,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_container_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_container_module.html b/ansible_collections/containers/podman/docs/podman_container_module.html index 71d65355f..656e05d7c 100644 --- a/ansible_collections/containers/podman/docs/podman_container_module.html +++ b/ansible_collections/containers/podman/docs/podman_container_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_container β Manage podman containers — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_container module β Manage podman containers — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_container_exec module β Executes a command in a running container." href="podman_container_exec_module.html" /> + <link rel="prev" title="Containers.Podman" href="index.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-container-module"></span><div class="section" id="containers-podman-podman-container-manage-podman-containers"> -<h1>containers.podman.podman_container β Manage podman containers<a class="headerlink" href="#containers-podman-podman-container-manage-podman-containers" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-container-module"></span><section id="containers-podman-podman-container-module-manage-podman-containers"> +<h1>containers.podman.podman_container module β Manage podman containers<a class="headerlink" href="#containers-podman-podman-container-module-manage-podman-containers" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-container-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_container</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,2207 +54,1365 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Start, stop, restart and manage Podman containers</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-container-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="2">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-annotation"></div> - <b>annotation</b> - <a class="ansibleOptionLink" href="#parameter-annotation" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Add an annotation to the container. The format is key value, multiple times.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-authfile"></div> - <b>authfile</b> - <a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-blkio_weight"></div> - <b>blkio_weight</b> - <a class="ansibleOptionLink" href="#parameter-blkio_weight" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Block IO weight (relative weight) accepts a weight value between 10 and 1000</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-blkio_weight_device"></div> - <b>blkio_weight_device</b> - <a class="ansibleOptionLink" href="#parameter-blkio_weight_device" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Block IO weight (relative device weight, format DEVICE_NAME[:]WEIGHT).</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cap_add"></div> - <b>cap_add</b> - <a class="ansibleOptionLink" href="#parameter-cap_add" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>List of capabilities to add to the container.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: capabilities</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cap_drop"></div> - <b>cap_drop</b> - <a class="ansibleOptionLink" href="#parameter-cap_drop" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>List of capabilities to drop from the container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cgroup_parent"></div> - <b>cgroup_parent</b> - <a class="ansibleOptionLink" href="#parameter-cgroup_parent" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cgroupns"></div> - <b>cgroupns</b> - <a class="ansibleOptionLink" href="#parameter-cgroupns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to cgroups under which the cgroup for the container will be created.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cgroups"></div> - <b>cgroups</b> - <a class="ansibleOptionLink" href="#parameter-cgroups" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Determines whether the container will create CGroups. Valid values are enabled and disabled, which the default being enabled. The disabled option will force the container to not create CGroups, and thus conflicts with CGroup options cgroupns and cgroup-parent.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cidfile"></div> - <b>cidfile</b> - <a class="ansibleOptionLink" href="#parameter-cidfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Write the container ID to the file</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cmd_args"></div> - <b>cmd_args</b> - <a class="ansibleOptionLink" href="#parameter-cmd_args" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Any additional command options you want to pass to podman command, cmd_args - ['--other-param', 'value'] Be aware module doesn't support idempotency if this is set.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-command"></div> - <b>command</b> - <a class="ansibleOptionLink" href="#parameter-command" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">raw</span> - </div> - </td> - <td> - </td> - <td> - <div>Override command of container. Can be a string or a list.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-conmon_pidfile"></div> - <b>conmon_pidfile</b> - <a class="ansibleOptionLink" href="#parameter-conmon_pidfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Write the pid of the conmon process to a file. conmon runs in a separate process than Podman, so this is necessary when using systemd to restart Podman containers.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpu_period"></div> - <b>cpu_period</b> - <a class="ansibleOptionLink" href="#parameter-cpu_period" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Limit the CPU real-time period in microseconds</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpu_rt_period"></div> - <b>cpu_rt_period</b> - <a class="ansibleOptionLink" href="#parameter-cpu_rt_period" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Limit the CPU real-time period in microseconds. Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpu_rt_runtime"></div> - <b>cpu_rt_runtime</b> - <a class="ansibleOptionLink" href="#parameter-cpu_rt_runtime" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Limit the CPU real-time runtime in microseconds. This flag tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpu_shares"></div> - <b>cpu_shares</b> - <a class="ansibleOptionLink" href="#parameter-cpu_shares" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>CPU shares (relative weight)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpus"></div> - <b>cpus</b> - <a class="ansibleOptionLink" href="#parameter-cpus" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Number of CPUs. The default is 0.0 which means no limit.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpuset_cpus"></div> - <b>cpuset_cpus</b> - <a class="ansibleOptionLink" href="#parameter-cpuset_cpus" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>CPUs in which to allow execution (0-3, 0,1)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpuset_mems"></div> - <b>cpuset_mems</b> - <a class="ansibleOptionLink" href="#parameter-cpuset_mems" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Return additional information which can be helpful for investigations.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-detach"></div> - <b>detach</b> - <a class="ansibleOptionLink" href="#parameter-detach" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Run container in detach mode</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-detach_keys"></div> - <b>detach_keys</b> - <a class="ansibleOptionLink" href="#parameter-detach_keys" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Override the key sequence for detaching a container. Format is a single character or ctrl-value</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device"></div> - <b>device</b> - <a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add a host device to the container. The format is <device-on-host>[:<device-on-container>][:<permissions>] (e.g. device /dev/sdc:/dev/xvdc:rwm)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device_read_bps"></div> - <b>device_read_bps</b> - <a class="ansibleOptionLink" href="#parameter-device_read_bps" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Limit read rate (bytes per second) from a device (e.g. device-read-bps /dev/sda:1mb)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device_read_iops"></div> - <b>device_read_iops</b> - <a class="ansibleOptionLink" href="#parameter-device_read_iops" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Limit read rate (IO per second) from a device (e.g. device-read-iops /dev/sda:1000)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device_write_bps"></div> - <b>device_write_bps</b> - <a class="ansibleOptionLink" href="#parameter-device_write_bps" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Limit write rate (bytes per second) to a device (e.g. device-write-bps /dev/sda:1mb)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device_write_iops"></div> - <b>device_write_iops</b> - <a class="ansibleOptionLink" href="#parameter-device_write_iops" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Limit write rate (IO per second) to a device (e.g. device-write-iops /dev/sda:1000)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns"></div> - <b>dns</b> - <a class="ansibleOptionLink" href="#parameter-dns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS servers</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: dns_servers</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns_option"></div> - <b>dns_option</b> - <a class="ansibleOptionLink" href="#parameter-dns_option" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS options</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: dns_opts</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns_search"></div> - <b>dns_search</b> - <a class="ansibleOptionLink" href="#parameter-dns_search" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS search domains (Use dns_search with '' if you don't wish to set the search domain)</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: dns_search_domains</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-entrypoint"></div> - <b>entrypoint</b> - <a class="ansibleOptionLink" href="#parameter-entrypoint" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Overwrite the default ENTRYPOINT of the image</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-env"></div> - <b>env</b> - <a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Set environment variables. This option allows you to specify arbitrary environment variables that are available for the process that will be launched inside of the container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-env_file"></div> - <b>env_file</b> - <a class="ansibleOptionLink" href="#parameter-env_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Read in a line delimited file of environment variables. Doesn't support idempotency. If users changes the file with environment variables it's on them to recreate the container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-env_host"></div> - <b>env_host</b> - <a class="ansibleOptionLink" href="#parameter-env_host" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Use all current host environment variables in container. Defaults to false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-etc_hosts"></div> - <b>etc_hosts</b> - <a class="ansibleOptionLink" href="#parameter-etc_hosts" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container's ``/etc/hosts`` file.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: add_hosts</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-expose"></div> - <b>expose</b> - <a class="ansibleOptionLink" href="#parameter-expose" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Expose a port, or a range of ports (e.g. expose "3300-3310") to set up port redirection on the host system.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: exposed, exposed_ports</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-force_restart"></div> - <b>force_restart</b> - <a class="ansibleOptionLink" href="#parameter-force_restart" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Force restart of container.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: restart</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd"></div> - <b>generate_systemd</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">{}</div> - </td> - <td> - <div>Generate systemd unit file for container.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/after"></div> - <b>after</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/after" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/container_prefix"></div> - <b>container_prefix</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/container_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for containers. The default is "container".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/names"></div> - <b>names</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/names" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Use names of the containers for the start, stop, and description in the unit file. Default is true.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/new"></div> - <b>new</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/new" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Create containers and pods when the unit is started instead of expecting them to exist. The default is "false". Refer to podman-generate-systemd(1) for more information.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/no_header"></div> - <b>no_header</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/no_header" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/path"></div> - <b>path</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/path" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a path to the directory where unit files will be generated. Required for this option. If it doesn't exist, the directory will be created.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/pod_prefix"></div> - <b>pod_prefix</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/pod_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for pods. The default is "pod".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/requires"></div> - <b>requires</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/requires" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_policy"></div> - <b>restart_policy</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_policy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>on-success</li> - <li>on-failure</li> - <li>on-abnormal</li> - <li>on-watchdog</li> - <li>on-abort</li> - <li>always</li> - </ul> - </td> - <td> - <div>Specify a restart policy for the service. The restart-policy must be one of "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is "on-failure".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/separator"></div> - <b>separator</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/separator" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is "-" (dash).</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/time"></div> - <b>time</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/time" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Override the default stop timeout for the container with the given value.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/wants"></div> - <b>wants</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/wants" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-gidmap"></div> - <b>gidmap</b> - <a class="ansibleOptionLink" href="#parameter-gidmap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Run the container in a new user namespace using the supplied mapping.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-group_add"></div> - <b>group_add</b> - <a class="ansibleOptionLink" href="#parameter-group_add" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add additional groups to run as</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: groups</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-healthcheck"></div> - <b>healthcheck</b> - <a class="ansibleOptionLink" href="#parameter-healthcheck" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set or alter a healthcheck command for a container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-healthcheck_interval"></div> - <b>healthcheck_interval</b> - <a class="ansibleOptionLink" href="#parameter-healthcheck_interval" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set an interval for the healthchecks (a value of disable results in no automatic timer setup) (default "30s")</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-healthcheck_retries"></div> - <b>healthcheck_retries</b> - <a class="ansibleOptionLink" href="#parameter-healthcheck_retries" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is 3.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-healthcheck_start_period"></div> - <b>healthcheck_start_period</b> - <a class="ansibleOptionLink" href="#parameter-healthcheck_start_period" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The initialization time needed for a container to bootstrap. The value can be expressed in time format like 2m3s. The default value is 0s</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-healthcheck_timeout"></div> - <b>healthcheck_timeout</b> - <a class="ansibleOptionLink" href="#parameter-healthcheck_timeout" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as 1m22s. The default value is 30s</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-hostname"></div> - <b>hostname</b> - <a class="ansibleOptionLink" href="#parameter-hostname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Container host name. Sets the container host name that is available inside the container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-http_proxy"></div> - <b>http_proxy</b> - <a class="ansibleOptionLink" href="#parameter-http_proxy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>By default proxy environment variables are passed into the container if set for the podman process. This can be disabled by setting the http_proxy option to false. The environment variables passed in include http_proxy, https_proxy, ftp_proxy, no_proxy, and also the upper case versions of those. Defaults to true</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Repository path (or image name) and tag used to create the container. If an image is not found, the image will be pulled from the registry. If no tag is included, <code>latest</code> will be used.</div> - <div>Can also be an image ID. If this is the case, the image is assumed to be available locally.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-image_strict"></div> - <b>image_strict</b> - <a class="ansibleOptionLink" href="#parameter-image_strict" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Whether to compare images in idempotency by taking into account a full name with registry and namespaces.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-image_volume"></div> - <b>image_volume</b> - <a class="ansibleOptionLink" href="#parameter-image_volume" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>bind</li> - <li>tmpfs</li> - <li>ignore</li> - </ul> - </td> - <td> - <div>Tells podman how to handle the builtin image volumes. The options are bind, tmpfs, or ignore (default bind)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-init"></div> - <b>init</b> - <a class="ansibleOptionLink" href="#parameter-init" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Run an init inside the container that forwards signals and reaps processes. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-init_path"></div> - <b>init_path</b> - <a class="ansibleOptionLink" href="#parameter-init_path" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to the container-init binary.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-interactive"></div> - <b>interactive</b> - <a class="ansibleOptionLink" href="#parameter-interactive" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Keep STDIN open even if not attached. The default is false. When set to true, keep stdin open even if not attached. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ip"></div> - <b>ip</b> - <a class="ansibleOptionLink" href="#parameter-ip" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a static IP address for the container, for example '10.88.64.128'. Can only be used if no additional CNI networks to join were specified via 'network:', and if the container is not joining another container's network namespace via 'network container:<name|id>'. The address must be within the default CNI network's pool (default 10.88.0.0/16).</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ipc"></div> - <b>ipc</b> - <a class="ansibleOptionLink" href="#parameter-ipc" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Default is to create a private IPC namespace (POSIX SysV IPC) for the container</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: ipc_mode</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-kernel_memory"></div> - <b>kernel_memory</b> - <a class="ansibleOptionLink" href="#parameter-kernel_memory" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Kernel memory limit (format <number>[<unit>], where unit = b, k, m or g) Note - idempotency is supported for integers only.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-label"></div> - <b>label</b> - <a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Add metadata to a container, pass dictionary of label names and values</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: labels</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-label_file"></div> - <b>label_file</b> - <a class="ansibleOptionLink" href="#parameter-label_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Read in a line delimited file of labels</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-log_driver"></div> - <b>log_driver</b> - <a class="ansibleOptionLink" href="#parameter-log_driver" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>k8s-file</li> - <li>journald</li> - <li>json-file</li> - </ul> - </td> - <td> - <div>Logging driver. Used to set the log driver for the container. For example log_driver "k8s-file".</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-log_level"></div> - <b>log_level</b> - <a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>debug</li> - <li>info</li> - <li>warn</li> - <li>error</li> - <li>fatal</li> - <li>panic</li> - </ul> - </td> - <td> - <div>Logging level for Podman. Log messages above specified level ("debug"|"info"|"warn"|"error"|"fatal"|"panic") (default "error")</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-log_opt"></div> - <b>log_opt</b> - <a class="ansibleOptionLink" href="#parameter-log_opt" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Logging driver specific options. Used to set the path to the container log file.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: log_options</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-log_opt/max_size"></div> - <b>max_size</b> - <a class="ansibleOptionLink" href="#parameter-log_opt/max_size" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a max size of the log file (e.g 10mb).</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-log_opt/path"></div> - <b>path</b> - <a class="ansibleOptionLink" href="#parameter-log_opt/path" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a path to the log file (e.g. /var/log/container/mycontainer.json).</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-log_opt/tag"></div> - <b>tag</b> - <a class="ansibleOptionLink" href="#parameter-log_opt/tag" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a custom log tag for the container.</div> - </td> - </tr> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-annotation"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-annotation"><strong>annotation</strong></p> +<a class="ansibleOptionLink" href="#parameter-annotation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add an annotation to the container. The format is key value, multiple times.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-attach"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-attach"><strong>attach</strong></p> +<a class="ansibleOptionLink" href="#parameter-attach" 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>Attach to STDIN, STDOUT or STDERR. The default in Podman is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stdin"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stdout"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stderr"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-authfile"><strong>authfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-blkio_weight"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-blkio-weight"><strong>blkio_weight</strong></p> +<a class="ansibleOptionLink" href="#parameter-blkio_weight" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Block IO weight (relative weight) accepts a weight value between 10 and 1000</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-blkio_weight_device"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-blkio-weight-device"><strong>blkio_weight_device</strong></p> +<a class="ansibleOptionLink" href="#parameter-blkio_weight_device" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Block IO weight (relative device weight, format DEVICE_NAME[:]WEIGHT).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cap_add"></div> +<div class="ansibleOptionAnchor" id="parameter-capabilities"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-capabilities"><span id="ansible-collections-containers-podman-podman-container-module-parameter-cap-add"></span><strong>cap_add</strong></p> +<a class="ansibleOptionLink" href="#parameter-cap_add" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: capabilities</span></p> +<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 capabilities to add to the container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cap_drop"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cap-drop"><strong>cap_drop</strong></p> +<a class="ansibleOptionLink" href="#parameter-cap_drop" 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 capabilities to drop from the container.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cgroup_parent"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cgroup-parent"><strong>cgroup_parent</strong></p> +<a class="ansibleOptionLink" href="#parameter-cgroup_parent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cgroupns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cgroupns"><strong>cgroupns</strong></p> +<a class="ansibleOptionLink" href="#parameter-cgroupns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to cgroups under which the cgroup for the container will be created.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cgroups"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cgroups"><strong>cgroups</strong></p> +<a class="ansibleOptionLink" href="#parameter-cgroups" 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>Determines whether the container will create CGroups. Valid values are enabled and disabled, which the default being enabled. The disabled option will force the container to not create CGroups, and thus conflicts with CGroup options cgroupns and cgroup-parent.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cidfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cidfile"><strong>cidfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-cidfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Write the container ID to the file</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cmd_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cmd-args"><strong>cmd_args</strong></p> +<a class="ansibleOptionLink" href="#parameter-cmd_args" 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>Any additional command options you want to pass to podman command itself, for example <code class="docutils literal notranslate"><span class="pre">--log-level=debug</span></code> or <code class="docutils literal notranslate"><span class="pre">--syslog</span></code>. This is NOT command to run in container, but rather options for podman itself. For container command please use <em>command</em> option.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-command"><strong>command</strong></p> +<a class="ansibleOptionLink" href="#parameter-command" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Override command of container. Can be a string or a list.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-conmon_pidfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-conmon-pidfile"><strong>conmon_pidfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-conmon_pidfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Write the pid of the conmon process to a file. conmon runs in a separate process than Podman, so this is necessary when using systemd to restart Podman containers.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_period"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpu-period"><strong>cpu_period</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_period" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Limit the CPU CFS (Completely Fair Scheduler) period</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_quota"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpu-quota"><strong>cpu_quota</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_quota" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Limit the CPU CFS (Completely Fair Scheduler) quota</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_rt_period"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpu-rt-period"><strong>cpu_rt_period</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_rt_period" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Limit the CPU real-time period in microseconds. Limit the containerβs Real Time CPU usage. This flag tell the kernel to restrict the containerβs Real Time CPU usage to the period you specify.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_rt_runtime"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpu-rt-runtime"><strong>cpu_rt_runtime</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_rt_runtime" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Limit the CPU real-time runtime in microseconds. This flag tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_shares"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpu-shares"><strong>cpu_shares</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_shares" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>CPU shares (relative weight)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpus"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpus"><strong>cpus</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpus" 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>Number of CPUs. The default is 0.0 which means no limit.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpuset_cpus"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpuset-cpus"><strong>cpuset_cpus</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpuset_cpus" 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>CPUs in which to allow execution (0-3, 0,1)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpuset_mems"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-cpuset-mems"><strong>cpuset_mems</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpuset_mems" 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>Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Return additional information which can be helpful for investigations.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-delete_depend"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-delete-depend"><strong>delete_depend</strong></p> +<a class="ansibleOptionLink" href="#parameter-delete_depend" 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>Remove selected container and recursively remove all containers that depend on it. Applies to βdeleteβ command.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-delete_time"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-delete-time"><strong>delete_time</strong></p> +<a class="ansibleOptionLink" href="#parameter-delete_time" 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>Seconds to wait before forcibly stopping the container. Use -1 for infinite wait. Applies to βdeleteβ command.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-delete_volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-delete-volumes"><strong>delete_volumes</strong></p> +<a class="ansibleOptionLink" href="#parameter-delete_volumes" 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>Remove anonymous volumes associated with the container. This does not include named volumes created with podman volume create, or the βvolume option of podman run and podman create.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-detach"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-detach"><strong>detach</strong></p> +<a class="ansibleOptionLink" href="#parameter-detach" 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>Run container in detach mode</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-detach_keys"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-detach-keys"><strong>detach_keys</strong></p> +<a class="ansibleOptionLink" href="#parameter-detach_keys" 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>Override the key sequence for detaching a container. Format is a single character or ctrl-value</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-device"><strong>device</strong></p> +<a class="ansibleOptionLink" href="#parameter-device" 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>Add a host device to the container. The format is <device-on-host>[:<device-on-container>][:<permissions>] (e.g. device /dev/sdc:/dev/xvdc:rwm)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_read_bps"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-device-read-bps"><strong>device_read_bps</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_read_bps" 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>Limit read rate (bytes per second) from a device (e.g. device-read-bps /dev/sda:1mb)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_read_iops"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-device-read-iops"><strong>device_read_iops</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_read_iops" 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>Limit read rate (IO per second) from a device (e.g. device-read-iops /dev/sda:1000)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_write_bps"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-device-write-bps"><strong>device_write_bps</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_write_bps" 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>Limit write rate (bytes per second) to a device (e.g. device-write-bps /dev/sda:1mb)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_write_iops"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-device-write-iops"><strong>device_write_iops</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_write_iops" 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>Limit write rate (IO per second) to a device (e.g. device-write-iops /dev/sda:1000)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns"></div> +<div class="ansibleOptionAnchor" id="parameter-dns_servers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-dns-servers"><span id="ansible-collections-containers-podman-podman-container-module-parameter-dns"></span><strong>dns</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: dns_servers</span></p> +<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>Set custom DNS servers</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns_option"></div> +<div class="ansibleOptionAnchor" id="parameter-dns_opts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-dns-opts"><span id="ansible-collections-containers-podman-podman-container-module-parameter-dns-option"></span><strong>dns_option</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns_option" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: dns_opts</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set custom DNS options</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns_search"></div> +<div class="ansibleOptionAnchor" id="parameter-dns_search_domains"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-dns-search-domains"><span id="ansible-collections-containers-podman-podman-container-module-parameter-dns-search"></span><strong>dns_search</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns_search" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: dns_search_domains</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set custom DNS search domains (Use dns_search with ββ if you donβt wish to set the search domain)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-entrypoint"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-entrypoint"><strong>entrypoint</strong></p> +<a class="ansibleOptionLink" href="#parameter-entrypoint" 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>Overwrite the default ENTRYPOINT of the image</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-env"><strong>env</strong></p> +<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set environment variables. This option allows you to specify arbitrary environment variables that are available for the process that will be launched inside of the container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-env_file"></div> +<div class="ansibleOptionAnchor" id="parameter-env_files"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-env-files"><span id="ansible-collections-containers-podman-podman-container-module-parameter-env-file"></span><strong>env_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-env_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: env_files</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Read in a line delimited file of environment variables. Doesnβt support idempotency. If users changes the file with environment variables itβs on them to recreate the container. The file must be present on the REMOTE machine where actual podman is running, not on the controller machine where Ansible is executing. If you need to copy the file from controller to remote machine, use the copy or slurp module.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-env_host"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-env-host"><strong>env_host</strong></p> +<a class="ansibleOptionLink" href="#parameter-env_host" 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>Use all current host environment variables in container. Defaults to false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-etc_hosts"></div> +<div class="ansibleOptionAnchor" id="parameter-add_hosts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-etc-hosts"><span id="ansible-collections-containers-podman-podman-container-module-parameter-add-hosts"></span><strong>etc_hosts</strong></p> +<a class="ansibleOptionLink" href="#parameter-etc_hosts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: add_hosts</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the containerβs ``/etc/hosts`` file.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-expose"></div> +<div class="ansibleOptionAnchor" id="parameter-exposed"></div> +<div class="ansibleOptionAnchor" id="parameter-exposed_ports"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-exposed-ports"><span id="ansible-collections-containers-podman-podman-container-module-parameter-exposed"></span><span id="ansible-collections-containers-podman-podman-container-module-parameter-expose"></span><strong>expose</strong></p> +<a class="ansibleOptionLink" href="#parameter-expose" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: exposed, exposed_ports</span></p> +<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>Expose a port, or a range of ports (e.g. expose β3300-3310β) to set up port redirection on the host system.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force_delete"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-force-delete"><strong>force_delete</strong></p> +<a class="ansibleOptionLink" href="#parameter-force_delete" 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>Force deletion of container when itβs being deleted.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force_restart"></div> +<div class="ansibleOptionAnchor" id="parameter-restart"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-restart"><span id="ansible-collections-containers-podman-podman-container-module-parameter-force-restart"></span><strong>force_restart</strong></p> +<a class="ansibleOptionLink" href="#parameter-force_restart" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: restart</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Force restart of container.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd"><strong>generate_systemd</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Generate systemd unit file for container.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/after"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-after"><strong>after</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/after" 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-indent-desc"></div><div class="ansible-option-cell"><p>Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/container_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-container-prefix"><strong>container_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/container_prefix" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name prefix for containers. The default is βcontainerβ.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-names"><strong>names</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/names" 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-indent-desc"></div><div class="ansible-option-cell"><p>Use names of the containers for the start, stop, and description in the unit file. Default is true.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/new"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-new"><strong>new</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/new" 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-indent-desc"></div><div class="ansible-option-cell"><p>Create containers and pods when the unit is started instead of expecting them to exist. The default is βfalseβ. Refer to podman-generate-systemd(1) for more information.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/no_header"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-no-header"><strong>no_header</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/no_header" 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-indent-desc"></div><div class="ansible-option-cell"><p>Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-path"><strong>path</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a path to the directory where unit files will be generated. Required for this option. If it doesnβt exist, the directory will be created.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/pod_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-pod-prefix"><strong>pod_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/pod_prefix" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name prefix for pods. The default is βpodβ.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/requires"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-requires"><strong>requires</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/requires" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_policy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-restart-policy"><strong>restart_policy</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_policy" 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-indent-desc"></div><div class="ansible-option-cell"><p>Specify a restart policy for the service. The restart-policy must be one of βnoβ, βon-successβ, βon-failureβ, βon-abnormalβ, βon-watchdogβ, βon-abortβ, or βalwaysβ. The default policy is βon-failureβ.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"no"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-success"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-failure"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abnormal"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-watchdog"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abort"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"always"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_sec"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-restart-sec"><strong>restart_sec</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_sec" title="Permalink to this option"></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>Set the systemd service restartsec value.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/separator"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-separator"><strong>separator</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/separator" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is β-β (dash).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/start_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-start-timeout"><strong>start_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/start_timeout" title="Permalink to this option"></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>Override the default start timeout for the container with the given value.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/stop_timeout"></div> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/time"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-time"><span id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-stop-timeout"></span><strong>stop_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: time</span></p> +<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>Override the default stop timeout for the container with the given value. Called `time` before version 4.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/wants"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-generate-systemd-wants"><strong>wants</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/wants" 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-indent-desc"></div><div class="ansible-option-cell"><p>Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-gidmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-gidmap"><strong>gidmap</strong></p> +<a class="ansibleOptionLink" href="#parameter-gidmap" 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>Run the container in a new user namespace using the supplied mapping.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-group_add"></div> +<div class="ansibleOptionAnchor" id="parameter-groups"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-groups"><span id="ansible-collections-containers-podman-podman-container-module-parameter-group-add"></span><strong>group_add</strong></p> +<a class="ansibleOptionLink" href="#parameter-group_add" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: groups</span></p> +<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>Add additional groups to run as</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck"><strong>healthcheck</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck" 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 or alter a healthcheck command for a container.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck_failure_action"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck-failure-action"><strong>healthcheck_failure_action</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck_failure_action" 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 action to be taken when the container is considered unhealthy. The action must be one of βnoneβ, βkillβ, βrestartβ, or βstopβ. The default policy is βnoneβ.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"none"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"kill"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"restart"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stop"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck_interval"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck-interval"><strong>healthcheck_interval</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck_interval" 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 an interval for the healthchecks (a value of disable results in no automatic timer setup) (default β30sβ)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck_retries"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck-retries"><strong>healthcheck_retries</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck_retries" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is 3.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck_start_period"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck-start-period"><strong>healthcheck_start_period</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck_start_period" 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 initialization time needed for a container to bootstrap. The value can be expressed in time format like 2m3s. The default value is 0s</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-healthcheck_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-healthcheck-timeout"><strong>healthcheck_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-healthcheck_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as 1m22s. The default value is 30s</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-hooks_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-hooks-dir"><strong>hooks_dir</strong></p> +<a class="ansibleOptionLink" href="#parameter-hooks_dir" 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>Each .json file in the path configures a hook for Podman containers. For more details on the syntax of the JSON files and the semantics of hook injection, see oci-hooks(5). Can be set multiple times.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-hostname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-hostname"><strong>hostname</strong></p> +<a class="ansibleOptionLink" href="#parameter-hostname" 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>Container host name. Sets the container host name that is available inside the container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-http_proxy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-http-proxy"><strong>http_proxy</strong></p> +<a class="ansibleOptionLink" href="#parameter-http_proxy" 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>By default proxy environment variables are passed into the container if set for the podman process. This can be disabled by setting the http_proxy option to false. The environment variables passed in include http_proxy, https_proxy, ftp_proxy, no_proxy, and also the upper case versions of those. Defaults to true</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#parameter-image" 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>Repository path (or image name) and tag used to create the container. If an image is not found, the image will be pulled from the registry. If no tag is included, <code class="docutils literal notranslate"><span class="pre">latest</span></code> will be used.</p> +<p>Can also be an image ID. If this is the case, the image is assumed to be available locally.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image_strict"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-image-strict"><strong>image_strict</strong></p> +<a class="ansibleOptionLink" href="#parameter-image_strict" 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>Whether to compare images in idempotency by taking into account a full name with registry and namespaces.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image_volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-image-volume"><strong>image_volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-image_volume" 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>Tells podman how to handle the builtin image volumes. The options are bind, tmpfs, or ignore (default bind)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"bind"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"tmpfs"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ignore"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-init"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-init"><strong>init</strong></p> +<a class="ansibleOptionLink" href="#parameter-init" 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>Run an init inside the container that forwards signals and reaps processes. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-init_path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-init-path"><strong>init_path</strong></p> +<a class="ansibleOptionLink" href="#parameter-init_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to the container-init binary.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-interactive"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-interactive"><strong>interactive</strong></p> +<a class="ansibleOptionLink" href="#parameter-interactive" 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>Keep STDIN open even if not attached. The default is false. When set to true, keep stdin open even if not attached. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ip"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-ip"><strong>ip</strong></p> +<a class="ansibleOptionLink" href="#parameter-ip" 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>Specify a static IP address for the container, for example β10.88.64.128β. Can only be used if no additional CNI networks to join were specified via βnetwork:β, and if the container is not joining another containerβs network namespace via βnetwork container:<name|id>β. The address must be within the default CNI networkβs pool (default 10.88.0.0/16).</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ipc"></div> +<div class="ansibleOptionAnchor" id="parameter-ipc_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-ipc-mode"><span id="ansible-collections-containers-podman-podman-container-module-parameter-ipc"></span><strong>ipc</strong></p> +<a class="ansibleOptionLink" href="#parameter-ipc" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ipc_mode</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Default is to create a private IPC namespace (POSIX SysV IPC) for the container</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-kernel_memory"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-kernel-memory"><strong>kernel_memory</strong></p> +<a class="ansibleOptionLink" href="#parameter-kernel_memory" 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>Kernel memory limit (format <number>[<unit>], where unit = b, k, m or g) Note - idempotency is supported for integers only.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label"></div> +<div class="ansibleOptionAnchor" id="parameter-labels"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-labels"><span id="ansible-collections-containers-podman-podman-container-module-parameter-label"></span><strong>label</strong></p> +<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: labels</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add metadata to a container, pass dictionary of label names and values</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-label-file"><strong>label_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-label_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Read in a line delimited file of labels</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-driver"><strong>log_driver</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_driver" 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>Logging driver. Used to set the log driver for the container. For example log_driver βk8s-fileβ.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"k8s-file"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"journald"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"json-file"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_level"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-level"><strong>log_level</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Logging level for Podman. Log messages above specified level (βdebugβ|βinfoβ|βwarnβ|βerrorβ|βfatalβ|βpanicβ) (default βerrorβ)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"debug"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"info"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"warn"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"error"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"fatal"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"panic"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-options"><span id="ansible-collections-containers-podman-podman-container-module-parameter-log-opt"></span><strong>log_opt</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: log_options</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Logging driver specific options. Used to set the path to the container log file.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/max_size"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/max_size"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-options-max-size"><span id="ansible-collections-containers-podman-podman-container-module-parameter-log-opt-max-size"></span><strong>max_size</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/max_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a max size of the log file (e.g 10mb).</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/path"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-options-path"><span id="ansible-collections-containers-podman-podman-container-module-parameter-log-opt-path"></span><strong>path</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a path to the log file (e.g. /var/log/container/mycontainer.json).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/tag"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/tag"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-log-options-tag"><span id="ansible-collections-containers-podman-podman-container-module-parameter-log-opt-tag"></span><strong>tag</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/tag" 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-indent-desc"></div><div class="ansible-option-cell"><p>Specify a custom log tag for the container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-mac_address"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-mac-address"><strong>mac_address</strong></p> +<a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Specify a MAC address for the container, for example β92:d0:c6:0a:29:33β. Donβt forget that it must be unique within one Ethernet network.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-memory"><strong>memory</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory" 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>Memory limit (format 10k, where unit = b, k, m or g) Note - idempotency is supported for integers only.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory_reservation"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-memory-reservation"><strong>memory_reservation</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory_reservation" 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>Memory soft limit (format 100m, where unit = b, k, m or g) Note - idempotency is supported for integers only.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory_swap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-memory-swap"><strong>memory_swap</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory_swap" 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>A limit value equal to memory plus swap. Must be used with the -m (βmemory) flag. The swap LIMIT should always be larger than -m (βmemory) value. By default, the swap LIMIT will be set to double the value of βmemory Note - idempotency is supported for integers only.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory_swappiness"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-memory-swappiness"><strong>memory_swappiness</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory_swappiness" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Tune a containerβs memory swappiness behavior. Accepts an integer between 0 and 100.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-mount"></div> +<div class="ansibleOptionAnchor" id="parameter-mounts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-mounts"><span id="ansible-collections-containers-podman-podman-container-module-parameter-mount"></span><strong>mount</strong></p> +<a class="ansibleOptionLink" href="#parameter-mount" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: mounts</span></p> +<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>Attach a filesystem mount to the container. bind or tmpfs For example mount βtype=bind,source=/path/on/host,destination=/path/in/containerβ</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-containers-podman-podman-container-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 container</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network"></div> +<div class="ansibleOptionAnchor" id="parameter-net"></div> +<div class="ansibleOptionAnchor" id="parameter-network_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-network-mode"><span id="ansible-collections-containers-podman-podman-container-module-parameter-network"></span><span id="ansible-collections-containers-podman-podman-container-module-parameter-net"></span><strong>network</strong></p> +<a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: net, network_mode</span></p> +<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>Set the Network mode for the container * bridge create a network stack on the default bridge * none no networking * container:<name|id> reuse another containerβs network stack * host use the podman host network stack. * <network-name>|<network-id> connect to a user-defined network * ns:<path> path to a network namespace to join * slirp4netns use slirp4netns to create a user network stack. This is the default for rootless containers</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network_aliases"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-network-aliases"><strong>network_aliases</strong></p> +<a class="ansibleOptionLink" href="#parameter-network_aliases" 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>Add network-scoped alias for the container. A container will only have access to aliases on the first network that it joins. This is a limitation that will be removed in a later release.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-no_hosts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-no-hosts"><strong>no_hosts</strong></p> +<a class="ansibleOptionLink" href="#parameter-no_hosts" 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>Do not create /etc/hosts for the container Default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-oom_kill_disable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-oom-kill-disable"><strong>oom_kill_disable</strong></p> +<a class="ansibleOptionLink" href="#parameter-oom_kill_disable" 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>Whether to disable OOM Killer for the container or not. Default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-oom_score_adj"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-oom-score-adj"><strong>oom_score_adj</strong></p> +<a class="ansibleOptionLink" href="#parameter-oom_score_adj" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Tune the hostβs OOM preferences for containers (accepts -1000 to 1000)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pid"></div> +<div class="ansibleOptionAnchor" id="parameter-pid_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-pid-mode"><span id="ansible-collections-containers-podman-podman-container-module-parameter-pid"></span><strong>pid</strong></p> +<a class="ansibleOptionLink" href="#parameter-pid" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: pid_mode</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set the PID mode for the container</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pids_limit"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-pids-limit"><strong>pids_limit</strong></p> +<a class="ansibleOptionLink" href="#parameter-pids_limit" 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>Tune the containerβs PIDs limit. Set -1 to have unlimited PIDs for the container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pod"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-pod"><strong>pod</strong></p> +<a class="ansibleOptionLink" href="#parameter-pod" 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>Run container in an existing pod. If you want podman to make the pod for you, prefix the pod name with βnew:β</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-privileged"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-privileged"><strong>privileged</strong></p> +<a class="ansibleOptionLink" href="#parameter-privileged" 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>Give extended privileges to this container. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-publish"></div> +<div class="ansibleOptionAnchor" id="parameter-ports"></div> +<div class="ansibleOptionAnchor" id="parameter-published"></div> +<div class="ansibleOptionAnchor" id="parameter-published_ports"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-published-ports"><span id="ansible-collections-containers-podman-podman-container-module-parameter-published"></span><span id="ansible-collections-containers-podman-podman-container-module-parameter-publish"></span><span id="ansible-collections-containers-podman-podman-container-module-parameter-ports"></span><strong>publish</strong></p> +<a class="ansibleOptionLink" href="#parameter-publish" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ports, published, published_ports</span></p> +<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>Publish a containerβs port, or range of ports, to the host. Format - ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort In case of only containerPort is set, the hostPort will chosen randomly by Podman.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-publish_all"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-publish-all"><strong>publish_all</strong></p> +<a class="ansibleOptionLink" href="#parameter-publish_all" 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>Publish all exposed ports to random ports on the host interfaces. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-read_only"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-read-only"><strong>read_only</strong></p> +<a class="ansibleOptionLink" href="#parameter-read_only" 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>Mount the containerβs root filesystem as read only. Default is false</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-read_only_tmpfs"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-read-only-tmpfs"><strong>read_only_tmpfs</strong></p> +<a class="ansibleOptionLink" href="#parameter-read_only_tmpfs" 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 container is running in βread-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is true</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-recreate"><strong>recreate</strong></p> +<a class="ansibleOptionLink" href="#parameter-recreate" 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>Use with present and started states to force the re-creation of an existing container.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-requires"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-requires"><strong>requires</strong></p> +<a class="ansibleOptionLink" href="#parameter-requires" 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>Specify one or more requirements. A requirement is a dependency container that will be started before this container. Containers can be specified by name or ID.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-restart_policy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-restart-policy"><strong>restart_policy</strong></p> +<a class="ansibleOptionLink" href="#parameter-restart_policy" 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>Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the podman kill or podman stop commands. Valid values are * no - Do not restart containers on exit * on-failure[:max_retries] - Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit * always - Restart containers when they exit, regardless of status, retrying indefinitely</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-restart_time"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-restart-time"><strong>restart_time</strong></p> +<a class="ansibleOptionLink" href="#parameter-restart_time" 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>Seconds to wait before forcibly stopping the container when restarting. Use -1 for infinite wait. Applies to βrestartedβ status.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-rm"></div> +<div class="ansibleOptionAnchor" id="parameter-remove"></div> +<div class="ansibleOptionAnchor" id="parameter-auto_remove"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-rm"><span id="ansible-collections-containers-podman-podman-container-module-parameter-remove"></span><span id="ansible-collections-containers-podman-podman-container-module-parameter-auto-remove"></span><strong>rm</strong></p> +<a class="ansibleOptionLink" href="#parameter-rm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: remove, auto_remove</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Automatically remove the container when it exits. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-rootfs"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-rootfs"><strong>rootfs</strong></p> +<a class="ansibleOptionLink" href="#parameter-rootfs" 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 true, the first argument refers to an exploded container on the file system. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-sdnotify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-sdnotify"><strong>sdnotify</strong></p> +<a class="ansibleOptionLink" href="#parameter-sdnotify" 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>Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Can be container, conmon, ignore.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-secrets"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-secrets"><strong>secrets</strong></p> +<a class="ansibleOptionLink" href="#parameter-secrets" 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>Add the named secrets into the container. The format is <code class="docutils literal notranslate"><span class="pre">secret[,opt=opt...]</span></code>, see <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-run.1.html#secret-secret-opt-opt">documentation</a> for more details.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-security_opt"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-security-opt"><strong>security_opt</strong></p> +<a class="ansibleOptionLink" href="#parameter-security_opt" 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>Security Options. For example security_opt βseccomp=unconfinedβ</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-shm_size"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-shm-size"><strong>shm_size</strong></p> +<a class="ansibleOptionLink" href="#parameter-shm_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Size of /dev/shm. The format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m(megabytes), or g (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses 64m</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-sig_proxy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-sig-proxy"><strong>sig_proxy</strong></p> +<a class="ansibleOptionLink" href="#parameter-sig_proxy" 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>Proxy signals sent to the podman run command to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-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><em>absent</em> - A container matching the specified name will be stopped and removed.</p> +<p><em>present</em> - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config. Image version will be taken into account when comparing configuration. Use the recreate option to force the re-creation of the matching container.</p> +<p><em>started</em> - Asserts there is a running container matching the name and any provided configuration. If no container matches the name, a container will be created and started. Use recreate to always re-create a matching container, even if it is running. Use force_restart to force a matching container to be stopped and restarted.</p> +<p><em>stopped</em> - Asserts that the container is first <em>present</em>, and then if the container is running moves it to a stopped state.</p> +<p><em>created</em> - Asserts that the container exists with given configuration. If container doesnβt exist, the module creates it and leaves it in βcreatedβ state. If configuration doesnβt match or βrecreateβ option is set, the container will be recreated</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"present"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stopped"</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"started"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"created"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-stop_signal"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-stop-signal"><strong>stop_signal</strong></p> +<a class="ansibleOptionLink" href="#parameter-stop_signal" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Signal to stop a container. Default is SIGTERM.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-stop_time"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-stop-time"><strong>stop_time</strong></p> +<a class="ansibleOptionLink" href="#parameter-stop_time" 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>Seconds to wait before forcibly stopping the container. Use -1 for infinite wait. Applies to βstoppedβ status.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-stop-timeout"><strong>stop_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Timeout (in seconds) to stop a container. Default is 10.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-subgidname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-subgidname"><strong>subgidname</strong></p> +<a class="ansibleOptionLink" href="#parameter-subgidname" 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>Run the container in a new user namespace using the map with βnameβ in the /etc/subgid file.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-subuidname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-subuidname"><strong>subuidname</strong></p> +<a class="ansibleOptionLink" href="#parameter-subuidname" 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>Run the container in a new user namespace using the map with βnameβ in the /etc/subuid file.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-sysctl"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-sysctl"><strong>sysctl</strong></p> +<a class="ansibleOptionLink" href="#parameter-sysctl" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Configure namespaced kernel parameters at runtime</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-systemd"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-systemd"><strong>systemd</strong></p> +<a class="ansibleOptionLink" href="#parameter-systemd" 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>Run container in systemd mode. The default is true.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-timezone"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-timezone"><strong>timezone</strong></p> +<a class="ansibleOptionLink" href="#parameter-timezone" 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 timezone in container. This flag takes area-based timezones, GMT time, as well as local, which sets the timezone in the container to match the host machine. See /usr/share/zoneinfo/ for valid timezones. Remote connections use local containers.conf for defaults.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tmpfs"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-tmpfs"><strong>tmpfs</strong></p> +<a class="ansibleOptionLink" href="#parameter-tmpfs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Create a tmpfs mount. For example tmpfs β/tmpβ βrw,size=787448k,mode=1777β</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tty"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-tty"><strong>tty</strong></p> +<a class="ansibleOptionLink" href="#parameter-tty" 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>Allocate a pseudo-TTY. The default is false.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-uidmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-uidmap"><strong>uidmap</strong></p> +<a class="ansibleOptionLink" href="#parameter-uidmap" 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>Run the container in a new user namespace using the supplied mapping.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ulimit"></div> +<div class="ansibleOptionAnchor" id="parameter-ulimits"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-ulimits"><span id="ansible-collections-containers-podman-podman-container-module-parameter-ulimit"></span><strong>ulimit</strong></p> +<a class="ansibleOptionLink" href="#parameter-ulimit" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ulimits</span></p> +<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>Ulimit options</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-user"><strong>user</strong></p> +<a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Sets the username or UID used and optionally the groupname or GID for the specified command.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-userns"></div> +<div class="ansibleOptionAnchor" id="parameter-userns_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-userns-mode"><span id="ansible-collections-containers-podman-podman-container-module-parameter-userns"></span><strong>userns</strong></p> +<a class="ansibleOptionLink" href="#parameter-userns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: userns_mode</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value means user namespaces are disabled.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-uts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-uts"><strong>uts</strong></p> +<a class="ansibleOptionLink" href="#parameter-uts" 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 the UTS mode for the container</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume"></div> +<div class="ansibleOptionAnchor" id="parameter-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-volumes"><span id="ansible-collections-containers-podman-podman-container-module-parameter-volume"></span><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: volumes</span></p> +<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>Create a bind mount. If you specify, volume /HOST-DIR:/CONTAINER-DIR, podman bind mounts /HOST-DIR in the host to /CONTAINER-DIR in the podman container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volumes_from"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-volumes-from"><strong>volumes_from</strong></p> +<a class="ansibleOptionLink" href="#parameter-volumes_from" 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>Mount volumes from the specified container(s).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-workdir"></div> +<div class="ansibleOptionAnchor" id="parameter-working_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-parameter-working-dir"><span id="ansible-collections-containers-podman-podman-container-module-parameter-workdir"></span><strong>workdir</strong></p> +<a class="ansibleOptionLink" href="#parameter-workdir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: working_dir</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Working directory inside the container. The default working directory for running binaries within a container is the root directory (/).</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Run container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">container</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</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">started</span> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-mac_address"></div> - <b>mac_address</b> - <a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a MAC address for the container, for example '92:d0:c6:0a:29:33'. Don't forget that it must be unique within one Ethernet network.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-memory"></div> - <b>memory</b> - <a class="ansibleOptionLink" href="#parameter-memory" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Memory limit (format 10k, where unit = b, k, m or g) Note - idempotency is supported for integers only.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-memory_reservation"></div> - <b>memory_reservation</b> - <a class="ansibleOptionLink" href="#parameter-memory_reservation" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Memory soft limit (format 100m, where unit = b, k, m or g) Note - idempotency is supported for integers only.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-memory_swap"></div> - <b>memory_swap</b> - <a class="ansibleOptionLink" href="#parameter-memory_swap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>A limit value equal to memory plus swap. Must be used with the -m (--memory) flag. The swap LIMIT should always be larger than -m (--memory) value. By default, the swap LIMIT will be set to double the value of --memory Note - idempotency is supported for integers only.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-memory_swappiness"></div> - <b>memory_swappiness</b> - <a class="ansibleOptionLink" href="#parameter-memory_swappiness" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-mount"></div> - <b>mount</b> - <a class="ansibleOptionLink" href="#parameter-mount" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Attach a filesystem mount to the container. bind or tmpfs For example mount "type=bind,source=/path/on/host,destination=/path/in/container"</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: mounts</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Name of the container</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-network"></div> - <b>network</b> - <a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set the Network mode for the container * bridge create a network stack on the default bridge * none no networking * container:<name|id> reuse another container's network stack * host use the podman host network stack. * <network-name>|<network-id> connect to a user-defined network * ns:<path> path to a network namespace to join * slirp4netns use slirp4netns to create a user network stack. This is the default for rootless containers</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: net, network_mode</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-network_aliases"></div> - <b>network_aliases</b> - <a class="ansibleOptionLink" href="#parameter-network_aliases" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add network-scoped alias for the container. A container will only have access to aliases on the first network that it joins. This is a limitation that will be removed in a later release.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-no_hosts"></div> - <b>no_hosts</b> - <a class="ansibleOptionLink" href="#parameter-no_hosts" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Do not create /etc/hosts for the container Default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-oom_kill_disable"></div> - <b>oom_kill_disable</b> - <a class="ansibleOptionLink" href="#parameter-oom_kill_disable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Whether to disable OOM Killer for the container or not. Default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-oom_score_adj"></div> - <b>oom_score_adj</b> - <a class="ansibleOptionLink" href="#parameter-oom_score_adj" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Tune the host's OOM preferences for containers (accepts -1000 to 1000)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pid"></div> - <b>pid</b> - <a class="ansibleOptionLink" href="#parameter-pid" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the PID mode for the container</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: pid_mode</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pids_limit"></div> - <b>pids_limit</b> - <a class="ansibleOptionLink" href="#parameter-pids_limit" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Tune the container's PIDs limit. Set -1 to have unlimited PIDs for the container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pod"></div> - <b>pod</b> - <a class="ansibleOptionLink" href="#parameter-pod" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Run container in an existing pod. If you want podman to make the pod for you, prefix the pod name with "new:"</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-privileged"></div> - <b>privileged</b> - <a class="ansibleOptionLink" href="#parameter-privileged" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Give extended privileges to this container. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-publish"></div> - <b>publish</b> - <a class="ansibleOptionLink" href="#parameter-publish" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Publish a container's port, or range of ports, to the host. Format - ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort In case of only containerPort is set, the hostPort will chosen randomly by Podman.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: ports, published, published_ports</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-publish_all"></div> - <b>publish_all</b> - <a class="ansibleOptionLink" href="#parameter-publish_all" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Publish all exposed ports to random ports on the host interfaces. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-read_only"></div> - <b>read_only</b> - <a class="ansibleOptionLink" href="#parameter-read_only" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Mount the container's root filesystem as read only. Default is false</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-read_only_tmpfs"></div> - <b>read_only_tmpfs</b> - <a class="ansibleOptionLink" href="#parameter-read_only_tmpfs" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>If container is running in --read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is true</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-recreate"></div> - <b>recreate</b> - <a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Use with present and started states to force the re-creation of an existing container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-requires"></div> - <b>requires</b> - <a class="ansibleOptionLink" href="#parameter-requires" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Specify one or more requirements. A requirement is a dependency container that will be started before this container. Containers can be specified by name or ID.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-restart_policy"></div> - <b>restart_policy</b> - <a class="ansibleOptionLink" href="#parameter-restart_policy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the podman kill or podman stop commands. Valid values are * no - Do not restart containers on exit * on-failure[:max_retries] - Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit * always - Restart containers when they exit, regardless of status, retrying indefinitely</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-rm"></div> - <b>rm</b> - <a class="ansibleOptionLink" href="#parameter-rm" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Automatically remove the container when it exits. The default is false.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: remove, auto_remove</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-rootfs"></div> - <b>rootfs</b> - <a class="ansibleOptionLink" href="#parameter-rootfs" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>If true, the first argument refers to an exploded container on the file system. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-sdnotify"></div> - <b>sdnotify</b> - <a class="ansibleOptionLink" href="#parameter-sdnotify" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Can be container, conmon, ignore.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-secrets"></div> - <b>secrets</b> - <a class="ansibleOptionLink" href="#parameter-secrets" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the named secrets into the container. The format is <code>secret[,opt=opt...]</code>, see <a href='https://docs.podman.io/en/latest/markdown/podman-run.1.html#secret-secret-opt-opt'>documentation</a> for more details.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-security_opt"></div> - <b>security_opt</b> - <a class="ansibleOptionLink" href="#parameter-security_opt" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Security Options. For example security_opt "seccomp=unconfined"</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-shm_size"></div> - <b>shm_size</b> - <a class="ansibleOptionLink" href="#parameter-shm_size" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Size of /dev/shm. The format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m(megabytes), or g (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses 64m</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-sig_proxy"></div> - <b>sig_proxy</b> - <a class="ansibleOptionLink" href="#parameter-sig_proxy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Proxy signals sent to the podman run command to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>absent</li> - <li>present</li> - <li>stopped</li> - <li><div style="color: blue"><b>started</b> ←</div></li> - <li>created</li> - </ul> - </td> - <td> - <div><em>absent</em> - A container matching the specified name will be stopped and removed.</div> - <div><em>present</em> - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config. Image version will be taken into account when comparing configuration. Use the recreate option to force the re-creation of the matching container.</div> - <div><em>started</em> - Asserts there is a running container matching the name and any provided configuration. If no container matches the name, a container will be created and started. Use recreate to always re-create a matching container, even if it is running. Use force_restart to force a matching container to be stopped and restarted.</div> - <div><em>stopped</em> - Asserts that the container is first <em>present</em>, and then if the container is running moves it to a stopped state.</div> - <div><em>created</em> - Asserts that the container exists with given configuration. If container doesn't exist, the module creates it and leaves it in 'created' state. If configuration doesn't match or 'recreate' option is set, the container will be recreated</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-stop_signal"></div> - <b>stop_signal</b> - <a class="ansibleOptionLink" href="#parameter-stop_signal" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Signal to stop a container. Default is SIGTERM.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div> - <b>stop_timeout</b> - <a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Timeout (in seconds) to stop a container. Default is 10.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-subgidname"></div> - <b>subgidname</b> - <a class="ansibleOptionLink" href="#parameter-subgidname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Run the container in a new user namespace using the map with 'name' in the /etc/subgid file.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-subuidname"></div> - <b>subuidname</b> - <a class="ansibleOptionLink" href="#parameter-subuidname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Run the container in a new user namespace using the map with 'name' in the /etc/subuid file.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-sysctl"></div> - <b>sysctl</b> - <a class="ansibleOptionLink" href="#parameter-sysctl" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Configure namespaced kernel parameters at runtime</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-systemd"></div> - <b>systemd</b> - <a class="ansibleOptionLink" href="#parameter-systemd" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Run container in systemd mode. The default is true.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-timezone"></div> - <b>timezone</b> - <a class="ansibleOptionLink" href="#parameter-timezone" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set timezone in container. This flag takes area-based timezones, GMT time, as well as local, which sets the timezone in the container to match the host machine. See /usr/share/zoneinfo/ for valid timezones. Remote connections use local containers.conf for defaults.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-tmpfs"></div> - <b>tmpfs</b> - <a class="ansibleOptionLink" href="#parameter-tmpfs" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Create a tmpfs mount. For example tmpfs "/tmp" "rw,size=787448k,mode=1777"</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-tty"></div> - <b>tty</b> - <a class="ansibleOptionLink" href="#parameter-tty" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Allocate a pseudo-TTY. The default is false.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-uidmap"></div> - <b>uidmap</b> - <a class="ansibleOptionLink" href="#parameter-uidmap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Run the container in a new user namespace using the supplied mapping.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ulimit"></div> - <b>ulimit</b> - <a class="ansibleOptionLink" href="#parameter-ulimit" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Ulimit options</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: ulimits</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-user"></div> - <b>user</b> - <a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Sets the username or UID used and optionally the groupname or GID for the specified command.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-userns"></div> - <b>userns</b> - <a class="ansibleOptionLink" href="#parameter-userns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value means user namespaces are disabled.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: userns_mode</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-uts"></div> - <b>uts</b> - <a class="ansibleOptionLink" href="#parameter-uts" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the UTS mode for the container</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-volume"></div> - <b>volume</b> - <a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Create a bind mount. If you specify, volume /HOST-DIR:/CONTAINER-DIR, podman bind mounts /HOST-DIR in the host to /CONTAINER-DIR in the podman container.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: volumes</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-volumes_from"></div> - <b>volumes_from</b> - <a class="ansibleOptionLink" href="#parameter-volumes_from" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Mount volumes from the specified container(s).</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-workdir"></div> - <b>workdir</b> - <a class="ansibleOptionLink" href="#parameter-workdir" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Working directory inside the container. The default working directory for running binaries within a container is the root directory (/).</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: working_dir</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Run container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">container</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</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">started</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">Create a data container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">mydata</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">busybox</span> +<span class="w"> </span><span class="nt">volume</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/data</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 data container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">mydata</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">busybox</span><span class="w"></span> -<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/data</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">Re-create a redis container with systemd service file generated in /tmp/</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">myredis</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis-server --appendonly yes</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="nt">recreate</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="nt">expose</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6379</span> +<span class="w"> </span><span class="nt">volumes_from</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mydata</span> +<span class="w"> </span><span class="nt">generate_systemd</span><span class="p">:</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/</span> +<span class="w"> </span><span class="nt">restart_policy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">always</span> +<span class="w"> </span><span class="nt">stop_timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">120</span> +<span class="w"> </span><span class="nt">names</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="nt">container_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ainer</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">Re-create a redis container with systemd service file generated in /tmp/</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">myredis</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis-server --appendonly yes</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="w"> </span><span class="nt">recreate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">expose</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6379</span><span class="w"></span> -<span class="w"> </span><span class="nt">volumes_from</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mydata</span><span class="w"></span> -<span class="w"> </span><span class="nt">generate_systemd</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/</span><span class="w"></span> -<span class="w"> </span><span class="nt">restart_policy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">always</span><span class="w"></span> -<span class="w"> </span><span class="nt">time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">120</span><span class="w"></span> -<span class="w"> </span><span class="nt">names</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">container_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ainer</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">Restart a container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">myapplication</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</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">started</span> +<span class="w"> </span><span class="nt">restart</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="nt">etc_hosts</span><span class="p">:</span> +<span class="w"> </span><span class="nt">other</span><span class="p">:</span><span class="w"> </span><span class="s">"127.0.0.1"</span> +<span class="w"> </span><span class="nt">restart_policy</span><span class="p">:</span><span class="w"> </span><span class="s">"no"</span> +<span class="w"> </span><span class="nt">device</span><span class="p">:</span><span class="w"> </span><span class="s">"/dev/sda:/dev/xvda:rwm"</span> +<span class="w"> </span><span class="nt">ports</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"8080:9000"</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"127.0.0.1:8081:9001/udp"</span> +<span class="w"> </span><span class="nt">env</span><span class="p">:</span> +<span class="w"> </span><span class="nt">SECRET_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">"ssssh"</span> +<span class="w"> </span><span class="nt">BOOLEAN_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">"yes"</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">Restart a container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">myapplication</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</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">started</span><span class="w"></span> -<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">etc_hosts</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">other</span><span class="p">:</span><span class="w"> </span><span class="s">"127.0.0.1"</span><span class="w"></span> -<span class="w"> </span><span class="nt">restart_policy</span><span class="p">:</span><span class="w"> </span><span class="s">"no"</span><span class="w"></span> -<span class="w"> </span><span class="nt">device</span><span class="p">:</span><span class="w"> </span><span class="s">"/dev/sda:/dev/xvda:rwm"</span><span class="w"></span> -<span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"8080:9000"</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"127.0.0.1:8081:9001/udp"</span><span class="w"></span> -<span class="w"> </span><span class="nt">env</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">SECRET_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">"ssssh"</span><span class="w"></span> -<span class="w"> </span><span class="nt">BOOLEAN_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">"yes"</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">Container present</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">mycontainer</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="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu:14.04</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"sleep</span><span class="nv"> </span><span class="s">1d"</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">Container present</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">mycontainer</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="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu:14.04</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"sleep</span><span class="nv"> </span><span class="s">1d"</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">Stop a container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">mycontainer</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">stopped</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">Stop a container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">mycontainer</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">stopped</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">Start 4 load-balanced containers</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</span> +<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"container</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">recreate</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="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">someuser/anotherappimage</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sleep 1d</span> +<span class="w"> </span><span class="nt">with_sequence</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">count=4</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">Start 4 load-balanced containers</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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="s">"container</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">recreate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">someuser/anotherappimage</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sleep 1d</span><span class="w"></span> -<span class="w"> </span><span class="nt">with_sequence</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">count=4</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">remove container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">ohno</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="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">remove container</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">ohno</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> +<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">Writing output</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">myservice</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">busybox</span> +<span class="w"> </span><span class="nt">log_options</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path=/var/log/container/mycontainer.json</span> +<span class="w"> </span><span class="nt">log_driver</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">k8s-file</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">Writing output</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">myservice</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">busybox</span><span class="w"></span> -<span class="w"> </span><span class="nt">log_options</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path=/var/log/container/mycontainer.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">log_driver</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">k8s-file</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">Run container with complex command with quotes</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">mycontainer</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">certbot/certbot</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">renew</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">--deploy-hook</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"echo</span><span class="nv"> </span><span class="s">1</span><span class="nv"> </span><span class="s">></span><span class="nv"> </span><span class="s">/var/lib/letsencrypt/complete"</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-container"></div> - <b>container</b> - <a class="ansibleOptionLink" href="#return-container" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>Facts representing the current state of the container. Matches the podman inspection output.</div> - <div>Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as <code>podman_container</code>. Note that the returned fact will be removed in Ansible 2.12.</div> - <div>Empty if <code>state</code> is <em>absent</em>.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{ "AppArmorProfile": "", "Args": [ "sh" ], "BoundingCaps": [ "CAP_CHOWN", ... ], "Config": { "Annotations": { "io.kubernetes.cri-o.ContainerType": "sandbox", "io.kubernetes.cri-o.TTY": "false" }, "AttachStderr": false, "AttachStdin": false, "AttachStdout": false, "Cmd": [ "sh" ], "Domainname": "", "Entrypoint": "", "Env": [ "PATH=/usr/sbin:/usr/bin:/sbin:/bin", "TERM=xterm", "HOSTNAME=", "container=podman" ], "Hostname": "", "Image": "docker.io/library/busybox:latest", "Labels": null, "OpenStdin": false, "StdinOnce": false, "StopSignal": 15, "Tty": false, "User": { "gid": 0, "uid": 0 }, "Volumes": null, "WorkingDir": "/" }, "ConmonPidFile": "...", "Created": "2019-06-17T19:13:09.873858307+03:00", "Dependencies": [], "Driver": "overlay", "EffectiveCaps": [ "CAP_CHOWN", ... ], "ExecIDs": [], "ExitCommand": [ "/usr/bin/podman", "--root", ... ], "GraphDriver": { ... }, "HostConfig": { ... }, "HostnamePath": "...", "HostsPath": "...", "ID": "...", "Image": "...", "ImageName": "docker.io/library/busybox:latest", "IsInfra": false, "LogPath": "/tmp/container/mycontainer.json", "MountLabel": "system_u:object_r:container_file_t:s0:c282,c782", "Mounts": [ ... ], "Name": "myservice", "Namespace": "", "NetworkSettings": { "Bridge": "", ... }, "Path": "sh", "ProcessLabel": "system_u:system_r:container_t:s0:c282,c782", "ResolvConfPath": "...", "RestartCount": 0, "Rootfs": "", "State": { "Dead": false, "Error": "", "ExitCode": 0, "FinishedAt": "2019-06-17T19:13:10.157518963+03:00", "Healthcheck": { "FailingStreak": 0, "Log": null, "Status": "" }, "OOMKilled": false, "OciVersion": "1.0.1-dev", "Paused": false, "Pid": 4083, "Restarting": false, "Running": false, "StartedAt": "2019-06-17T19:13:10.152479729+03:00", "Status": "exited" }, "StaticDir": "..." ... }</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-module-return-container"><strong>container</strong></p> +<a class="ansibleOptionLink" href="#return-container" 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>Facts representing the current state of the container. Matches the podman inspection output.</p> +<p>Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as <code class="docutils literal notranslate"><span class="pre">podman_container</span></code>. Note that the returned fact will be removed in Ansible 2.12.</p> +<p>Empty if <code class="docutils literal notranslate"><span class="pre">state</span></code> is <em>absent</em>.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"{</span> <span class="pre">\"AppArmorProfile\":</span> <span class="pre">\"\",</span> <span class="pre">\"Args\":</span> <span class="pre">[</span> <span class="pre">\"sh\"</span> <span class="pre">],</span> <span class="pre">\"BoundingCaps\":</span> <span class="pre">[</span> <span class="pre">\"CAP_CHOWN\",</span> <span class="pre">...</span> <span class="pre">],</span> <span class="pre">\"Config\":</span> <span class="pre">{</span> <span class="pre">\"Annotations\":</span> <span class="pre">{</span> <span class="pre">\"io.kubernetes.cri-o.ContainerType\":</span> <span class="pre">\"sandbox\",</span> <span class="pre">\"io.kubernetes.cri-o.TTY\":</span> <span class="pre">\"false\"</span> <span class="pre">},</span> <span class="pre">\"AttachStderr\":</span> <span class="pre">false,</span> <span class="pre">\"AttachStdin\":</span> <span class="pre">false,</span> <span class="pre">\"AttachStdout\":</span> <span class="pre">false,</span> <span class="pre">\"Cmd\":</span> <span class="pre">[</span> <span class="pre">\"sh\"</span> <span class="pre">],</span> <span class="pre">\"Domainname\":</span> <span class="pre">\"\",</span> <span class="pre">\"Entrypoint\":</span> <span class="pre">\"\",</span> <span class="pre">\"Env\":</span> <span class="pre">[</span> <span class="pre">\"PATH=/usr/sbin:/usr/bin:/sbin:/bin\",</span> <span class="pre">\"TERM=xterm\",</span> <span class="pre">\"HOSTNAME=\",</span> <span class="pre">\"container=podman\"</span> <span class="pre">],</span> <span class="pre">\"Hostname\":</span> <span class="pre">\"\",</span> <span class="pre">\"Image\":</span> <span class="pre">\"docker.io/library/busybox:latest\",</span> <span class="pre">\"Labels\":</span> <span class="pre">null,</span> <span class="pre">\"OpenStdin\":</span> <span class="pre">false,</span> <span class="pre">\"StdinOnce\":</span> <span class="pre">false,</span> <span class="pre">\"StopSignal\":</span> <span class="pre">15,</span> <span class="pre">\"Tty\":</span> <span class="pre">false,</span> <span class="pre">\"User\":</span> <span class="pre">{</span> <span class="pre">\"gid\":</span> <span class="pre">0,</span> <span class="pre">\"uid\":</span> <span class="pre">0</span> <span class="pre">},</span> <span class="pre">\"Volumes\":</span> <span class="pre">null,</span> <span class="pre">\"WorkingDir\":</span> <span class="pre">\"/\"</span> <span class="pre">},</span> <span class="pre">\"ConmonPidFile\":</span> <span class="pre">\"...\",</span> <span class="pre">\"Created\":</span> <span class="pre">\"2019-06-17T19:13:09.873858307+03:00\",</span> <span class="pre">\"Dependencies\":</span> <span class="pre">[],</span> <span class="pre">\"Driver\":</span> <span class="pre">\"overlay\",</span> <span class="pre">\"EffectiveCaps\":</span> <span class="pre">[</span> <span class="pre">\"CAP_CHOWN\",</span> <span class="pre">...</span> <span class="pre">],</span> <span class="pre">\"ExecIDs\":</span> <span class="pre">[],</span> <span class="pre">\"ExitCommand\":</span> <span class="pre">[</span> <span class="pre">\"/usr/bin/podman\",</span> <span class="pre">\"--root\",</span> <span class="pre">...</span> <span class="pre">],</span> <span class="pre">\"GraphDriver\":</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">},</span> <span class="pre">\"HostConfig\":</span> <span class="pre">{</span> <span class="pre">...</span> <span class="pre">},</span> <span class="pre">\"HostnamePath\":</span> <span class="pre">\"...\",</span> <span class="pre">\"HostsPath\":</span> <span class="pre">\"...\",</span> <span class="pre">\"ID\":</span> <span class="pre">\"...\",</span> <span class="pre">\"Image\":</span> <span class="pre">\"...\",</span> <span class="pre">\"ImageName\":</span> <span class="pre">\"docker.io/library/busybox:latest\",</span> <span class="pre">\"IsInfra\":</span> <span class="pre">false,</span> <span class="pre">\"LogPath\":</span> <span class="pre">\"/tmp/container/mycontainer.json\",</span> <span class="pre">\"MountLabel\":</span> <span class="pre">\"system_u:object_r:container_file_t:s0:c282,c782\",</span> <span class="pre">\"Mounts\":</span> <span class="pre">[</span> <span class="pre">...</span> <span class="pre">],</span> <span class="pre">\"Name\":</span> <span class="pre">\"myservice\",</span> <span class="pre">\"Namespace\":</span> <span class="pre">\"\",</span> <span class="pre">\"NetworkSettings\":</span> <span class="pre">{</span> <span class="pre">\"Bridge\":</span> <span class="pre">\"\",</span> <span class="pre">...</span> <span class="pre">},</span> <span class="pre">\"Path\":</span> <span class="pre">\"sh\",</span> <span class="pre">\"ProcessLabel\":</span> <span class="pre">\"system_u:system_r:container_t:s0:c282,c782\",</span> <span class="pre">\"ResolvConfPath\":</span> <span class="pre">\"...\",</span> <span class="pre">\"RestartCount\":</span> <span class="pre">0,</span> <span class="pre">\"Rootfs\":</span> <span class="pre">\"\",</span> <span class="pre">\"State\":</span> <span class="pre">{</span> <span class="pre">\"Dead\":</span> <span class="pre">false,</span> <span class="pre">\"Error\":</span> <span class="pre">\"\",</span> <span class="pre">\"ExitCode\":</span> <span class="pre">0,</span> <span class="pre">\"FinishedAt\":</span> <span class="pre">\"2019-06-17T19:13:10.157518963+03:00\",</span> <span class="pre">\"Healthcheck\":</span> <span class="pre">{</span> <span class="pre">\"FailingStreak\":</span> <span class="pre">0,</span> <span class="pre">\"Log\":</span> <span class="pre">null,</span> <span class="pre">\"Status\":</span> <span class="pre">\"\"</span> <span class="pre">},</span> <span class="pre">\"OOMKilled\":</span> <span class="pre">false,</span> <span class="pre">\"OciVersion\":</span> <span class="pre">\"1.0.1-dev\",</span> <span class="pre">\"Paused\":</span> <span class="pre">false,</span> <span class="pre">\"Pid\":</span> <span class="pre">4083,</span> <span class="pre">\"Restarting\":</span> <span class="pre">false,</span> <span class="pre">\"Running\":</span> <span class="pre">false,</span> <span class="pre">\"StartedAt\":</span> <span class="pre">\"2019-06-17T19:13:10.152479729+03:00\",</span> <span class="pre">\"Status\":</span> <span class="pre">\"exited\"</span> <span class="pre">},</span> <span class="pre">\"StaticDir\":</span> <span class="pre">\"...\"</span> <span class="pre">...</span> <span class="pre">}"</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -2270,11 +1431,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="index.html" title="previous chapter">Containers.Podman</a></li> + <li>Next: <a href="podman_container_exec_module.html" title="next chapter">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> </ul></li> </ul> </div> @@ -2304,8 +1502,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_container_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_containers_module.html b/ansible_collections/containers/podman/docs/podman_containers_module.html index 4cd64e306..e84707d36 100644 --- a/ansible_collections/containers/podman/docs/podman_containers_module.html +++ b/ansible_collections/containers/podman/docs/podman_containers_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_containers β Manage podman containers in a batch — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_containers module β Manage podman containers in a batch — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_export module β Export a podman container" href="podman_export_module.html" /> + <link rel="prev" title="containers.podman.podman_container_info module β Gather facts about containers using podman" href="podman_container_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,105 +33,101 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-containers-module"></span><div class="section" id="containers-podman-podman-containers-manage-podman-containers-in-a-batch"> -<h1>containers.podman.podman_containers β Manage podman containers in a batch<a class="headerlink" href="#containers-podman-podman-containers-manage-podman-containers-in-a-batch" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-containers-module"></span><section id="containers-podman-podman-containers-module-manage-podman-containers-in-a-batch"> +<h1>containers.podman.podman_containers module β Manage podman containers in a batch<a class="headerlink" href="#containers-podman-podman-containers-module-manage-podman-containers-in-a-batch" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-containers-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_containers</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.4.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.4.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Manage groups of podman containers</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-containers-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-containers"></div> - <b>containers</b> - <a class="ansibleOptionLink" href="#parameter-containers" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>List of dictionaries with data for running containers for podman_container module.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Return additional information which can be helpful for investigations.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Run three containers at once</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_containers</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"></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">alpine</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sleep 1d</span><span class="w"></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">web</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span><span class="w"></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">test</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3-alpine</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python -V</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-containers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-containers-module-parameter-containers"><strong>containers</strong></p> +<a class="ansibleOptionLink" href="#parameter-containers" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span> / <span class="ansible-option-required">required</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>List of dictionaries with data for running containers for podman_container module.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-containers-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Return additional information which can be helpful for investigations.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Run three containers at once</span> +<span class="w"> </span><span class="nt">podman_containers</span><span class="p">:</span> +<span class="w"> </span><span class="nt">containers</span><span class="p">:</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">alpine</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sleep 1d</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">web</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</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">test</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3.10-alpine</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python -V</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -149,11 +146,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_container_info_module.html" title="previous chapter">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> + <li>Next: <a href="podman_export_module.html" title="next chapter">containers.podman.podman_export module β Export a podman container</a></li> </ul></li> </ul> </div> @@ -183,8 +217,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_containers_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_export_module.html b/ansible_collections/containers/podman/docs/podman_export_module.html index af1a49562..5a51a171c 100644 --- a/ansible_collections/containers/podman/docs/podman_export_module.html +++ b/ansible_collections/containers/podman/docs/podman_export_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_export β Export a podman container — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_export module β Export a podman container — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container" href="podman_generate_systemd_module.html" /> + <link rel="prev" title="containers.podman.podman_containers module β Manage podman containers in a batch" href="podman_containers_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,126 +33,118 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-export-module"></span><div class="section" id="containers-podman-podman-export-export-a-podman-container"> -<h1>containers.podman.podman_export β Export a podman container<a class="headerlink" href="#containers-podman-podman-export-export-a-podman-container" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-export-module"></span><section id="containers-podman-podman-export-module-export-a-podman-container"> +<h1>containers.podman.podman_export module β Export a podman container<a class="headerlink" href="#containers-podman-podman-export-module-export-a-podman-container" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-export-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_export</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>podman export exports the filesystem of a container and saves it as a tarball on the local machine</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-export-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-container"></div> - <b>container</b> - <a class="ansibleOptionLink" href="#parameter-container" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Container to export.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-dest"></div> - <b>dest</b> - <a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Path to export container to.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-force"></div> - <b>force</b> - <a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Force saving to file even if it exists.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_export</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span><span class="w"></span> -<span class="w"> </span><span class="nt">container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container-name</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-container"><strong>container</strong></p> +<a class="ansibleOptionLink" href="#parameter-container" 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>Container to export.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dest"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-dest"><strong>dest</strong></p> +<a class="ansibleOptionLink" href="#parameter-dest" 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>Path to export container to.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Force saving to file even if it exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-volume"><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume" 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>Volume to export.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_export</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span> +<span class="w"> </span><span class="nt">container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container-name</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_export</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span> +<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">volume-name</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -170,11 +163,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_containers_module.html" title="previous chapter">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> + <li>Next: <a href="podman_generate_systemd_module.html" title="next chapter">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> </ul></li> </ul> </div> @@ -204,8 +234,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_export_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_generate_systemd_module.html b/ansible_collections/containers/podman/docs/podman_generate_systemd_module.html index 429be9604..892160486 100644 --- a/ansible_collections/containers/podman/docs/podman_generate_systemd_module.html +++ b/ansible_collections/containers/podman/docs/podman_generate_systemd_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_generate_systemd β Generate systemd unit from a pod or a container — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_image module β Pull images for use by podman" href="podman_image_module.html" /> + <link rel="prev" title="containers.podman.podman_export module β Export a podman container" href="podman_export_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,19 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-generate-systemd-module"></span><div class="section" id="containers-podman-podman-generate-systemd-generate-systemd-unit-from-a-pod-or-a-container"> -<h1>containers.podman.podman_generate_systemd β Generate systemd unit from a pod or a container<a class="headerlink" href="#containers-podman-podman-generate-systemd-generate-systemd-unit-from-a-pod-or-a-container" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-generate-systemd-module"></span><section id="containers-podman-podman-generate-systemd-module-generate-systemd-unit-from-a-pod-or-a-container"> +<h1>containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container<a class="headerlink" href="#containers-podman-podman-generate-systemd-module-generate-systemd-unit-from-a-pod-or-a-container" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-generate-systemd-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_generate_systemd</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -49,437 +54,338 @@ <li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Generate systemd .service unit file(s) from a pod or a container</p></li> <li><p>Support Ansible check mode</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-generate-systemd-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on target host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-after"></div> - <b>after</b> - <a class="ansibleOptionLink" href="#parameter-after" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit after (<code>After=</code>) option, that ordering dependencies between the list of dependencies and this service.</div> - <div>This option may be specified more than once.</div> - <div>User-defined dependencies will be appended to the generated unit file</div> - <div>But any existing options such as needed or defined by default (e.g. <code>online.target</code>) will not be removed or overridden.</div> - <div>Only with Podman 4.0.0 and above</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-container_prefix"></div> - <b>container_prefix</b> - <a class="ansibleOptionLink" href="#parameter-container_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for containers.</div> - <div>If not set, use the default defined by podman, <code>container</code>.</div> - <div>Refer to podman-generate-systemd(1) man page for more information.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-dest"></div> - <b>dest</b> - <a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Destination of the generated systemd unit file(s)</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-env"></div> - <b>env</b> - <a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Set environment variables to the systemd unit files.</div> - <div>Keys are the environment variable names, and values are the environment variable values</div> - <div>Only with Podman 4.3.0 and above</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div><code>Podman</code> executable name or full path</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Name of the pod or container to export</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-new"></div> - <b>new</b> - <a class="ansibleOptionLink" href="#parameter-new" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Generate unit files that create containers and pods, not only start them.</div> - <div>Refer to podman-generate-systemd(1) man page for more information.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-no_header"></div> - <b>no_header</b> - <a class="ansibleOptionLink" href="#parameter-no_header" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Do not generate the header including meta data such as the Podman version and the timestamp.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-pod_prefix"></div> - <b>pod_prefix</b> - <a class="ansibleOptionLink" href="#parameter-pod_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for pods.</div> - <div>If not set, use the default defined by podman, <code>pod</code>.</div> - <div>Refer to podman-generate-systemd(1) man page for more information.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-requires"></div> - <b>requires</b> - <a class="ansibleOptionLink" href="#parameter-requires" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit requires (Requires=) option.</div> - <div>Similar to wants, but declares a stronger requirement dependency.</div> - <div>Only with Podman 4.0.0 and above</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-restart_policy"></div> - <b>restart_policy</b> - <a class="ansibleOptionLink" href="#parameter-restart_policy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no-restart</li> - <li>on-success</li> - <li>on-failure</li> - <li>on-abnormal</li> - <li>on-watchdog</li> - <li>on-abort</li> - <li>always</li> - </ul> - </td> - <td> - <div>Restart policy of the service</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-restart_sec"></div> - <b>restart_sec</b> - <a class="ansibleOptionLink" href="#parameter-restart_sec" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Configures the time to sleep before restarting a service (as configured with restart-policy).</div> - <div>Takes a value in seconds.</div> - <div>Only with Podman 4.0.0 and above</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-separator"></div> - <b>separator</b> - <a class="ansibleOptionLink" href="#parameter-separator" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Systemd unit name separator between the name/id of a container/pod and the prefix.</div> - <div>If not set, use the default defined by podman, <code>-</code>.</div> - <div>Refer to podman-generate-systemd(1) man page for more information.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-start_timeout"></div> - <b>start_timeout</b> - <a class="ansibleOptionLink" href="#parameter-start_timeout" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Override the default start timeout for the container with the given value in seconds.</div> - <div>Only with Podman 4.0.0 and above</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div> - <b>stop_timeout</b> - <a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Override the default stop timeout for the container with the given value in seconds.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-use_names"></div> - <b>use_names</b> - <a class="ansibleOptionLink" href="#parameter-use_names" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Use name of the containers for the start, stop, and description in the unit file.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-wants"></div> - <b>wants</b> - <a class="ansibleOptionLink" href="#parameter-wants" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit wants (<code>Wants=</code>) option, that this service is (weak) dependent on.</div> - <div>This option may be specified more than once.</div> - <div>This option does not influence the order in which services are started or stopped.</div> - <div>User-defined dependencies will be appended to the generated unit file</div> - <div>But any existing options such as needed or defined by default (e.g. <code>online.target</code>) will not be removed or overridden.</div> - <div>Only with Podman 4.0.0 and above</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="notes"> -<h2><a class="toc-backref" href="#id4">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-after"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-after"><strong>after</strong></p> +<a class="ansibleOptionLink" href="#parameter-after" 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>Add the systemd unit after (<code class="docutils literal notranslate"><span class="pre">After=</span></code>) option, that ordering dependencies between the list of dependencies and this service.</p> +<p>This option may be specified more than once.</p> +<p>User-defined dependencies will be appended to the generated unit file</p> +<p>But any existing options such as needed or defined by default (e.g. <code class="docutils literal notranslate"><span class="pre">online.target</span></code>) will not be removed or overridden.</p> +<p>Only with Podman 4.0.0 and above</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-container_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-container-prefix"><strong>container_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-container_prefix" 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 the systemd unit name prefix for containers.</p> +<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">container</span></code>.</p> +<p>Refer to podman-generate-systemd(1) man page for more information.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dest"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-dest"><strong>dest</strong></p> +<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Destination of the generated systemd unit file(s).</p> +<p>Use <code class="docutils literal notranslate"><span class="pre">/etc/systemd/system</span></code> for the system-wide systemd instance.</p> +<p>Use <code class="docutils literal notranslate"><span class="pre">/etc/systemd/user</span></code> or <code class="docutils literal notranslate"><span class="pre">~/.config/systemd/user</span></code> for use with per-user instances of systemd.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-env"><strong>env</strong></p> +<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set environment variables to the systemd unit files.</p> +<p>Keys are the environment variable names, and values are the environment variable values</p> +<p>Only with Podman 4.3.0 and above</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" 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><code class="docutils literal notranslate"><span class="pre">Podman</span></code> executable name or full path</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Replace the systemd unit file(s) even if it already exists.</p> +<p>This works with dest option.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-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 pod or container to export</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-new"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-new"><strong>new</strong></p> +<a class="ansibleOptionLink" href="#parameter-new" 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>Generate unit files that create containers and pods, not only start them.</p> +<p>Refer to podman-generate-systemd(1) man page for more information.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-no_header"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-no-header"><strong>no_header</strong></p> +<a class="ansibleOptionLink" href="#parameter-no_header" 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>Do not generate the header including meta data such as the Podman version and the timestamp.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pod_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-pod-prefix"><strong>pod_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-pod_prefix" 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 the systemd unit name prefix for pods.</p> +<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">pod</span></code>.</p> +<p>Refer to podman-generate-systemd(1) man page for more information.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-requires"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-requires"><strong>requires</strong></p> +<a class="ansibleOptionLink" href="#parameter-requires" 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>Set the systemd unit requires (Requires=) option.</p> +<p>Similar to wants, but declares a stronger requirement dependency.</p> +<p>Only with Podman 4.0.0 and above</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-restart_policy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-restart-policy"><strong>restart_policy</strong></p> +<a class="ansibleOptionLink" href="#parameter-restart_policy" 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>Restart policy of the service</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"no-restart"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-success"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-failure"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abnormal"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-watchdog"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abort"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"always"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-restart_sec"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-restart-sec"><strong>restart_sec</strong></p> +<a class="ansibleOptionLink" href="#parameter-restart_sec" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Configures the time to sleep before restarting a service (as configured with restart-policy).</p> +<p>Takes a value in seconds.</p> +<p>Only with Podman 4.0.0 and above</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-separator"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-separator"><strong>separator</strong></p> +<a class="ansibleOptionLink" href="#parameter-separator" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Systemd unit name separator between the name/id of a container/pod and the prefix.</p> +<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">-</span></code>.</p> +<p>Refer to podman-generate-systemd(1) man page for more information.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-start_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-start-timeout"><strong>start_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-start_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Override the default start timeout for the container with the given value in seconds.</p> +<p>Only with Podman 4.0.0 and above</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-stop-timeout"><strong>stop_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Override the default stop timeout for the container with the given value in seconds.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-use_names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-use-names"><strong>use_names</strong></p> +<a class="ansibleOptionLink" href="#parameter-use_names" 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>Use name of the containers for the start, stop, and description in the unit file.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-wants"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-wants"><strong>wants</strong></p> +<a class="ansibleOptionLink" href="#parameter-wants" 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>Add the systemd unit wants (<code class="docutils literal notranslate"><span class="pre">Wants=</span></code>) option, that this service is (weak) dependent on.</p> +<p>This option may be specified more than once.</p> +<p>This option does not influence the order in which services are started or stopped.</p> +<p>User-defined dependencies will be appended to the generated unit file</p> +<p>But any existing options such as needed or defined by default (e.g. <code class="docutils literal notranslate"><span class="pre">online.target</span></code>) will not be removed or overridden.</p> +<p>Only with Podman 4.0.0 and above</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="notes"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> <div class="admonition note"> <p class="admonition-title">Note</p> <ul class="simple"> -<li><p>You can store your systemd unit files in <code class="docutils literal notranslate"><span class="pre">/etc/systemd/user/</span></code> for system wide usage</p></li> -<li><p>Or you can store them in <code class="docutils literal notranslate"><span class="pre">~/.config/systemd/user/</span></code> for usage at a specific user</p></li> <li><p>If you indicate a pod, the systemd units for it and all its containers will be generated</p></li> <li><p>Create all your pods, containers and their dependencies before generating the systemd files</p></li> -<li><p>If a container or pod is already started before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon</span> <span class="pre">reload</span></code>, systemd will not see the container or pod as started</p></li> -<li><p>Stop your container or pod before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon</span> <span class="pre">reload</span></code>, then you can start them with <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">start</span> <span class="pre">my_container.service</span></code></p></li> +<li><p>If a container or pod is already started before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon-reload</span></code>, systemd will not see the container or pod as started</p></li> +<li><p>Stop your container or pod before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon-reload</span></code>, then you can start them with <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">start</span> <span class="pre">my_container.service</span></code></p></li> </ul> </div> -</div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id5">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="c1"># Exemple of creating a container and integrate it into systemd</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">A postgres container must exist, stopped</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">postgres_local</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/postgres:latest</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">stopped</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">Systemd unit files for postgres container must exist</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</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">postgres_local</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.config/systemd/user/</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">Postgres container must be started and enabled on systemd</span><span class="w"></span> -<span class="w"> </span><span class="nt">ansible.builtin.systemd</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">container-postgres_local</span><span class="w"></span> -<span class="w"> </span><span class="nt">daemon_reload</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</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">started</span><span class="w"></span> -<span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> - - -<span class="c1"># Generate the unit files, but store them on an Ansible variable</span><span class="w"></span> -<span class="c1"># instead of writting them on target host</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">Systemd unit files for postgres container must be generated</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</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">postgres_local</span><span class="w"></span> -<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span><span class="w"></span> - -<span class="c1"># Generate the unit files with environment variables sets</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">Systemd unit files for postgres container must be generated</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</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">postgres_local</span><span class="w"></span> -<span class="w"> </span><span class="nt">env</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">POSTGRES_USER</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_app</span><span class="w"></span> -<span class="w"> </span><span class="nt">POSTGRES_PASSWORD</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span><span class="w"></span> -<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span><span class="w"></span> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">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="c1"># Example of creating a container and systemd unit file.</span> +<span class="c1"># When using podman_generate_systemd with new:true then</span> +<span class="c1"># the container needs rm:true for idempotence.</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 postgres container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">postgres</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/postgres:latest</span> +<span class="w"> </span><span class="nt">rm</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="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">created</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">Generate systemd unit file for postgres container</span> +<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</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">postgres</span> +<span class="w"> </span><span class="nt">new</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="nt">no_header</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="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/systemd/system</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">Ensure postgres container is started and enabled</span> +<span class="w"> </span><span class="nt">ansible.builtin.systemd</span><span class="p">:</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">container-postgres</span> +<span class="w"> </span><span class="nt">daemon_reload</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="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span> +<span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> + + +<span class="c1"># Example of creating a container and integrate it into systemd</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">A postgres container must exist, stopped</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">postgres_local</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/postgres:latest</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">stopped</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">Systemd unit files for postgres container must exist</span> +<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</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">postgres_local</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.config/systemd/user/</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">Postgres container must be started and enabled on systemd</span> +<span class="w"> </span><span class="nt">ansible.builtin.systemd</span><span class="p">:</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">container-postgres_local</span> +<span class="w"> </span><span class="nt">daemon_reload</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="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span> +<span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> + + +<span class="c1"># Generate the unit files, but store them on an Ansible variable</span> +<span class="c1"># instead of writing them on target host</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">Systemd unit files for postgres container must be generated</span> +<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</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">postgres_local</span> +<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span> + +<span class="c1"># Generate the unit files with environment variables sets</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">Systemd unit files for postgres container must be generated</span> +<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</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">postgres_local</span> +<span class="w"> </span><span class="nt">env</span><span class="p">:</span> +<span class="w"> </span><span class="nt">POSTGRES_USER</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_app</span> +<span class="w"> </span><span class="nt">POSTGRES_PASSWORD</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span> +<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id6">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-podman_command"></div> - <b>podman_command</b> - <a class="ansibleOptionLink" href="#return-podman_command" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td>always</td> - <td> - <div>A copy of the podman command used to generate the systemd unit(s)</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">podman generate systemd my_webapp</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-systemd_units"></div> - <b>systemd_units</b> - <a class="ansibleOptionLink" href="#return-systemd_units" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>A copy of the generated systemd .service unit(s)</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'container-postgres_local': ' #Content of the systemd .servec unit for postgres_local container', 'pod-my_webapp': ' #Content of the systemd .servec unit for my_webapp pod'}</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-podman_command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-return-podman-command"><strong>podman_command</strong></p> +<a class="ansibleOptionLink" href="#return-podman_command" 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>A copy of the podman command used to generate the systemd unit(s)</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"podman</span> <span class="pre">generate</span> <span class="pre">systemd</span> <span class="pre">my_webapp"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-systemd_units"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-return-systemd-units"><strong>systemd_units</strong></p> +<a class="ansibleOptionLink" href="#return-systemd_units" 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>A copy of the generated systemd .service unit(s)</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"container-postgres_local":</span> <span class="pre">"</span> <span class="pre">#Content</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">systemd</span> <span class="pre">.servec</span> <span class="pre">unit</span> <span class="pre">for</span> <span class="pre">postgres_local</span> <span class="pre">container",</span> <span class="pre">"pod-my_webapp":</span> <span class="pre">"</span> <span class="pre">#Content</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">systemd</span> <span class="pre">.servec</span> <span class="pre">unit</span> <span class="pre">for</span> <span class="pre">my_webapp</span> <span class="pre">pod"}</span></code></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>SΓ©bastien Gendre (@CyberFox001)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -498,11 +404,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_export_module.html" title="previous chapter">containers.podman.podman_export module β Export a podman container</a></li> + <li>Next: <a href="podman_image_module.html" title="next chapter">containers.podman.podman_image module β Pull images for use by podman</a></li> </ul></li> </ul> </div> @@ -532,8 +475,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_generate_systemd_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_image_info_module.html b/ansible_collections/containers/podman/docs/podman_image_info_module.html index 0a4d8268d..be1f33883 100644 --- a/ansible_collections/containers/podman/docs/podman_image_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_image_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_image_info β Gather info about images using podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_image_info module β Gather info about images using podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_import module β Import Podman container from a tar file." href="podman_import_module.html" /> + <link rel="prev" title="containers.podman.podman_image module β Pull images for use by podman" href="podman_image_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,17 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-image-info-module"></span><div class="section" id="containers-podman-podman-image-info-gather-info-about-images-using-podman"> -<h1>containers.podman.podman_image_info β Gather info about images using podman<a class="headerlink" href="#containers-podman-podman-image-info-gather-info-about-images-using-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-image-info-module"></span><section id="containers-podman-podman-image-info-module-gather-info-about-images-using-podman"> +<h1>containers.podman.podman_image_info module β Gather info about images using podman<a class="headerlink" href="#containers-podman-podman-image-info-module-gather-info-about-images-using-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_image_info</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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> @@ -48,115 +51,102 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Gather info about images using <code class="docutils literal notranslate"><span class="pre">podman</span></code></p></li> </ul> -</div> -<div class="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 border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>List of tags or UID to gather info about. If no name is given return info about all images.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="notes"> -<h2><a class="toc-backref" href="#id3">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-image-info-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">list</span> / <span class="ansible-option-elements">elements=string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>List of tags or UID to gather info about. If no name is given return info about all images.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="notes"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">ΒΆ</a></h2> <div class="admonition note"> <p class="admonition-title">Note</p> <ul class="simple"> <li><p>Podman may required elevated privileges in order to run properly.</p></li> </ul> </div> -</div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Gather info for all images</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</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">Gather info on a specific image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image_info</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">nginx</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">Gather info on several images</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image_info</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="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span><span class="w"></span> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Gather info for all images</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</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">Gather info on a specific image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</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">nginx</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">Gather info on several images</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</span> +<span class="w"> </span><span class="nt">name</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-images"></div> - <b>images</b> - <a class="ansibleOptionLink" href="#return-images" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>info from all or specified images</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'Annotations': {}, 'Architecture': 'amd64', 'Author': '', 'Comment': 'from Bitnami with love', 'ContainerConfig': {'Cmd': ['nami', 'start', '--foreground', 'wildfly'], 'Entrypoint': ['/app-entrypoint.sh'], 'Env': ['PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'IMAGE_OS=debian-9', 'NAMI_VERSION=0.0.9-0', 'GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net hkp://p80.pool.sks-keyservers.net:80 keyserver.ubuntu.com hkp://keyserver.ubuntu.com:80 pgp.mit.edu', 'TINI_VERSION=v0.13.2', 'TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7', 'GOSU_VERSION=1.10', 'GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4', 'BITNAMI_IMAGE_VERSION=14.0.1-debian-9-r12', 'BITNAMI_APP_NAME=wildfly', 'WILDFLY_JAVA_HOME=', 'WILDFLY_JAVA_OPTS=', 'WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990', 'WILDFLY_PASSWORD=bitnami', 'WILDFLY_PUBLIC_CONSOLE=true', 'WILDFLY_SERVER_AJP_PORT_NUMBER=8009', 'WILDFLY_SERVER_HTTP_PORT_NUMBER=8080', 'WILDFLY_SERVER_INTERFACE=0.0.0.0', 'WILDFLY_USERNAME=user', 'WILDFLY_WILDFLY_HOME=/home/wildfly', 'WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false'], 'ExposedPorts': {'8080/tcp': {}, '9990/tcp': {}}, 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}}, 'Created': '2018-09-25T04:07:45.934395523Z', 'Digest': 'sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b', 'GraphDriver': {'Data': {'LowerDir': '/var/lib/containers/storage/overlay/a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f/diff:/var/lib/containers/storage/overlay/67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090/diff:/var/lib/containers/storage/overlay/7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca/diff:/var/lib/containers/storage/overlay/f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b/diff:/var/lib/containers/storage/overlay/1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7/diff:/var/lib/containers/storage/overlay/4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33/diff:/var/lib/containers/storage/overlay/6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632/diff:/var/lib/containers/storage/overlay/a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8/diff:/var/lib/containers/storage/overlay/537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f/diff:/var/lib/containers/storage/overlay/27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6e/diff:/var/lib/containers/storage/overlay/566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6/diff', 'MergedDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/merged', 'UpperDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/diff', 'WorkDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/work'}, 'Name': 'overlay'}, 'Id': 'bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0', 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}, 'ManifestType': 'application/vnd.docker.distribution.manifest.v1+prettyjws', 'Os': 'linux', 'Parent': '', 'RepoDigests': ['quay.io/bitnami/wildfly@sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b'], 'RepoTags': ['quay.io/bitnami/wildfly:latest'], 'RootFS': {'Layers': ['sha256:75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367', 'sha256:7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731', 'sha256:720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d', 'sha256:6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47', 'sha256:59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c', 'sha256:310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db', 'sha256:36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79e'], 'Type': 'layers'}, 'Size': 569919342, 'User': '', 'Version': '17.06.0-ce', 'VirtualSize': 569919342}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-images"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-info-module-return-images"><strong>images</strong></p> +<a class="ansibleOptionLink" href="#return-images" 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>info from all or specified images</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"from</span> <span class="pre">Bitnami</span> <span class="pre">with</span> <span class="pre">love",</span> <span class="pre">"ContainerConfig":</span> <span class="pre">{"Cmd":</span> <span class="pre">["nami",</span> <span class="pre">"start",</span> <span class="pre">"--foreground",</span> <span class="pre">"wildfly"],</span> <span class="pre">"Entrypoint":</span> <span class="pre">["/app-entrypoint.sh"],</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",</span> <span class="pre">"IMAGE_OS=debian-9",</span> <span class="pre">"NAMI_VERSION=0.0.9-0",</span> <span class="pre">"GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net</span> <span class="pre">hkp://p80.pool.sks-keyservers.net:80</span> <span class="pre">keyserver.ubuntu.com</span> <span class="pre">hkp://keyserver.ubuntu.com:80</span> <span class="pre">pgp.mit.edu",</span> <span class="pre">"TINI_VERSION=v0.13.2",</span> <span class="pre">"TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7",</span> <span class="pre">"GOSU_VERSION=1.10",</span> <span class="pre">"GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4",</span> <span class="pre">"BITNAMI_IMAGE_VERSION=14.0.1-debian-9-r12",</span> <span class="pre">"BITNAMI_APP_NAME=wildfly",</span> <span class="pre">"WILDFLY_JAVA_HOME=",</span> <span class="pre">"WILDFLY_JAVA_OPTS=",</span> <span class="pre">"WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990",</span> <span class="pre">"WILDFLY_PASSWORD=bitnami",</span> <span class="pre">"WILDFLY_PUBLIC_CONSOLE=true",</span> <span class="pre">"WILDFLY_SERVER_AJP_PORT_NUMBER=8009",</span> <span class="pre">"WILDFLY_SERVER_HTTP_PORT_NUMBER=8080",</span> <span class="pre">"WILDFLY_SERVER_INTERFACE=0.0.0.0",</span> <span class="pre">"WILDFLY_USERNAME=user",</span> <span class="pre">"WILDFLY_WILDFLY_HOME=/home/wildfly",</span> <span class="pre">"WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false"],</span> <span class="pre">"ExposedPorts":</span> <span class="pre">{"8080/tcp":</span> <span class="pre">{},</span> <span class="pre">"9990/tcp":</span> <span class="pre">{}},</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"}},</span> <span class="pre">"Created":</span> <span class="pre">"2018-09-25T04:07:45.934395523Z",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"LowerDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f/diff:/var/lib/containers/storage/overlay/67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090/diff:/var/lib/containers/storage/overlay/7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca/diff:/var/lib/containers/storage/overlay/f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b/diff:/var/lib/containers/storage/overlay/1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7/diff:/var/lib/containers/storage/overlay/4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33/diff:/var/lib/containers/storage/overlay/6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632/diff:/var/lib/containers/storage/overlay/a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8/diff:/var/lib/containers/storage/overlay/537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f/diff:/var/lib/containers/storage/overlay/27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6e/diff:/var/lib/containers/storage/overlay/566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6/diff",</span> <span class="pre">"MergedDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/merged",</span> <span class="pre">"UpperDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"Id":</span> <span class="pre">"bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0",</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"},</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.docker.distribution.manifest.v1+prettyjws",</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">["quay.io/bitnami/wildfly@sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b"],</span> <span class="pre">"RepoTags":</span> <span class="pre">["quay.io/bitnami/wildfly:latest"],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367",</span> <span class="pre">"sha256:7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731",</span> <span class="pre">"sha256:720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d",</span> <span class="pre">"sha256:6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47",</span> <span class="pre">"sha256:59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c",</span> <span class="pre">"sha256:310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db",</span> <span class="pre">"sha256:36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79e"],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">569919342,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"17.06.0-ce",</span> <span class="pre">"VirtualSize":</span> <span class="pre">569919342}]</span></code></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>Sam Doran (@samdoran)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -175,11 +165,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_image_module.html" title="previous chapter">containers.podman.podman_image module β Pull images for use by podman</a></li> + <li>Next: <a href="podman_import_module.html" title="next chapter">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> </ul></li> </ul> </div> @@ -209,8 +236,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_image_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_image_module.html b/ansible_collections/containers/podman/docs/podman_image_module.html index 48e2c5e1c..74c1dac80 100644 --- a/ansible_collections/containers/podman/docs/podman_image_module.html +++ b/ansible_collections/containers/podman/docs/podman_image_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_image β Pull images for use by podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_image module β Pull images for use by podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_image_info module β Gather info about images using podman" href="podman_image_info_module.html" /> + <link rel="prev" title="containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container" href="podman_generate_systemd_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,692 +33,505 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-image-module"></span><div class="section" id="containers-podman-podman-image-pull-images-for-use-by-podman"> -<h1>containers.podman.podman_image β Pull images for use by podman<a class="headerlink" href="#containers-podman-podman-image-pull-images-for-use-by-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-image-module"></span><section id="containers-podman-podman-image-module-pull-images-for-use-by-podman"> +<h1>containers.podman.podman_image module β Pull images for use by podman<a class="headerlink" href="#containers-podman-podman-image-module-pull-images-for-use-by-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_image</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Build, pull, or push images using Podman.</p></li> </ul> -</div> -<div class="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 border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="2">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-auth_file"></div> - <b>auth_file</b> - <a class="ansibleOptionLink" href="#parameter-auth_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to file containing authorization credentials to the remote registry.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: authfile</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-build"></div> - <b>build</b> - <a class="ansibleOptionLink" href="#parameter-build" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">{}</div> - </td> - <td> - <div>Arguments that control image build.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: build_args, buildargs</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/annotation"></div> - <b>annotation</b> - <a class="ansibleOptionLink" href="#parameter-build/annotation" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Dictionary of key=value pairs to add to the image. Only works with OCI images. Ignored for Docker containers.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/cache"></div> - <b>cache</b> - <a class="ansibleOptionLink" href="#parameter-build/cache" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Whether or not to use cached layers when building an image</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/extra_args"></div> - <b>extra_args</b> - <a class="ansibleOptionLink" href="#parameter-build/extra_args" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Extra args to pass to build, if executed. Does not idempotently check for new build args.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/file"></div> - <b>file</b> - <a class="ansibleOptionLink" href="#parameter-build/file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to the Containerfile if it is not in the build context directory.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/force_rm"></div> - <b>force_rm</b> - <a class="ansibleOptionLink" href="#parameter-build/force_rm" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Always remove intermediate containers after a build, even if the build is unsuccessful.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/format"></div> - <b>format</b> - <a class="ansibleOptionLink" href="#parameter-build/format" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>docker</li> - <li><div style="color: blue"><b>oci</b> ←</div></li> - </ul> - </td> - <td> - <div>Format of the built image.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/rm"></div> - <b>rm</b> - <a class="ansibleOptionLink" href="#parameter-build/rm" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Remove intermediate containers after a successful build</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-build/volume"></div> - <b>volume</b> - <a class="ansibleOptionLink" href="#parameter-build/volume" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Specify multiple volume / mount options to mount one or more mounts to a container.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ca_cert_dir"></div> - <b>ca_cert_dir</b> - <a class="ansibleOptionLink" href="#parameter-ca_cert_dir" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to directory containing TLS certificates and keys to use.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code>.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-force"></div> - <b>force</b> - <a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Whether or not to force push or pull an image.</div> - <div>When building, force the build even if the image already exists.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Name of the image to pull, push, or delete. It may contain a tag using the format <code>image:tag</code>.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-password"></div> - <b>password</b> - <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Password to use when authenticating to remote registries.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-path"></div> - <b>path</b> - <a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to the build context directory.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pull"></div> - <b>pull</b> - <a class="ansibleOptionLink" href="#parameter-pull" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Whether or not to pull the image.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-push"></div> - <b>push</b> - <a class="ansibleOptionLink" href="#parameter-push" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Whether or not to push an image.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-push_args"></div> - <b>push_args</b> - <a class="ansibleOptionLink" href="#parameter-push_args" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">{}</div> - </td> - <td> - <div>Arguments that control pushing images.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/compress"></div> - <b>compress</b> - <a class="ansibleOptionLink" href="#parameter-push_args/compress" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Compress tarball image layers when pushing to a directory using the 'dir' transport.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/dest"></div> - <b>dest</b> - <a class="ansibleOptionLink" href="#parameter-push_args/dest" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path or URL where image will be pushed.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: destination</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/format"></div> - <b>format</b> - <a class="ansibleOptionLink" href="#parameter-push_args/format" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>oci</li> - <li>v2s1</li> - <li>v2s2</li> - </ul> - </td> - <td> - <div>Manifest type to use when pushing an image using the 'dir' transport (default is manifest type of source).</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/remove_signatures"></div> - <b>remove_signatures</b> - <a class="ansibleOptionLink" href="#parameter-push_args/remove_signatures" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Discard any pre-existing signatures in the image</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/sign_by"></div> - <b>sign_by</b> - <a class="ansibleOptionLink" href="#parameter-push_args/sign_by" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to a key file to use to sign the image.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-push_args/transport"></div> - <b>transport</b> - <a class="ansibleOptionLink" href="#parameter-push_args/transport" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>dir</li> - <li>docker-archive</li> - <li>docker-daemon</li> - <li>oci-archive</li> - <li>ostree</li> - </ul> - </td> - <td> - <div>Transport to use when pushing in image. If no transport is set, will attempt to push to a remote registry.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - <li>build</li> - </ul> - </td> - <td> - <div>Whether an image should be present, absent, or built.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-tag"></div> - <b>tag</b> - <a class="ansibleOptionLink" href="#parameter-tag" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"latest"</div> - </td> - <td> - <div>Tag of the image to pull, push, or delete.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-username"></div> - <b>username</b> - <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>username to use when authenticating to remote registries.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div> - <b>validate_certs</b> - <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Require HTTPS and validate certificates when pulling or pushing. Also used during build if a pull or push is necessary.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: tlsverify, tls_verify</div> - </td> - </tr> - </table> -<br/></div> -<div class="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">Pull an image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">quay.io/bitnami/wildfly</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">Remove an image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">quay.io/bitnami/wildfly</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> - -<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">Remove an image with image id</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">0e901e68141f</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> - -<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">Pull a specific version of an image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">redis</span><span class="w"></span> -<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</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">Build a basic OCI image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</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">Build a basic OCI image with advanced parameters</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span><span class="w"></span> -<span class="w"> </span><span class="nt">build</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">cache</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">no</span><span class="w"></span> -<span class="w"> </span><span class="nt">force_rm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci</span><span class="w"></span> -<span class="w"> </span><span class="nt">annotation</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">function</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">proxy</span><span class="w"></span> -<span class="w"> </span><span class="nt">info</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Load balancer for my cool app</span><span class="w"></span> -<span class="w"> </span><span class="nt">extra_args</span><span class="p">:</span><span class="w"> </span><span class="s">"--build-arg</span><span class="nv"> </span><span class="s">KEY=value"</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">Build a Docker formatted image</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span><span class="w"></span> -<span class="w"> </span><span class="nt">build</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker</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">Build and push an image using existing credentials</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span><span class="w"></span> -<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image using an auth file</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image using username and password</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bugs</span><span class="w"></span> -<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">vault_registry_password</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image to multiple registries</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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="s">"</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span><span class="w"></span> -<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">loop</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme/nginx</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme/nginx</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">Build and push an image to multiple registries with separate parameters</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_image</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="s">"</span><span class="cp">{{</span> <span class="nv">item.name</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.tag</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span><span class="w"></span> -<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.dest</span> <span class="cp">}}</span><span class="s">"</span><span class="w"></span> -<span class="w"> </span><span class="nt">loop</span><span class="p">:</span><span class="w"></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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</span><span class="w"></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">nginx</span><span class="w"></span> -<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-arch"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-arch"><strong>arch</strong></p> +<a class="ansibleOptionLink" href="#parameter-arch" 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>CPU architecture for the container image</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-auth_file"></div> +<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-authfile"><span id="ansible-collections-containers-podman-podman-image-module-parameter-auth-file"></span><strong>auth_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-auth_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: authfile</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to file containing authorization credentials to the remote registry.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build"></span><strong>build</strong></p> +<a class="ansibleOptionLink" href="#parameter-build" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: build_args, buildargs</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Arguments that control image build.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/annotation"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/annotation"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/annotation"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-annotation"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-annotation"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-annotation"></span><strong>annotation</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/annotation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Dictionary of key=value pairs to add to the image. Only works with OCI images. Ignored for Docker containers.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/cache"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/cache"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/cache"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-cache"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-cache"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-cache"></span><strong>cache</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/cache" 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-indent-desc"></div><div class="ansible-option-cell"><p>Whether or not to use cached layers when building an image</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/extra_args"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/extra_args"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-extra-args"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-extra-args"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-extra-args"></span><strong>extra_args</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/extra_args" 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-indent-desc"></div><div class="ansible-option-cell"><p>Extra args to pass to build, if executed. Does not idempotently check for new build args.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/file"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/file"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-file"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-file"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-file"></span><strong>file</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Path to the Containerfile if it is not in the build context directory.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/force_rm"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/force_rm"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/force_rm"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-force-rm"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-force-rm"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-force-rm"></span><strong>force_rm</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/force_rm" 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-indent-desc"></div><div class="ansible-option-cell"><p>Always remove intermediate containers after a build, even if the build is unsuccessful.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/format"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/format"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-format"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-format"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-format"></span><strong>format</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/format" 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-indent-desc"></div><div class="ansible-option-cell"><p>Format of the built image.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker"</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"oci"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/rm"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/rm"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/rm"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-rm"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-rm"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-rm"></span><strong>rm</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/rm" 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-indent-desc"></div><div class="ansible-option-cell"><p>Remove intermediate containers after a successful build</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/target"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/target"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/target"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-target"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-target"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-target"></span><strong>target</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/target" 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-indent-desc"></div><div class="ansible-option-cell"><p>Specify the target build stage to build.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build/volume"></div> +<div class="ansibleOptionAnchor" id="parameter-build_args/volume"></div> +<div class="ansibleOptionAnchor" id="parameter-buildargs/volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-volume"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-volume"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-volume"></span><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-build/volume" 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-indent-desc"></div><div class="ansible-option-cell"><p>Specify multiple volume / mount options to mount one or more mounts to a container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ca_cert_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-ca-cert-dir"><strong>ca_cert_dir</strong></p> +<a class="ansibleOptionLink" href="#parameter-ca_cert_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to directory containing TLS certificates and keys to use.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code>.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Whether or not to force push or pull an image.</p> +<p>When building, force the build even if the image already exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-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 image to pull, push, or delete. It may contain a tag using the format <code class="docutils literal notranslate"><span class="pre">image:tag</span></code>.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-password"><strong>password</strong></p> +<a class="ansibleOptionLink" href="#parameter-password" 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>Password to use when authenticating to remote registries.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-path"><strong>path</strong></p> +<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to the build context directory.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pull"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-pull"><strong>pull</strong></p> +<a class="ansibleOptionLink" href="#parameter-pull" 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>Whether or not to pull the image.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push"><strong>push</strong></p> +<a class="ansibleOptionLink" href="#parameter-push" 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>Whether or not to push an image.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args"><strong>push_args</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Arguments that control pushing images.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/compress"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-compress"><strong>compress</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/compress" 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-indent-desc"></div><div class="ansible-option-cell"><p>Compress tarball image layers when pushing to a directory using the βdirβ transport.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/dest"></div> +<div class="ansibleOptionAnchor" id="parameter-push_args/destination"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-destination"><span id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-dest"></span><strong>dest</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: destination</span></p> +<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>Path or URL where image will be pushed.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-format"><strong>format</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/format" 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-indent-desc"></div><div class="ansible-option-cell"><p>Manifest type to use when pushing an image using the βdirβ transport (default is manifest type of source).</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"v2s1"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"v2s2"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/remove_signatures"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-remove-signatures"><strong>remove_signatures</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/remove_signatures" 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-indent-desc"></div><div class="ansible-option-cell"><p>Discard any pre-existing signatures in the image</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/sign_by"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-sign-by"><strong>sign_by</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/sign_by" 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-indent-desc"></div><div class="ansible-option-cell"><p>Path to a key file to use to sign the image.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-push_args/transport"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-transport"><strong>transport</strong></p> +<a class="ansibleOptionLink" href="#parameter-push_args/transport" 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-indent-desc"></div><div class="ansible-option-cell"><p>Transport to use when pushing in image. If no transport is set, will attempt to push to a remote registry.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dir"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-archive"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-daemon"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-archive"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ostree"</span></code></p></li> +</ul> +</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-containers-podman-podman-image-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>Whether an image should be present, absent, or built.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"build"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tag"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-tag"><strong>tag</strong></p> +<a class="ansibleOptionLink" href="#parameter-tag" 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>Tag of the image to pull, push, or delete.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"latest"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-username"><strong>username</strong></p> +<a class="ansibleOptionLink" href="#parameter-username" 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>username to use when authenticating to remote registries.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div> +<div class="ansibleOptionAnchor" id="parameter-tlsverify"></div> +<div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-validate-certs"><span id="ansible-collections-containers-podman-podman-image-module-parameter-tlsverify"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-tls-verify"></span><strong>validate_certs</strong></p> +<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: tlsverify, tls_verify</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Require HTTPS and validate certificates when pulling or pushing. Also used during build if a pull or push is necessary.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">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">Pull an image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">quay.io/bitnami/wildfly</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">Remove an image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">quay.io/bitnami/wildfly</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="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">Remove an image with image id</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">0e901e68141f</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="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">Pull a specific version of an image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">redis</span> +<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</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">Build a basic OCI image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</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">Build a basic OCI image with advanced parameters</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span> +<span class="w"> </span><span class="nt">build</span><span class="p">:</span> +<span class="w"> </span><span class="nt">cache</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">no</span> +<span class="w"> </span><span class="nt">force_rm</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="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci</span> +<span class="w"> </span><span class="nt">annotation</span><span class="p">:</span> +<span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span> +<span class="w"> </span><span class="nt">function</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">proxy</span> +<span class="w"> </span><span class="nt">info</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Load balancer for my cool app</span> +<span class="w"> </span><span class="nt">extra_args</span><span class="p">:</span><span class="w"> </span><span class="s">"--build-arg</span><span class="nv"> </span><span class="s">KEY=value"</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">Build a Docker formatted image</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span> +<span class="w"> </span><span class="nt">build</span><span class="p">:</span> +<span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker</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">Build and push an image using existing credentials</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span> +<span class="w"> </span><span class="nt">push</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="nt">push_args</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image using an auth file</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">push</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="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span> +<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image using username and password</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">push</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="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bugs</span> +<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">vault_registry_password</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</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">Build and push an image to multiple registries</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span> +<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span> +<span class="w"> </span><span class="nt">push</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="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span> +<span class="w"> </span><span class="nt">loop</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme/nginx</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme/nginx</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">Build and push an image to multiple registries with separate parameters</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span> +<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.name</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.tag</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span> +<span class="w"> </span><span class="nt">push</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="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span> +<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.dest</span> <span class="cp">}}</span><span class="s">"</span> +<span class="w"> </span><span class="nt">loop</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</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">nginx</span> +<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</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">Pull an image for a specific CPU architecture</span> +<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</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">nginx</span> +<span class="w"> </span><span class="nt">arch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">amd64</span> </pre></div> </div> -</div> -<div class="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> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#return-image" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>success</td> - <td> - <div>Image inspection results for the image that was pulled, pushed, or built.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'Annotations': {}, 'Architecture': 'amd64', 'Author': '', 'Comment': 'from Bitnami with love', 'ContainerConfig': {'Cmd': ['/run.sh'], 'Entrypoint': ['/app-entrypoint.sh'], 'Env': ['PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'IMAGE_OS=debian-9', 'NAMI_VERSION=1.0.0-1', 'GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net', 'TINI_VERSION=v0.13.2', 'TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7', 'GOSU_VERSION=1.10', 'GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4', 'BITNAMI_IMAGE_VERSION=16.0.0-debian-9-r27', 'BITNAMI_PKG_CHMOD=-R g+rwX', 'BITNAMI_PKG_EXTRA_DIRS=/home/wildfly', 'HOME=/', 'BITNAMI_APP_NAME=wildfly', 'NAMI_PREFIX=/.nami', 'WILDFLY_HOME=/home/wildfly', 'WILDFLY_JAVA_HOME=', 'WILDFLY_JAVA_OPTS=', 'WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990', 'WILDFLY_PASSWORD=bitnami', 'WILDFLY_PUBLIC_CONSOLE=true', 'WILDFLY_SERVER_AJP_PORT_NUMBER=8009', 'WILDFLY_SERVER_HTTP_PORT_NUMBER=8080', 'WILDFLY_SERVER_INTERFACE=0.0.0.0', 'WILDFLY_USERNAME=user', 'WILDFLY_WILDFLY_HOME=/home/wildfly', 'WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false'], 'ExposedPorts': {'8080/tcp': {}, '9990/tcp': {}}, 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}, 'User': '1001'}, 'Created': '2019-04-10T05:48:03.553887623Z', 'Digest': 'sha256:5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b', 'GraphDriver': {'Data': {'LowerDir': '/var/lib/containers/storage/overlay/142c1beadf1bb09fbd929465ec98c9dca3256638220450efb4214727d0d0680e/diff:/var/lib/containers/s', 'MergedDir': '/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/merged', 'UpperDir': '/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/diff', 'WorkDir': '/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/work'}, 'Name': 'overlay'}, 'History': [{'comment': 'from Bitnami with love', 'created': '2019-04-09T22:27:40.659377677Z'}, {'created': '2019-04-09T22:38:53.86336555Z', 'created_by': '/bin/sh -c #(nop) LABEL maintainer=Bitnami <containers@bitnami.com>', 'empty_layer': True}, {'created': '2019-04-09T22:38:54.022778765Z', 'created_by': '/bin/sh -c #(nop) ENV IMAGE_OS=debian-9', 'empty_layer': True}], 'Id': 'ace34da54e4af2145e1ad277005adb235a214e4dfe1114c2db9ab460b840f785', 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}, 'ManifestType': 'application/vnd.docker.distribution.manifest.v1+prettyjws', 'Os': 'linux', 'Parent': '', 'RepoDigests': ['quay.io/bitnami/wildfly@sha256:5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b'], 'RepoTags': ['quay.io/bitnami/wildfly:latest'], 'RootFS': {'Layers': ['', '', '', '', '', '', '', '', '', '', '', ''], 'Type': 'layers'}, 'Size': 466180019, 'User': '1001', 'Version': '18.09.3', 'VirtualSize': 466180019}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-return-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#return-image" 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>Image inspection results for the image that was pulled, pushed, or built.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"from</span> <span class="pre">Bitnami</span> <span class="pre">with</span> <span class="pre">love",</span> <span class="pre">"ContainerConfig":</span> <span class="pre">{"Cmd":</span> <span class="pre">["/run.sh"],</span> <span class="pre">"Entrypoint":</span> <span class="pre">["/app-entrypoint.sh"],</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",</span> <span class="pre">"IMAGE_OS=debian-9",</span> <span class="pre">"NAMI_VERSION=1.0.0-1",</span> <span class="pre">"GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net",</span> <span class="pre">"TINI_VERSION=v0.13.2",</span> <span class="pre">"TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7",</span> <span class="pre">"GOSU_VERSION=1.10",</span> <span class="pre">"GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4",</span> <span class="pre">"BITNAMI_IMAGE_VERSION=16.0.0-debian-9-r27",</span> <span class="pre">"BITNAMI_PKG_CHMOD=-R</span> <span class="pre">g+rwX",</span> <span class="pre">"BITNAMI_PKG_EXTRA_DIRS=/home/wildfly",</span> <span class="pre">"HOME=/",</span> <span class="pre">"BITNAMI_APP_NAME=wildfly",</span> <span class="pre">"NAMI_PREFIX=/.nami",</span> <span class="pre">"WILDFLY_HOME=/home/wildfly",</span> <span class="pre">"WILDFLY_JAVA_HOME=",</span> <span class="pre">"WILDFLY_JAVA_OPTS=",</span> <span class="pre">"WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990",</span> <span class="pre">"WILDFLY_PASSWORD=bitnami",</span> <span class="pre">"WILDFLY_PUBLIC_CONSOLE=true",</span> <span class="pre">"WILDFLY_SERVER_AJP_PORT_NUMBER=8009",</span> <span class="pre">"WILDFLY_SERVER_HTTP_PORT_NUMBER=8080",</span> <span class="pre">"WILDFLY_SERVER_INTERFACE=0.0.0.0",</span> <span class="pre">"WILDFLY_USERNAME=user",</span> <span class="pre">"WILDFLY_WILDFLY_HOME=/home/wildfly",</span> <span class="pre">"WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false"],</span> <span class="pre">"ExposedPorts":</span> <span class="pre">{"8080/tcp":</span> <span class="pre">{},</span> <span class="pre">"9990/tcp":</span> <span class="pre">{}},</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"},</span> <span class="pre">"User":</span> <span class="pre">"1001"},</span> <span class="pre">"Created":</span> <span class="pre">"2019-04-10T05:48:03.553887623Z",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"LowerDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/142c1beadf1bb09fbd929465ec98c9dca3256638220450efb4214727d0d0680e/diff:/var/lib/containers/s",</span> <span class="pre">"MergedDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/merged",</span> <span class="pre">"UpperDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea/work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"History":</span> <span class="pre">[{"comment":</span> <span class="pre">"from</span> <span class="pre">Bitnami</span> <span class="pre">with</span> <span class="pre">love",</span> <span class="pre">"created":</span> <span class="pre">"2019-04-09T22:27:40.659377677Z"},</span> <span class="pre">{"created":</span> <span class="pre">"2019-04-09T22:38:53.86336555Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span>  <span class="pre">LABEL</span> <span class="pre">maintainer=Bitnami</span> <span class="pre"><containers@bitnami.com>",</span> <span class="pre">"empty_layer":</span> <span class="pre">true},</span> <span class="pre">{"created":</span> <span class="pre">"2019-04-09T22:38:54.022778765Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span>  <span class="pre">ENV</span> <span class="pre">IMAGE_OS=debian-9",</span> <span class="pre">"empty_layer":</span> <span class="pre">true}],</span> <span class="pre">"Id":</span> <span class="pre">"ace34da54e4af2145e1ad277005adb235a214e4dfe1114c2db9ab460b840f785",</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"},</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.docker.distribution.manifest.v1+prettyjws",</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">["quay.io/bitnami/wildfly@sha256:5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b"],</span> <span class="pre">"RepoTags":</span> <span class="pre">["quay.io/bitnami/wildfly:latest"],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">"",</span> <span class="pre">""],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">466180019,</span> <span class="pre">"User":</span> <span class="pre">"1001",</span> <span class="pre">"Version":</span> <span class="pre">"18.09.3",</span> <span class="pre">"VirtualSize":</span> <span class="pre">466180019}]</span></code></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>Sam Doran (@samdoran)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -736,11 +550,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_generate_systemd_module.html" title="previous chapter">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> + <li>Next: <a href="podman_image_info_module.html" title="next chapter">containers.podman.podman_image_info module β Gather info about images using podman</a></li> </ul></li> </ul> </div> @@ -770,8 +621,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_image_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_import_module.html b/ansible_collections/containers/podman/docs/podman_import_module.html index 0d502c249..e1dea2279 100644 --- a/ansible_collections/containers/podman/docs/podman_import_module.html +++ b/ansible_collections/containers/podman/docs/podman_import_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_import β Import Podman container from a tar file. — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_import module β Import Podman container from a tar file. — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_load module β Load image from a tar file." href="podman_load_module.html" /> + <link rel="prev" title="containers.podman.podman_image_info module β Gather info about images using podman" href="podman_image_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,19 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-import-module"></span><div class="section" id="containers-podman-podman-import-import-podman-container-from-a-tar-file"> -<h1>containers.podman.podman_import β Import Podman container from a tar file.<a class="headerlink" href="#containers-podman-podman-import-import-podman-container-from-a-tar-file" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-import-module"></span><section id="containers-podman-podman-import-module-import-podman-container-from-a-tar-file"> +<h1>containers.podman.podman_import module β Import Podman container from a tar file.<a class="headerlink" href="#containers-podman-podman-import-module-import-podman-container-from-a-tar-file" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-import-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_import</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -48,138 +53,119 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>podman import imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) and saves it as a filesystem image.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-import-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-change"></div> - <b>change</b> - <a class="ansibleOptionLink" href="#parameter-change" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td> - </td> - <td> - <div>Set changes as list of key-value pairs, see example.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-commit_message"></div> - <b>commit_message</b> - <a class="ansibleOptionLink" href="#parameter-commit_message" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set commit message for imported image</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-src"></div> - <b>src</b> - <a class="ansibleOptionLink" href="#parameter-src" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Path to image file to load.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_import</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span><span class="w"></span> -<span class="w"> </span><span class="nt">change</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"CMD"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/bin/bash</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"User"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">root</span><span class="w"></span> -<span class="w"> </span><span class="nt">commit_message</span><span class="p">:</span><span class="w"> </span><span class="s">"Importing</span><span class="nv"> </span><span class="s">image"</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-change"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-change"><strong>change</strong></p> +<a class="ansibleOptionLink" href="#parameter-change" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set changes as list of key-value pairs, see example.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-commit_message"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-commit-message"><strong>commit_message</strong></p> +<a class="ansibleOptionLink" href="#parameter-commit_message" 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 commit message for imported image</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-src"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-src"><strong>src</strong></p> +<a class="ansibleOptionLink" href="#parameter-src" 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>Path to image file to load.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-volume"><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume" 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>Volume to import, cannot be used with change and commit_message</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_import</span><span class="p">:</span> +<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span> +<span class="w"> </span><span class="nt">change</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"CMD"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/bin/bash</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"User"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">root</span> +<span class="w"> </span><span class="nt">commit_message</span><span class="p">:</span><span class="w"> </span><span class="s">"Importing</span><span class="nv"> </span><span class="s">image"</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_import</span><span class="p">:</span> +<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span> +<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myvolume</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#return-image" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>info from loaded image</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'Annotations': {}, 'Architecture': 'amd64', 'Author': '', 'Comment': 'imported from tarball', 'Config': {}, 'Created': '2021-09-07T04:45:38.749977105+03:00', 'Digest': 'sha256:8730c75be86a718929a658db4663d487e562d66762....', 'GraphDriver': {'Data': {'UpperDir': '/home/...34/diff', 'WorkDir': '/home/.../work'}, 'Name': 'overlay'}, 'History': [{'comment': 'imported from tarball', 'created': '2021-09-07T04:45:38.749977105+03:00', 'created_by': '/bin/sh -c #(nop) ADD file:091... in /'}], 'Id': 'cbc6d73c4d232db6e8441df96af81855f62c74157b5db80a1d5...', 'Labels': None, 'ManifestType': 'application/vnd.oci.image.manifest.v1+json', 'NamesHistory': None, 'Os': 'linux', 'Parent': '', 'RepoDigests': [], 'RepoTags': [], 'RootFS': {'Layers': ['sha256:....'], 'Type': 'layers'}, 'Size': 5882449, 'User': '', 'Version': '', 'VirtualSize': 5882449}</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-return-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#return-image" 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>info from loaded image</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"imported</span> <span class="pre">from</span> <span class="pre">tarball",</span> <span class="pre">"Config":</span> <span class="pre">{},</span> <span class="pre">"Created":</span> <span class="pre">"2021-09-07T04:45:38.749977105+03:00",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:8730c75be86a718929a658db4663d487e562d66762....",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"UpperDir":</span> <span class="pre">"/home/...34/diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/home/.../work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"History":</span> <span class="pre">[{"comment":</span> <span class="pre">"imported</span> <span class="pre">from</span> <span class="pre">tarball",</span> <span class="pre">"created":</span> <span class="pre">"2021-09-07T04:45:38.749977105+03:00",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span> <span class="pre">ADD</span> <span class="pre">file:091...</span> <span class="pre">in</span> <span class="pre">/"}],</span> <span class="pre">"Id":</span> <span class="pre">"cbc6d73c4d232db6e8441df96af81855f62c74157b5db80a1d5...",</span> <span class="pre">"Labels":</span> <span class="pre">null,</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.oci.image.manifest.v1+json",</span> <span class="pre">"NamesHistory":</span> <span class="pre">null,</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">[],</span> <span class="pre">"RepoTags":</span> <span class="pre">[],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:...."],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">5882449,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"",</span> <span class="pre">"VirtualSize":</span> <span class="pre">5882449}</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -198,11 +184,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_image_info_module.html" title="previous chapter">containers.podman.podman_image_info module β Gather info about images using podman</a></li> + <li>Next: <a href="podman_load_module.html" title="next chapter">containers.podman.podman_load module β Load image from a tar file.</a></li> </ul></li> </ul> </div> @@ -232,8 +255,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_import_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_load_module.html b/ansible_collections/containers/podman/docs/podman_load_module.html index c7834c2f2..a81014f03 100644 --- a/ansible_collections/containers/podman/docs/podman_load_module.html +++ b/ansible_collections/containers/podman/docs/podman_load_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_load β Load image from a tar file. — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_load module β Load image from a tar file. — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_login module β Login to a container registry using podman" href="podman_login_module.html" /> + <link rel="prev" title="containers.podman.podman_import module β Import Podman container from a tar file." href="podman_import_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,19 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-load-module"></span><div class="section" id="containers-podman-podman-load-load-image-from-a-tar-file"> -<h1>containers.podman.podman_load β Load image from a tar file.<a class="headerlink" href="#containers-podman-podman-load-load-image-from-a-tar-file" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-load-module"></span><section id="containers-podman-podman-load-module-load-image-from-a-tar-file"> +<h1>containers.podman.podman_load module β Load image from a tar file.<a class="headerlink" href="#containers-podman-podman-load-module-load-image-from-a-tar-file" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-load-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_load</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -48,105 +53,93 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>podman load loads an image from either an oci-archive or a docker-archive stored on the local machine into container storage. podman load is used for loading from the archive generated by podman save, that includes the image parent layers.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-load-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-input"></div> - <b>input</b> - <a class="ansibleOptionLink" href="#parameter-input" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Path to image file to load.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: path</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_load</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">input</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-load-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-input"></div> +<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-load-module-parameter-path"><span id="ansible-collections-containers-podman-podman-load-module-parameter-input"></span><strong>input</strong></p> +<a class="ansibleOptionLink" href="#parameter-input" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: path</span></p> +<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>Path to image file to load.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_load</span><span class="p">:</span> +<span class="w"> </span><span class="nt">input</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#return-image" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>info from loaded image</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'Annotations': {}, 'Architecture': 'amd64', 'Author': '', 'Comment': 'from Bitnami with love', 'ContainerConfig': {'Cmd': ['nami', 'start', '--foreground', 'wildfly'], 'Entrypoint': ['/app-entrypoint.sh'], 'Env': ['PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'IMAGE_OS=debian-9', 'NAMI_VERSION=0.0.9-0', 'GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net hkp://p80.pool.sks-keyservers.net:80 keyserver.ubuntu.com hkp://keyserver.ubuntu.com:80 pgp.mit.edu', 'TINI_VERSION=v0.13.2', 'TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7', 'GOSU_VERSION=1.10', 'GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4', 'BITNAMI_IMAGE_VERSION=14.0.1-debian-9-r12', 'BITNAMI_APP_NAME=wildfly', 'WILDFLY_JAVA_HOME=', 'WILDFLY_JAVA_OPTS=', 'WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990', 'WILDFLY_PASSWORD=bitnami', 'WILDFLY_PUBLIC_CONSOLE=true', 'WILDFLY_SERVER_AJP_PORT_NUMBER=8009', 'WILDFLY_SERVER_HTTP_PORT_NUMBER=8080', 'WILDFLY_SERVER_INTERFACE=0.0.0.0', 'WILDFLY_USERNAME=user', 'WILDFLY_WILDFLY_HOME=/home/wildfly', 'WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false'], 'ExposedPorts': {'8080/tcp': {}, '9990/tcp': {}}, 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}}, 'Created': '2018-09-25T04:07:45.934395523Z', 'Digest': 'sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b', 'GraphDriver': {'Data': {'LowerDir': '/var/lib/containers/storage/overlay/a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f/diff:/var/lib/containers/storage/overlay/67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090/diff:/var/lib/containers/storage/overlay/7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca/diff:/var/lib/containers/storage/overlay/f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b/diff:/var/lib/containers/storage/overlay/1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7/diff:/var/lib/containers/storage/overlay/4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33/diff:/var/lib/containers/storage/overlay/6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632/diff:/var/lib/containers/storage/overlay/a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8/diff:/var/lib/containers/storage/overlay/537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f/diff:/var/lib/containers/storage/overlay/27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6e/diff:/var/lib/containers/storage/overlay/566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6/diff', 'MergedDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/merged', 'UpperDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/diff', 'WorkDir': '/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/work'}, 'Name': 'overlay'}, 'Id': 'bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0', 'Labels': {'maintainer': 'Bitnami <containers@bitnami.com>'}, 'ManifestType': 'application/vnd.docker.distribution.manifest.v1+prettyjws', 'Os': 'linux', 'Parent': '', 'RepoDigests': ['quay.io/bitnami/wildfly@sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b'], 'RepoTags': ['quay.io/bitnami/wildfly:latest'], 'RootFS': {'Layers': ['sha256:75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367', 'sha256:7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731', 'sha256:720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d', 'sha256:6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47', 'sha256:59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c', 'sha256:310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db', 'sha256:36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79e'], 'Type': 'layers'}, 'Size': 569919342, 'User': '', 'Version': '17.06.0-ce', 'VirtualSize': 569919342}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-load-module-return-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#return-image" 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>info from loaded image</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"from</span> <span class="pre">Bitnami</span> <span class="pre">with</span> <span class="pre">love",</span> <span class="pre">"ContainerConfig":</span> <span class="pre">{"Cmd":</span> <span class="pre">["nami",</span> <span class="pre">"start",</span> <span class="pre">"--foreground",</span> <span class="pre">"wildfly"],</span> <span class="pre">"Entrypoint":</span> <span class="pre">["/app-entrypoint.sh"],</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/opt/bitnami/java/bin:/opt/bitnami/wildfly/bin:/opt/bitnami/nami/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",</span> <span class="pre">"IMAGE_OS=debian-9",</span> <span class="pre">"NAMI_VERSION=0.0.9-0",</span> <span class="pre">"GPG_KEY_SERVERS_LIST=ha.pool.sks-keyservers.net</span> <span class="pre">hkp://p80.pool.sks-keyservers.net:80</span> <span class="pre">keyserver.ubuntu.com</span> <span class="pre">hkp://keyserver.ubuntu.com:80</span> <span class="pre">pgp.mit.edu",</span> <span class="pre">"TINI_VERSION=v0.13.2",</span> <span class="pre">"TINI_GPG_KEY=595E85A6B1B4779EA4DAAEC70B588DFF0527A9B7",</span> <span class="pre">"GOSU_VERSION=1.10",</span> <span class="pre">"GOSU_GPG_KEY=B42F6819007F00F88E364FD4036A9C25BF357DD4",</span> <span class="pre">"BITNAMI_IMAGE_VERSION=14.0.1-debian-9-r12",</span> <span class="pre">"BITNAMI_APP_NAME=wildfly",</span> <span class="pre">"WILDFLY_JAVA_HOME=",</span> <span class="pre">"WILDFLY_JAVA_OPTS=",</span> <span class="pre">"WILDFLY_MANAGEMENT_HTTP_PORT_NUMBER=9990",</span> <span class="pre">"WILDFLY_PASSWORD=bitnami",</span> <span class="pre">"WILDFLY_PUBLIC_CONSOLE=true",</span> <span class="pre">"WILDFLY_SERVER_AJP_PORT_NUMBER=8009",</span> <span class="pre">"WILDFLY_SERVER_HTTP_PORT_NUMBER=8080",</span> <span class="pre">"WILDFLY_SERVER_INTERFACE=0.0.0.0",</span> <span class="pre">"WILDFLY_USERNAME=user",</span> <span class="pre">"WILDFLY_WILDFLY_HOME=/home/wildfly",</span> <span class="pre">"WILDFLY_WILDFLY_OPTS=-Dwildfly.as.deployment.ondemand=false"],</span> <span class="pre">"ExposedPorts":</span> <span class="pre">{"8080/tcp":</span> <span class="pre">{},</span> <span class="pre">"9990/tcp":</span> <span class="pre">{}},</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"}},</span> <span class="pre">"Created":</span> <span class="pre">"2018-09-25T04:07:45.934395523Z",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"LowerDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f/diff:/var/lib/containers/storage/overlay/67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090/diff:/var/lib/containers/storage/overlay/7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca/diff:/var/lib/containers/storage/overlay/f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b/diff:/var/lib/containers/storage/overlay/1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7/diff:/var/lib/containers/storage/overlay/4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33/diff:/var/lib/containers/storage/overlay/6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632/diff:/var/lib/containers/storage/overlay/a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8/diff:/var/lib/containers/storage/overlay/537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f/diff:/var/lib/containers/storage/overlay/27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6e/diff:/var/lib/containers/storage/overlay/566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6/diff",</span> <span class="pre">"MergedDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/merged",</span> <span class="pre">"UpperDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/var/lib/containers/storage/overlay/72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca/work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"Id":</span> <span class="pre">"bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0",</span> <span class="pre">"Labels":</span> <span class="pre">{"maintainer":</span> <span class="pre">"Bitnami</span> <span class="pre"><containers@bitnami.com>"},</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.docker.distribution.manifest.v1+prettyjws",</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">["quay.io/bitnami/wildfly@sha256:5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b"],</span> <span class="pre">"RepoTags":</span> <span class="pre">["quay.io/bitnami/wildfly:latest"],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367",</span> <span class="pre">"sha256:7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731",</span> <span class="pre">"sha256:720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d",</span> <span class="pre">"sha256:6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47",</span> <span class="pre">"sha256:59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c",</span> <span class="pre">"sha256:310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db",</span> <span class="pre">"sha256:36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79e"],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">569919342,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"17.06.0-ce",</span> <span class="pre">"VirtualSize":</span> <span class="pre">569919342}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -165,11 +158,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_import_module.html" title="previous chapter">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> + <li>Next: <a href="podman_login_module.html" title="next chapter">containers.podman.podman_login module β Login to a container registry using podman</a></li> </ul></li> </ul> </div> @@ -199,8 +229,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_load_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_login_info_module.html b/ansible_collections/containers/podman/docs/podman_login_info_module.html index 6f70b4ce2..7230f2de7 100644 --- a/ansible_collections/containers/podman/docs/podman_login_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_login_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_login_info β Return the logged-in user if any for a given registry — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_login_info module β Return the logged-in user if any for a given registry — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_logout module β Log out of a container registry using podman" href="podman_logout_module.html" /> + <link rel="prev" title="containers.podman.podman_login module β Login to a container registry using podman" href="podman_login_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-login-info-module"></span><div class="section" id="containers-podman-podman-login-info-return-the-logged-in-user-if-any-for-a-given-registry"> -<h1>containers.podman.podman_login_info β Return the logged-in user if any for a given registry<a class="headerlink" href="#containers-podman-podman-login-info-return-the-logged-in-user-if-any-for-a-given-registry" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-login-info-module"></span><section id="containers-podman-podman-login-info-module-return-the-logged-in-user-if-any-for-a-given-registry"> +<h1>containers.podman.podman_login_info module β Return the logged-in user if any for a given registry<a class="headerlink" href="#containers-podman-podman-login-info-module-return-the-logged-in-user-if-any-for-a-given-registry" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-login-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_login_info</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,123 +54,102 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Return the logged-in user if any for a given registry.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-login-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-authfile"></div> - <b>authfile</b> - <a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-registry"></div> - <b>registry</b> - <a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Registry server.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Return the logged-in user for docker hub registry</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io</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">Return the logged-in user for quay.io registry</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-authfile"><strong>authfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-registry"><strong>registry</strong></p> +<a class="ansibleOptionLink" href="#parameter-registry" 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>Registry server.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Return the logged-in user for docker hub registry</span> +<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span> +<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io</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">Return the logged-in user for quay.io registry</span> +<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span> +<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-login"></div> - <b>login</b> - <a class="ansibleOptionLink" href="#return-login" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>Logged in user for a registry</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'logged_in': True, 'registry': 'docker.io', 'username': 'clelange'}</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-login"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-return-login"><strong>login</strong></p> +<a class="ansibleOptionLink" href="#return-login" 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>Logged in user for a registry</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"logged_in":</span> <span class="pre">true,</span> <span class="pre">"registry":</span> <span class="pre">"docker.io",</span> <span class="pre">"username":</span> <span class="pre">"clelange"}</span></code></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>Clemens Lange (@clelange)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -186,11 +168,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_login_module.html" title="previous chapter">containers.podman.podman_login module β Login to a container registry using podman</a></li> + <li>Next: <a href="podman_logout_module.html" title="next chapter">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> </ul></li> </ul> </div> @@ -220,8 +239,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_login_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_login_module.html b/ansible_collections/containers/podman/docs/podman_login_module.html index 1f77c15e2..20a3e1475 100644 --- a/ansible_collections/containers/podman/docs/podman_login_module.html +++ b/ansible_collections/containers/podman/docs/podman_login_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_login β Login to a container registry using podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_login module β Login to a container registry using podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_login_info module β Return the logged-in user if any for a given registry" href="podman_login_info_module.html" /> + <link rel="prev" title="containers.podman.podman_load module β Load image from a tar file." href="podman_load_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,178 +33,137 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-login-module"></span><div class="section" id="containers-podman-podman-login-login-to-a-container-registry-using-podman"> -<h1>containers.podman.podman_login β Login to a container registry using podman<a class="headerlink" href="#containers-podman-podman-login-login-to-a-container-registry-using-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-login-module"></span><section id="containers-podman-podman-login-module-login-to-a-container-registry-using-podman"> +<h1>containers.podman.podman_login module β Login to a container registry using podman<a class="headerlink" href="#containers-podman-podman-login-module-login-to-a-container-registry-using-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-login-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_login</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> -<li><p>Login to a container registry server using the podman login command If the registry is not specified, the first registry under <cite>[registries.search]</cite> from <cite>registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile</cite> flag. The default path used is <cite>${XDG_RUNTIME_DIR}/containers/auth.json</cite>.</p></li> +<li><p>Login to a container registry server using the podman login command If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-login-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-authfile"></div> - <b>authfile</b> - <a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-certdir"></div> - <b>certdir</b> - <a class="ansibleOptionLink" href="#parameter-certdir" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-password"></div> - <b>password</b> - <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Password for the registry server.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-registry"></div> - <b>registry</b> - <a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-tlsverify"></div> - <b>tlsverify</b> - <a class="ansibleOptionLink" href="#parameter-tlsverify" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Require HTTPS and verify certificates when contacting registries. If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-username"></div> - <b>username</b> - <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Username for the registry server.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span><span class="w"></span> -<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-authfile"><strong>authfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-certdir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-certdir"><strong>certdir</strong></p> +<a class="ansibleOptionLink" href="#parameter-certdir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-password"><strong>password</strong></p> +<a class="ansibleOptionLink" href="#parameter-password" 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>Password for the registry server.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-registry"><strong>registry</strong></p> +<a class="ansibleOptionLink" href="#parameter-registry" 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>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tlsverify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-tlsverify"><strong>tlsverify</strong></p> +<a class="ansibleOptionLink" href="#parameter-tlsverify" 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>Require HTTPS and verify certificates when contacting registries. If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-username"><strong>username</strong></p> +<a class="ansibleOptionLink" href="#parameter-username" 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>Username for the registry server.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json</span> +<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span> +<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span> +<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</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">Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span><span class="w"></span> -<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</span><span class="w"></span> -<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</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">Login to quay.io and create ${XDG_RUNTIME_DIR}/containers/auth.json</span> +<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span> +<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span> +<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</span> +<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Jason Hiatt (@jthiatt)</p></li> <li><p>Clemens Lange (@clelange)</p></li> +<li><p>Michael Fox (@spmfox)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -222,11 +182,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_load_module.html" title="previous chapter">containers.podman.podman_load module β Load image from a tar file.</a></li> + <li>Next: <a href="podman_login_info_module.html" title="next chapter">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> </ul></li> </ul> </div> @@ -256,8 +253,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_login_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_logout_module.html b/ansible_collections/containers/podman/docs/podman_logout_module.html index fb3817db9..e52d3f016 100644 --- a/ansible_collections/containers/podman/docs/podman_logout_module.html +++ b/ansible_collections/containers/podman/docs/podman_logout_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_logout β Log out of a container registry using podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_logout module β Log out of a container registry using podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_network module β Manage podman networks" href="podman_network_module.html" /> + <link rel="prev" title="containers.podman.podman_login_info module β Return the logged-in user if any for a given registry" href="podman_login_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,156 +33,131 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-logout-module"></span><div class="section" id="containers-podman-podman-logout-log-out-of-a-container-registry-using-podman"> -<h1>containers.podman.podman_logout β Log out of a container registry using podman<a class="headerlink" href="#containers-podman-podman-logout-log-out-of-a-container-registry-using-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-logout-module"></span><section id="containers-podman-podman-logout-module-log-out-of-a-container-registry-using-podman"> +<h1>containers.podman.podman_logout module β Log out of a container registry using podman<a class="headerlink" href="#containers-podman-podman-logout-module-log-out-of-a-container-registry-using-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-logout-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_logout</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> -<li><p>Log out of a container registry server using the podman logout command by deleting the cached credentials stored in the <cite>auth.json</cite> file. If the registry is not specified, the first registry under <cite>[registries.search]</cite> from <cite>registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile</cite> flag. The default path used is <cite>${XDG_RUNTIME_DIR}/containers/auth.json</cite>. All the cached credentials can be removed by setting the <cite>all</cite> flag. Warning - podman will use credentials in <cite>${HOME}/.docker/config.json</cite> to authenticate in case they are not found in the default <cite>authfile</cite>. However, the logout command will only removed credentials in the <cite>authfile</cite> specified.</p></li> +<li><p>Log out of a container registry server using the podman logout command by deleting the cached credentials stored in the `auth.json` file. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`. All the cached credentials can be removed by setting the `all` flag. Warning - podman will use credentials in `${HOME}/.docker/config.json` to authenticate in case they are not found in the default `authfile`. However, the logout command will only removed credentials in the `authfile` specified.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-logout-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-all"></div> - <b>all</b> - <a class="ansibleOptionLink" href="#parameter-all" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Remove the cached credentials for all registries in the auth file.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-authfile"></div> - <b>authfile</b> - <a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-ignore_docker_credentials"></div> - <b>ignore_docker_credentials</b> - <a class="ansibleOptionLink" href="#parameter-ignore_docker_credentials" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Credentials created using other tools such as `docker login` are not removed unless the corresponding `authfile` is explicitly specified. Since podman also uses existing credentials in these files by default (for docker e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker login exists for the registry specified in any `authfile` is used by podman. This can be ignored by setting `ignore_docker_credentials` to `yes` - the credentials will be kept and `changed` will be false. This option cannot be used together with `all` since in this case podman will not check for existing `authfiles` created by other tools.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-registry"></div> - <b>registry</b> - <a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Log out of default registry</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</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">Log out of quay.io</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</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">Log out of all registries in auth file</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</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">Log out of all registries in specified auth file</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">authfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$HOME/.docker/config.json</span><span class="w"></span> -<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-all"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-all"><strong>all</strong></p> +<a class="ansibleOptionLink" href="#parameter-all" 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>Remove the cached credentials for all registries in the auth file.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-authfile"><strong>authfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ignore_docker_credentials"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-ignore-docker-credentials"><strong>ignore_docker_credentials</strong></p> +<a class="ansibleOptionLink" href="#parameter-ignore_docker_credentials" 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>Credentials created using other tools such as `docker login` are not removed unless the corresponding `authfile` is explicitly specified. Since podman also uses existing credentials in these files by default (for docker e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker login exists for the registry specified in any `authfile` is used by podman. This can be ignored by setting `ignore_docker_credentials` to `true` - the credentials will be kept and `changed` will be false. This option cannot be used together with `all` since in this case podman will not check for existing `authfiles` created by other tools.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-registry"><strong>registry</strong></p> +<a class="ansibleOptionLink" href="#parameter-registry" 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>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Log out of default registry</span> +<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</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">Log out of quay.io</span> +<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span> +<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</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">Log out of all registries in auth file</span> +<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span> +<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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">Log out of all registries in specified auth file</span> +<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span> +<span class="w"> </span><span class="nt">authfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$HOME/.docker/config.json</span> +<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Clemens Lange (@clelange)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -200,11 +176,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_login_info_module.html" title="previous chapter">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> + <li>Next: <a href="podman_network_module.html" title="next chapter">containers.podman.podman_network module β Manage podman networks</a></li> </ul></li> </ul> </div> @@ -234,8 +247,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_logout_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_network_info_module.html b/ansible_collections/containers/podman/docs/podman_network_info_module.html index 585252dee..488b52f62 100644 --- a/ansible_collections/containers/podman/docs/podman_network_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_network_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_network_info β Gather info about podman networks — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_network_info module β Gather info about podman networks — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_play module β Play kubernetes YAML file using podman" href="podman_play_module.html" /> + <link rel="prev" title="containers.podman.podman_network module β Manage podman networks" href="podman_network_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-network-info-module"></span><div class="section" id="containers-podman-podman-network-info-gather-info-about-podman-networks"> -<h1>containers.podman.podman_network_info β Gather info about podman networks<a class="headerlink" href="#containers-podman-podman-network-info-gather-info-about-podman-networks" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-network-info-module"></span><section id="containers-podman-podman-network-info-module-gather-info-about-podman-networks"> +<h1>containers.podman.podman_network_info module β Gather info about podman networks<a class="headerlink" href="#containers-podman-podman-network-info-module-gather-info-about-podman-networks" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-network-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_network_info</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,107 +54,94 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Gather info about podman networks with podman inspect command.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-network-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Name of the network</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Gather info about all present networks</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_network_info</span><span class="p">:</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">Gather info about specific network</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_network_info</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">podman</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-network-info-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></p> +</div></td> +<td><div class="ansible-option-cell"><p>Name of the network</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Gather info about all present networks</span> +<span class="w"> </span><span class="nt">containers.podman.podman_network_info</span><span class="p">:</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">Gather info about specific network</span> +<span class="w"> </span><span class="nt">containers.podman.podman_network_info</span><span class="p">:</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">podman</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-networks"></div> - <b>networks</b> - <a class="ansibleOptionLink" href="#return-networks" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td>always</td> - <td> - <div>Facts from all or specified networks</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'cniVersion': '0.4.0', 'name': 'podman', 'plugins': [{'bridge': 'cni-podman0', 'ipMasq': True, 'ipam': {'ranges': [[{'gateway': '10.88.0.1', 'subnet': '10.88.0.0/16'}]], 'routes': [{'dst': '0.0.0.0/0'}], 'type': 'host-local'}, 'isGateway': True, 'type': 'bridge'}, {'capabilities': {'portMappings': True}, 'type': 'portmap'}, {'backend': 'iptables', 'type': 'firewall'}]}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-networks"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-info-module-return-networks"><strong>networks</strong></p> +<a class="ansibleOptionLink" href="#return-networks" 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-cell"><p>Facts from all or specified networks</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"cniVersion":</span> <span class="pre">"0.4.0",</span> <span class="pre">"name":</span> <span class="pre">"podman",</span> <span class="pre">"plugins":</span> <span class="pre">[{"bridge":</span> <span class="pre">"cni-podman0",</span> <span class="pre">"ipMasq":</span> <span class="pre">true,</span> <span class="pre">"ipam":</span> <span class="pre">{"ranges":</span> <span class="pre">[[{"gateway":</span> <span class="pre">"10.88.0.1",</span> <span class="pre">"subnet":</span> <span class="pre">"10.88.0.0/16"}]],</span> <span class="pre">"routes":</span> <span class="pre">[{"dst":</span> <span class="pre">"0.0.0.0/0"}],</span> <span class="pre">"type":</span> <span class="pre">"host-local"},</span> <span class="pre">"isGateway":</span> <span class="pre">true,</span> <span class="pre">"type":</span> <span class="pre">"bridge"},</span> <span class="pre">{"capabilities":</span> <span class="pre">{"portMappings":</span> <span class="pre">true},</span> <span class="pre">"type":</span> <span class="pre">"portmap"},</span> <span class="pre">{"backend":</span> <span class="pre">"iptables",</span> <span class="pre">"type":</span> <span class="pre">"firewall"}]}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -170,11 +160,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_network_module.html" title="previous chapter">containers.podman.podman_network module β Manage podman networks</a></li> + <li>Next: <a href="podman_play_module.html" title="next chapter">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> </ul></li> </ul> </div> @@ -204,8 +231,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_network_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_network_module.html b/ansible_collections/containers/podman/docs/podman_network_module.html index b3716c0d7..c83643774 100644 --- a/ansible_collections/containers/podman/docs/podman_network_module.html +++ b/ansible_collections/containers/podman/docs/podman_network_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_network β Manage podman networks — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_network module β Manage podman networks — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_network_info module β Gather info about podman networks" href="podman_network_info_module.html" /> + <link rel="prev" title="containers.podman.podman_logout module β Log out of a container registry using podman" href="podman_logout_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-network-module"></span><div class="section" id="containers-podman-podman-network-manage-podman-networks"> -<h1>containers.podman.podman_network β Manage podman networks<a class="headerlink" href="#containers-podman-podman-network-manage-podman-networks" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-network-module"></span><section id="containers-podman-podman-network-module-manage-podman-networks"> +<h1>containers.podman.podman_network module β Manage podman networks<a class="headerlink" href="#containers-podman-podman-network-module-manage-podman-networks" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_network</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,351 +54,281 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Manage podman networks with podman network command.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-network-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="2">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Return additional information which can be helpful for investigations.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-disable_dns"></div> - <b>disable_dns</b> - <a class="ansibleOptionLink" href="#parameter-disable_dns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>disable dns plugin (default "false")</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-driver"></div> - <b>driver</b> - <a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Driver to manage the network (default "bridge")</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-gateway"></div> - <b>gateway</b> - <a class="ansibleOptionLink" href="#parameter-gateway" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>IPv4 or IPv6 gateway for the subnet</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-internal"></div> - <b>internal</b> - <a class="ansibleOptionLink" href="#parameter-internal" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Restrict external access from this network (default "false")</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ip_range"></div> - <b>ip_range</b> - <a class="ansibleOptionLink" href="#parameter-ip_range" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Allocate container IP from range</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ipv6"></div> - <b>ipv6</b> - <a class="ansibleOptionLink" href="#parameter-ipv6" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The subnet option must be used with the ipv6 option.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-macvlan"></div> - <b>macvlan</b> - <a class="ansibleOptionLink" href="#parameter-macvlan" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Create a Macvlan connection based on this device</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Name of the network</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-opt"></div> - <b>opt</b> - <a class="ansibleOptionLink" href="#parameter-opt" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Add network options. Currently 'vlan' and 'mtu' are supported.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-opt/mtu"></div> - <b>mtu</b> - <a class="ansibleOptionLink" href="#parameter-opt/mtu" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>MTU size for bridge network interface.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-opt/vlan"></div> - <b>vlan</b> - <a class="ansibleOptionLink" href="#parameter-opt/vlan" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>VLAN tag for bridge which enables vlan_filtering.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-recreate"></div> - <b>recreate</b> - <a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Recreate network even if exists.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>State of network, default 'present'</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-subnet"></div> - <b>subnet</b> - <a class="ansibleOptionLink" href="#parameter-subnet" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Subnet in CIDR format</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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 podman network</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_network</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">podman_network</span><span class="w"></span> -<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Return additional information which can be helpful for investigations.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-disable_dns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-disable-dns"><strong>disable_dns</strong></p> +<a class="ansibleOptionLink" href="#parameter-disable_dns" 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>disable dns plugin (default βfalseβ)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-driver"><strong>driver</strong></p> +<a class="ansibleOptionLink" href="#parameter-driver" 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>Driver to manage the network (default βbridgeβ)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Remove all containers that use the network. If the container is running, it is stopped and removed.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-gateway"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-gateway"><strong>gateway</strong></p> +<a class="ansibleOptionLink" href="#parameter-gateway" 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>IPv4 or IPv6 gateway for the subnet</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-interface_name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-interface-name"><strong>interface_name</strong></p> +<a class="ansibleOptionLink" href="#parameter-interface_name" 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>For bridge, it uses the bridge interface name. For macvlan, it is the parent device on the host (it is the same as βopt.parentβ)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-internal"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-internal"><strong>internal</strong></p> +<a class="ansibleOptionLink" href="#parameter-internal" 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>Restrict external access from this network (default βfalseβ)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ip_range"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-ip-range"><strong>ip_range</strong></p> +<a class="ansibleOptionLink" href="#parameter-ip_range" 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>Allocate container IP from range</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ipv6"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-ipv6"><strong>ipv6</strong></p> +<a class="ansibleOptionLink" href="#parameter-ipv6" 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>Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The subnet option must be used with the ipv6 option.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-macvlan"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-macvlan"><strong>macvlan</strong></p> +<a class="ansibleOptionLink" href="#parameter-macvlan" 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>Create a Macvlan connection based on this device</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-containers-podman-podman-network-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 network</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt"><strong>opt</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add network options. Currently βvlanβ and βmtuβ are supported.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/isolate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-isolate"><strong>isolate</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/isolate" 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-indent-desc"></div><div class="ansible-option-cell"><p>This option isolates networks by blocking traffic between those that have this option enabled.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/metric"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-metric"><strong>metric</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/metric" title="Permalink to this option"></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>Sets the Route Metric for the default route created in every container joined to this network. Can only be used with the Netavark network backend.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-mode"><strong>mode</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/mode" 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-indent-desc"></div><div class="ansible-option-cell"><p>This option sets the specified ip/macvlan mode on the interface.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/mtu"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-mtu"><strong>mtu</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/mtu" title="Permalink to this option"></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>MTU size for bridge network interface.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/parent"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-parent"><strong>parent</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/parent" 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-indent-desc"></div><div class="ansible-option-cell"><p>The host device which should be used for the macvlan interface (it is the same as βinterfaceβ in that case). Defaults to the default route interface.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-opt/vlan"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-vlan"><strong>vlan</strong></p> +<a class="ansibleOptionLink" href="#parameter-opt/vlan" title="Permalink to this option"></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>VLAN tag for bridge which enables vlan_filtering.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-recreate"><strong>recreate</strong></p> +<a class="ansibleOptionLink" href="#parameter-recreate" 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>Recreate network even if exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-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 of network, default βpresentβ</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-subnet"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-subnet"><strong>subnet</strong></p> +<a class="ansibleOptionLink" href="#parameter-subnet" 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>Subnet in CIDR format</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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 podman network</span> +<span class="w"> </span><span class="nt">containers.podman.podman_network</span><span class="p">:</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">podman_network</span> +<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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 internal podman network</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_network</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">podman_internal</span><span class="w"></span> -<span class="w"> </span><span class="nt">internal</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">ip_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.128/25</span><span class="w"></span> -<span class="w"> </span><span class="nt">subnet</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.0/24</span><span class="w"></span> -<span class="w"> </span><span class="nt">gateway</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.1</span><span class="w"></span> -<span class="w"> </span><span class="nt">become</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="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 internal podman network</span> +<span class="w"> </span><span class="nt">containers.podman.podman_network</span><span class="p">:</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">podman_internal</span> +<span class="w"> </span><span class="nt">internal</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="nt">ip_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.128/25</span> +<span class="w"> </span><span class="nt">subnet</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.0/24</span> +<span class="w"> </span><span class="nt">gateway</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.1</span> +<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-network"></div> - <b>network</b> - <a class="ansibleOptionLink" href="#return-network" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td>always</td> - <td> - <div>Facts from created or updated networks</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'cniVersion': '0.4.0', 'name': 'podman', 'plugins': [{'bridge': 'cni-podman0', 'ipMasq': True, 'ipam': {'ranges': [[{'gateway': '10.88.0.1', 'subnet': '10.88.0.0/16'}]], 'routes': [{'dst': '0.0.0.0/0'}], 'type': 'host-local'}, 'isGateway': True, 'type': 'bridge'}, {'capabilities': {'portMappings': True}, 'type': 'portmap'}, {'backend': 'iptables', 'type': 'firewall'}]}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-return-network"><strong>network</strong></p> +<a class="ansibleOptionLink" href="#return-network" 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-cell"><p>Facts from created or updated networks</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"cniVersion":</span> <span class="pre">"0.4.0",</span> <span class="pre">"name":</span> <span class="pre">"podman",</span> <span class="pre">"plugins":</span> <span class="pre">[{"bridge":</span> <span class="pre">"cni-podman0",</span> <span class="pre">"ipMasq":</span> <span class="pre">true,</span> <span class="pre">"ipam":</span> <span class="pre">{"ranges":</span> <span class="pre">[[{"gateway":</span> <span class="pre">"10.88.0.1",</span> <span class="pre">"subnet":</span> <span class="pre">"10.88.0.0/16"}]],</span> <span class="pre">"routes":</span> <span class="pre">[{"dst":</span> <span class="pre">"0.0.0.0/0"}],</span> <span class="pre">"type":</span> <span class="pre">"host-local"},</span> <span class="pre">"isGateway":</span> <span class="pre">true,</span> <span class="pre">"type":</span> <span class="pre">"bridge"},</span> <span class="pre">{"capabilities":</span> <span class="pre">{"portMappings":</span> <span class="pre">true},</span> <span class="pre">"type":</span> <span class="pre">"portmap"},</span> <span class="pre">{"backend":</span> <span class="pre">"iptables",</span> <span class="pre">"type":</span> <span class="pre">"firewall"}]}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -414,11 +347,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_logout_module.html" title="previous chapter">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> + <li>Next: <a href="podman_network_info_module.html" title="next chapter">containers.podman.podman_network_info module β Gather info about podman networks</a></li> </ul></li> </ul> </div> @@ -448,8 +418,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_network_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_play_module.html b/ansible_collections/containers/podman/docs/podman_play_module.html index a4413b0b4..4c27c4841 100644 --- a/ansible_collections/containers/podman/docs/podman_play_module.html +++ b/ansible_collections/containers/podman/docs/podman_play_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_play β Play kubernetes YAML file using podman — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_play module β Play kubernetes YAML file using podman — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_pod module β Manage Podman pods" href="podman_pod_module.html" /> + <link rel="prev" title="containers.podman.podman_network_info module β Gather info about podman networks" href="podman_network_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,331 +33,304 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-play-module"></span><div class="section" id="containers-podman-podman-play-play-kubernetes-yaml-file-using-podman"> -<h1>containers.podman.podman_play β Play kubernetes YAML file using podman<a class="headerlink" href="#containers-podman-podman-play-play-kubernetes-yaml-file-using-podman" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-play-module"></span><section id="containers-podman-podman-play-module-play-kubernetes-yaml-file-using-podman"> +<h1>containers.podman.podman_play module β Play kubernetes YAML file using podman<a class="headerlink" href="#containers-podman-podman-play-module-play-kubernetes-yaml-file-using-podman" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_play</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>The module reads in a structured file of Kubernetes YAML. It will then recreate the pod and containers described in the YAML.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-play-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-authfile"></div> - <b>authfile</b> - <a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json, which is set using podman login. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using docker login. Note - You can also override the default path of the authentication file by setting the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-cert_dir"></div> - <b>cert_dir</b> - <a class="ansibleOptionLink" href="#parameter-cert_dir" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d. (This option is not available with the remote Podman client)</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-configmap"></div> - <b>configmap</b> - <a class="ansibleOptionLink" href="#parameter-configmap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=path</span> </div> - </td> - <td> - </td> - <td> - <div>Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. Note - The configmap option can be used multiple times to pass multiple Kubernetes configmap YAMLs</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Enable debug for the module.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Name of executable to run, by default 'podman'</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-kube_file"></div> - <b>kube_file</b> - <a class="ansibleOptionLink" href="#parameter-kube_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Path to file with YAML configuration for a Pod.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-log_driver"></div> - <b>log_driver</b> - <a class="ansibleOptionLink" href="#parameter-log_driver" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set logging driver for all created containers.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-log_level"></div> - <b>log_level</b> - <a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>debug</li> - <li>info</li> - <li>warn</li> - <li>error</li> - <li>fatal</li> - <li>panic</li> - </ul> - </td> - <td> - <div>Set logging level for podman calls. Log messages above specified level ("debug"|"info"|"warn"|"error"|"fatal"|"panic") (default "error")</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-network"></div> - <b>network</b> - <a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>List of the names of CNI networks the pod should join.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-password"></div> - <b>password</b> - <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The username and password to use to authenticate with the registry if required.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-quiet"></div> - <b>quiet</b> - <a class="ansibleOptionLink" href="#parameter-quiet" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Hide image pulls logs from output.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-recreate"></div> - <b>recreate</b> - <a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>If pod already exists, delete it and run the new one.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-seccomp_profile_root"></div> - <b>seccomp_profile_root</b> - <a class="ansibleOptionLink" href="#parameter-seccomp_profile_root" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">path</span> - </div> - </td> - <td> - </td> - <td> - <div>Directory path for seccomp profiles (default is "/var/lib/kubelet/seccomp"). This option is not available with the remote Podman client</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>created</li> - <li>started</li> - <li>absent</li> - </ul> - </td> - <td> - <div>Start the pod after creating it, or to leave it created only.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-tls_verify"></div> - <b>tls_verify</b> - <a class="ansibleOptionLink" href="#parameter-tls_verify" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Require HTTPS and verify certificates when contacting registries (default is true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-username"></div> - <b>username</b> - <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The username and password to use to authenticate with the registry if required.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Play kube file</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</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">started</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-annotation"></div> +<div class="ansibleOptionAnchor" id="parameter-annotations"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-annotations"><span id="ansible-collections-containers-podman-podman-play-module-parameter-annotation"></span><strong>annotation</strong></p> +<a class="ansibleOptionLink" href="#parameter-annotation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: annotations</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add an annotation to the container or pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-authfile"><strong>authfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json, which is set using podman login. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using docker login. Note - You can also override the default path of the authentication file by setting the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-build"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-build"><strong>build</strong></p> +<a class="ansibleOptionLink" href="#parameter-build" 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>Build images even if they are found in the local storage.</p> +<p>It is required to exist subdirectories matching the image names to be build.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cert_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-cert-dir"><strong>cert_dir</strong></p> +<a class="ansibleOptionLink" href="#parameter-cert_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d. (This option is not available with the remote Podman client)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-configmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-configmap"><strong>configmap</strong></p> +<a class="ansibleOptionLink" href="#parameter-configmap" 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=path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. Note - The configmap option can be used multiple times to pass multiple Kubernetes configmap YAMLs</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-context_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-context-dir"><strong>context_dir</strong></p> +<a class="ansibleOptionLink" href="#parameter-context_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Use path as the build context directory for each image. Requires build option be true.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Enable debug for the module.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" 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 executable to run, by default βpodmanβ</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-kube_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-kube-file"><strong>kube_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-kube_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span> / <span class="ansible-option-required">required</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to file with YAML configuration for a Pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-driver"><strong>log_driver</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_driver" 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 logging driver for all created containers.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_level"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-level"><strong>log_level</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set logging level for podman calls. Log messages above specified level (βdebugβ|βinfoβ|βwarnβ|βerrorβ|βfatalβ|βpanicβ) (default βerrorβ)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"debug"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"info"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"warn"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"error"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"fatal"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"panic"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt"></span><strong>log_opt</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: log_options</span></p> +<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Logging driver specific options. Set custom logging configuration.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/max_size"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/max_size"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-max-size"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-max-size"></span><strong>max_size</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/max_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a max size of the log file (e.g 10mb).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/path"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-path"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-path"></span><strong>path</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>specify a path to the log file (e.g. /var/log/container/mycontainer.json).</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-log_opt/tag"></div> +<div class="ansibleOptionAnchor" id="parameter-log_options/tag"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-tag"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-tag"></span><strong>tag</strong></p> +<a class="ansibleOptionLink" href="#parameter-log_opt/tag" 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-indent-desc"></div><div class="ansible-option-cell"><p>specify a custom log tag for the container. This option is currently supported only by the journald log driver in Podman.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-network"><strong>network</strong></p> +<a class="ansibleOptionLink" href="#parameter-network" 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 the names of CNI networks the pod should join.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-password"><strong>password</strong></p> +<a class="ansibleOptionLink" href="#parameter-password" 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 username and password to use to authenticate with the registry if required.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-quiet"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quiet"><strong>quiet</strong></p> +<a class="ansibleOptionLink" href="#parameter-quiet" 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>Hide image pulls logs from output.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-recreate"><strong>recreate</strong></p> +<a class="ansibleOptionLink" href="#parameter-recreate" 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 pod already exists, delete it and run the new one.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-seccomp_profile_root"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-seccomp-profile-root"><strong>seccomp_profile_root</strong></p> +<a class="ansibleOptionLink" href="#parameter-seccomp_profile_root" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Directory path for seccomp profiles (default is β/var/lib/kubelet/seccompβ). This option is not available with the remote Podman client</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-containers-podman-podman-play-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> / <span class="ansible-option-required">required</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Start the pod after creating it, or to leave it created only.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"created"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"started"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-tls-verify"><strong>tls_verify</strong></p> +<a class="ansibleOptionLink" href="#parameter-tls_verify" 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>Require HTTPS and verify certificates when contacting registries (default is true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-username"><strong>username</strong></p> +<a class="ansibleOptionLink" href="#parameter-username" 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 username and password to use to authenticate with the registry if required.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-userns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-userns"><strong>userns</strong></p> +<a class="ansibleOptionLink" href="#parameter-userns" 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 the user namespace mode for all the containers in a pod. It defaults to the PODMAN_USERNS environment variable. An empty value (ββ) means user namespaces are disabled.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Play kube file</span> +<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span> +<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</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">started</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">Recreate pod from a kube file with options</span> +<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span> +<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</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">started</span> +<span class="w"> </span><span class="nt">recreate</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="nt">annotations</span><span class="p">:</span> +<span class="w"> </span><span class="nt">greeting</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hello</span> +<span class="w"> </span><span class="nt">greet_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">world</span> +<span class="w"> </span><span class="nt">userns</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">host</span> +<span class="w"> </span><span class="nt">log_opt</span><span class="p">:</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/my-container.log</span> +<span class="w"> </span><span class="nt">max_size</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10mb</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -375,11 +349,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_network_info_module.html" title="previous chapter">containers.podman.podman_network_info module β Gather info about podman networks</a></li> + <li>Next: <a href="podman_pod_module.html" title="next chapter">containers.podman.podman_pod module β Manage Podman pods</a></li> </ul></li> </ul> </div> @@ -409,8 +420,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_play_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_pod_info_module.html b/ansible_collections/containers/podman/docs/podman_pod_info_module.html index bca913152..b708bdb1f 100644 --- a/ansible_collections/containers/podman/docs/podman_pod_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_pod_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_pod_info β Gather info about podman pods — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_pod_info module β Gather info about podman pods — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_prune module β Allows to prune various podman objects" href="podman_prune_module.html" /> + <link rel="prev" title="containers.podman.podman_pod module β Manage Podman pods" href="podman_pod_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-pod-info-module"></span><div class="section" id="containers-podman-podman-pod-info-gather-info-about-podman-pods"> -<h1>containers.podman.podman_pod_info β Gather info about podman pods<a class="headerlink" href="#containers-podman-podman-pod-info-gather-info-about-podman-pods" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-pod-info-module"></span><section id="containers-podman-podman-pod-info-module-gather-info-about-podman-pods"> +<h1>containers.podman.podman_pod_info module β Gather info about podman pods<a class="headerlink" href="#containers-podman-podman-pod-info-module-gather-info-about-podman-pods" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-pod-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_pod_info</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,107 +54,94 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Gather info about podman pods with podman inspect command.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-pod-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Name of the pod</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Gather info about all present pods</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_pod_info</span><span class="p">:</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">Gather info about specific pods</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_pod_info</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">special_pod</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-pod-info-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></p> +</div></td> +<td><div class="ansible-option-cell"><p>Name of the pod</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Gather info about all present pods</span> +<span class="w"> </span><span class="nt">containers.podman.podman_pod_info</span><span class="p">:</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">Gather info about specific pods</span> +<span class="w"> </span><span class="nt">containers.podman.podman_pod_info</span><span class="p">:</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">special_pod</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-pods"></div> - <b>pods</b> - <a class="ansibleOptionLink" href="#return-pods" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td>always</td> - <td> - <div>Facts from all or specified pods</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'Config': {'cgroupParent': '/libpod_parent', 'created': '2020-07-13T20:29:12.572282186+03:00', 'hostname': 'pod1host', 'id': 'd9cb6dbb0....', 'infraConfig': {'infraPortBindings': [{'containerPort': 7111, 'hostIP': '', 'hostPort': 7777, 'protocol': 'tcp'}], 'makeInfraContainer': True}, 'labels': {}, 'lockID': 682, 'name': 'pod1', 'sharesCgroup': True, 'sharesIpc': True, 'sharesNet': True, 'sharesUts': True}, 'Containers': [{'id': 'ad46737bf....', 'state': 'configured'}], 'State': {'cgroupPath': '/libpod_parent/d9cb6dbb0....', 'infraContainerID': 'ad46737bf....', 'status': 'Created'}}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-pods"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-info-module-return-pods"><strong>pods</strong></p> +<a class="ansibleOptionLink" href="#return-pods" 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-cell"><p>Facts from all or specified pods</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Config":</span> <span class="pre">{"cgroupParent":</span> <span class="pre">"/libpod_parent",</span> <span class="pre">"created":</span> <span class="pre">"2020-07-13T20:29:12.572282186+03:00",</span> <span class="pre">"hostname":</span> <span class="pre">"pod1host",</span> <span class="pre">"id":</span> <span class="pre">"d9cb6dbb0....",</span> <span class="pre">"infraConfig":</span> <span class="pre">{"infraPortBindings":</span> <span class="pre">[{"containerPort":</span> <span class="pre">7111,</span> <span class="pre">"hostIP":</span> <span class="pre">"",</span> <span class="pre">"hostPort":</span> <span class="pre">7777,</span> <span class="pre">"protocol":</span> <span class="pre">"tcp"}],</span> <span class="pre">"makeInfraContainer":</span> <span class="pre">true},</span> <span class="pre">"labels":</span> <span class="pre">{},</span> <span class="pre">"lockID":</span> <span class="pre">682,</span> <span class="pre">"name":</span> <span class="pre">"pod1",</span> <span class="pre">"sharesCgroup":</span> <span class="pre">true,</span> <span class="pre">"sharesIpc":</span> <span class="pre">true,</span> <span class="pre">"sharesNet":</span> <span class="pre">true,</span> <span class="pre">"sharesUts":</span> <span class="pre">true},</span> <span class="pre">"Containers":</span> <span class="pre">[{"id":</span> <span class="pre">"ad46737bf....",</span> <span class="pre">"state":</span> <span class="pre">"configured"}],</span> <span class="pre">"State":</span> <span class="pre">{"cgroupPath":</span> <span class="pre">"/libpod_parent/d9cb6dbb0....",</span> <span class="pre">"infraContainerID":</span> <span class="pre">"ad46737bf....",</span> <span class="pre">"status":</span> <span class="pre">"Created"}}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -170,11 +160,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_pod_module.html" title="previous chapter">containers.podman.podman_pod module β Manage Podman pods</a></li> + <li>Next: <a href="podman_prune_module.html" title="next chapter">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> </ul></li> </ul> </div> @@ -204,8 +231,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_pod_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_pod_module.html b/ansible_collections/containers/podman/docs/podman_pod_module.html index 9fb77f947..ff057319e 100644 --- a/ansible_collections/containers/podman/docs/podman_pod_module.html +++ b/ansible_collections/containers/podman/docs/podman_pod_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_pod β Manage Podman pods — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_pod module β Manage Podman pods — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_pod_info module β Gather info about podman pods" href="podman_pod_info_module.html" /> + <link rel="prev" title="containers.podman.podman_play module β Play kubernetes YAML file using podman" href="podman_play_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-pod-module"></span><div class="section" id="containers-podman-podman-pod-manage-podman-pods"> -<h1>containers.podman.podman_pod β Manage Podman pods<a class="headerlink" href="#containers-podman-podman-pod-manage-podman-pods" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-pod-module"></span><section id="containers-podman-podman-pod-module-manage-podman-pods"> +<h1>containers.podman.podman_pod module β Manage Podman pods<a class="headerlink" href="#containers-podman-podman-pod-module-manage-podman-pods" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-pod-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_pod</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.0.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,898 +54,568 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Manage podman pods.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-pod-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="2">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-add_host"></div> - <b>add_host</b> - <a class="ansibleOptionLink" href="#parameter-add_host" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add a host to the /etc/hosts file shared between all containers in the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cgroup_parent"></div> - <b>cgroup_parent</b> - <a class="ansibleOptionLink" href="#parameter-cgroup_parent" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, he path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpus"></div> - <b>cpus</b> - <a class="ansibleOptionLink" href="#parameter-cpus" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the total number of CPUs delegated to the pod. Default is 0.000 which indicates that there is no limit on computation power.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-cpuset_cpus"></div> - <b>cpuset_cpus</b> - <a class="ansibleOptionLink" href="#parameter-cpuset_cpus" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Limit the CPUs to support execution. First CPU is numbered 0. Unlike `cpus` this is of type string and parsed as a list of numbers. Format is 0-3,0,1</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Return additional information which can be helpful for investigations.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device"></div> - <b>device</b> - <a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add a host device to the pod. Optional permissions parameter can be used to specify device permissions. It is a combination of r for read, w for write, and m for mknod(2)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-device_read_bps"></div> - <b>device_read_bps</b> - <a class="ansibleOptionLink" href="#parameter-device_read_bps" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns"></div> - <b>dns</b> - <a class="ansibleOptionLink" href="#parameter-dns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns_opt"></div> - <b>dns_opt</b> - <a class="ansibleOptionLink" href="#parameter-dns_opt" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-dns_search"></div> - <b>dns_search</b> - <a class="ansibleOptionLink" href="#parameter-dns_search" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd"></div> - <b>generate_systemd</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">{}</div> - </td> - <td> - <div>Generate systemd unit file for container.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/after"></div> - <b>after</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/after" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/container_prefix"></div> - <b>container_prefix</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/container_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for containers. The default is "container".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/names"></div> - <b>names</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/names" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Use names of the containers for the start, stop, and description in the unit file. Default is true.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/new"></div> - <b>new</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/new" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Create containers and pods when the unit is started instead of expecting them to exist. The default is "false". Refer to podman-generate-systemd(1) for more information.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/no_header"></div> - <b>no_header</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/no_header" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/path"></div> - <b>path</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/path" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify a path to the directory where unit files will be generated. Required for this option. If it doesn't exist, the directory will be created.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/pod_prefix"></div> - <b>pod_prefix</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/pod_prefix" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name prefix for pods. The default is "pod".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/requires"></div> - <b>requires</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/requires" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_policy"></div> - <b>restart_policy</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_policy" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>on-success</li> - <li>on-failure</li> - <li>on-abnormal</li> - <li>on-watchdog</li> - <li>on-abort</li> - <li>always</li> - </ul> - </td> - <td> - <div>Specify a restart policy for the service. The restart-policy must be one of "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is "on-failure".</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/separator"></div> - <b>separator</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/separator" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is "-" (dash).</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/time"></div> - <b>time</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/time" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Override the default stop timeout for the container with the given value.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-generate_systemd/wants"></div> - <b>wants</b> - <a class="ansibleOptionLink" href="#parameter-generate_systemd/wants" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.</div> - </td> - </tr> - - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-gidmap"></div> - <b>gidmap</b> - <a class="ansibleOptionLink" href="#parameter-gidmap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>GID map for the user namespace. Using this flag will run the container with user namespace enabled. It conflicts with the `userns` and `subgidname` flags.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-hostname"></div> - <b>hostname</b> - <a class="ansibleOptionLink" href="#parameter-hostname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set a hostname to the pod</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-infra"></div> - <b>infra</b> - <a class="ansibleOptionLink" href="#parameter-infra" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default is true.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-infra_command"></div> - <b>infra_command</b> - <a class="ansibleOptionLink" href="#parameter-infra_command" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The command that will be run to start the infra container. Default is "/pause".</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-infra_conmon_pidfile"></div> - <b>infra_conmon_pidfile</b> - <a class="ansibleOptionLink" href="#parameter-infra_conmon_pidfile" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Write the pid of the infra container's conmon process to a file. As conmon runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-infra_image"></div> - <b>infra_image</b> - <a class="ansibleOptionLink" href="#parameter-infra_image" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The image that will be created for the infra container. Default is "k8s.gcr.io/pause:3.1".</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-infra_name"></div> - <b>infra_name</b> - <a class="ansibleOptionLink" href="#parameter-infra_name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The name that will be used for the pod's infra container.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-ip"></div> - <b>ip</b> - <a class="ansibleOptionLink" href="#parameter-ip" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set a static IP for the pod's shared network.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-label"></div> - <b>label</b> - <a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Add metadata to a pod, pass dictionary of label keys and values.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-label_file"></div> - <b>label_file</b> - <a class="ansibleOptionLink" href="#parameter-label_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Read in a line delimited file of labels.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-mac_address"></div> - <b>mac_address</b> - <a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set a static MAC address for the pod's shared network.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Assign a name to the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-network"></div> - <b>network</b> - <a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set network mode for the pod. Supported values are bridge (the default), host (do not create a network namespace, all containers in the pod will use the host's network), or a list of names of CNI networks to join.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-network_alias"></div> - <b>network_alias</b> - <a class="ansibleOptionLink" href="#parameter-network_alias" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Add a network-scoped alias for the pod, setting the alias for all networks that the pod joins. To set a name only for a specific network, use the alias option as described under the -`network` option. Network aliases work only with the bridge networking mode. This option can be specified multiple times.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: network_aliases</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-no_hosts"></div> - <b>no_hosts</b> - <a class="ansibleOptionLink" href="#parameter-no_hosts" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Disable creation of /etc/hosts for the pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pid"></div> - <b>pid</b> - <a class="ansibleOptionLink" href="#parameter-pid" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the PID mode for the pod. The default is to create a private PID namespace for the pod. Requires the PID namespace to be shared via `share` option.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-pod_id_file"></div> - <b>pod_id_file</b> - <a class="ansibleOptionLink" href="#parameter-pod_id_file" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Write the pod ID to the file.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-publish"></div> - <b>publish</b> - <a class="ansibleOptionLink" href="#parameter-publish" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Publish a port or range of ports from the pod to the host.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: ports</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-recreate"></div> - <b>recreate</b> - <a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Use with present and started states to force the re-creation of an existing pod.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-share"></div> - <b>share</b> - <a class="ansibleOptionLink" href="#parameter-share" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>A comma delimited list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, user, uts.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>created</b> ←</div></li> - <li>killed</li> - <li>restarted</li> - <li>absent</li> - <li>started</li> - <li>stopped</li> - <li>paused</li> - <li>unpaused</li> - </ul> - </td> - <td> - <div>This variable is set for state</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-subgidname"></div> - <b>subgidname</b> - <a class="ansibleOptionLink" href="#parameter-subgidname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Name for GID map from the /etc/subgid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `gidmap`.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-subuidname"></div> - <b>subuidname</b> - <a class="ansibleOptionLink" href="#parameter-subuidname" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Name for UID map from the /etc/subuid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `uidmap`.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-uidmap"></div> - <b>uidmap</b> - <a class="ansibleOptionLink" href="#parameter-uidmap" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Run the container in a new user namespace using the supplied mapping. This option conflicts with the `userns` and `subuidname` options. This option provides a way to map host UIDs to container UIDs. It can be passed several times to map different ranges.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-userns"></div> - <b>userns</b> - <a class="ansibleOptionLink" href="#parameter-userns" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Set the user namespace mode for all the containers in a pod. It defaults to the PODMAN_USERNS environment variable. An empty value ("") means user namespaces are disabled.</div> - </td> - </tr> - <tr> - <td colspan="2"> - <div class="ansibleOptionAnchor" id="parameter-volume"></div> - <b>volume</b> - <a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Create a bind mount.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: volumes</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">podman_pod</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">pod1</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">started</span><span class="w"></span> -<span class="w"> </span><span class="nt">ports</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"4444:5555"</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-add_host"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-add-host"><strong>add_host</strong></p> +<a class="ansibleOptionLink" href="#parameter-add_host" 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>Add a host to the /etc/hosts file shared between all containers in the pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-blkio_weight"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-blkio-weight"><strong>blkio_weight</strong></p> +<a class="ansibleOptionLink" href="#parameter-blkio_weight" 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>Block IO relative weight. The weight is a value between 10 and 1000.</p> +<p>This option is not supported on cgroups V1 rootless systems.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-blkio_weight_device"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-blkio-weight-device"><strong>blkio_weight_device</strong></p> +<a class="ansibleOptionLink" href="#parameter-blkio_weight_device" 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>Block IO relative device weight.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cgroup_parent"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-cgroup-parent"><strong>cgroup_parent</strong></p> +<a class="ansibleOptionLink" href="#parameter-cgroup_parent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, he path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpu_shares"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-cpu-shares"><strong>cpu_shares</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpu_shares" 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>CPU shares (relative weight).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpus"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-cpus"><strong>cpus</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpus" 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 the total number of CPUs delegated to the pod. Default is 0.000 which indicates that there is no limit on computation power.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpuset_cpus"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-cpuset-cpus"><strong>cpuset_cpus</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpuset_cpus" 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>Limit the CPUs to support execution. First CPU is numbered 0. Unlike `cpus` this is of type string and parsed as a list of numbers. Format is 0-3,0,1</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-cpuset_mems"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-cpuset-mems"><strong>cpuset_mems</strong></p> +<a class="ansibleOptionLink" href="#parameter-cpuset_mems" 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>Memory nodes in which to allow execution (0-3, 0,1). Only effective on NUMA systems.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Return additional information which can be helpful for investigations.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-device"><strong>device</strong></p> +<a class="ansibleOptionLink" href="#parameter-device" 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>Add a host device to the pod. Optional permissions parameter can be used to specify device permissions. It is a combination of r for read, w for write, and m for mknod(2)</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_read_bps"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-device-read-bps"><strong>device_read_bps</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_read_bps" 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>Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-device_write_bps"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-device-write-bps"><strong>device_write_bps</strong></p> +<a class="ansibleOptionLink" href="#parameter-device_write_bps" 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>Limit write rate (in bytes per second) to a device.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-dns"><strong>dns</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns" 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>Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, βnoneβ is allowed which disables creation of /etc/resolv.conf for the pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns_opt"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-dns-opt"><strong>dns_opt</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns_opt" 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>Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dns_search"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-dns-search"><strong>dns_search</strong></p> +<a class="ansibleOptionLink" href="#parameter-dns_search" 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>Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd"><strong>generate_systemd</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Generate systemd unit file for container.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/after"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-after"><strong>after</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/after" 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-indent-desc"></div><div class="ansible-option-cell"><p>Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/container_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-container-prefix"><strong>container_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/container_prefix" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name prefix for containers. The default is βcontainerβ.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-names"><strong>names</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/names" 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-indent-desc"></div><div class="ansible-option-cell"><p>Use names of the containers for the start, stop, and description in the unit file. Default is true.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/new"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-new"><strong>new</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/new" 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-indent-desc"></div><div class="ansible-option-cell"><p>Create containers and pods when the unit is started instead of expecting them to exist. The default is βfalseβ. Refer to podman-generate-systemd(1) for more information.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/no_header"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-no-header"><strong>no_header</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/no_header" 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-indent-desc"></div><div class="ansible-option-cell"><p>Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-path"><strong>path</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a path to the directory where unit files will be generated. Required for this option. If it doesnβt exist, the directory will be created.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/pod_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-pod-prefix"><strong>pod_prefix</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/pod_prefix" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name prefix for pods. The default is βpodβ.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/requires"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-requires"><strong>requires</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/requires" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_policy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-restart-policy"><strong>restart_policy</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_policy" 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-indent-desc"></div><div class="ansible-option-cell"><p>Specify a restart policy for the service. The restart-policy must be one of βnoβ, βon-successβ, βon-failureβ, βon-abnormalβ, βon-watchdogβ, βon-abortβ, or βalwaysβ. The default policy is βon-failureβ.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"no"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-success"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-failure"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abnormal"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-watchdog"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abort"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"always"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_sec"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-restart-sec"><strong>restart_sec</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_sec" title="Permalink to this option"></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>Set the systemd service restartsec value.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/separator"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-separator"><strong>separator</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/separator" 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-indent-desc"></div><div class="ansible-option-cell"><p>Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is β-β (dash).</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/start_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-start-timeout"><strong>start_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/start_timeout" title="Permalink to this option"></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>Override the default start timeout for the container with the given value.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/stop_timeout"></div> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/time"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-time"><span id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-stop-timeout"></span><strong>stop_timeout</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: time</span></p> +<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>Override the default stop timeout for the container with the given value. Called `time` before version 4.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-generate_systemd/wants"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-generate-systemd-wants"><strong>wants</strong></p> +<a class="ansibleOptionLink" href="#parameter-generate_systemd/wants" 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-indent-desc"></div><div class="ansible-option-cell"><p>Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-gidmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-gidmap"><strong>gidmap</strong></p> +<a class="ansibleOptionLink" href="#parameter-gidmap" 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>GID map for the user namespace. Using this flag will run the container with user namespace enabled. It conflicts with the `userns` and `subgidname` flags.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-hostname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-hostname"><strong>hostname</strong></p> +<a class="ansibleOptionLink" href="#parameter-hostname" 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 a hostname to the pod</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-infra"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-infra"><strong>infra</strong></p> +<a class="ansibleOptionLink" href="#parameter-infra" 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>Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default is true.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-infra_command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-infra-command"><strong>infra_command</strong></p> +<a class="ansibleOptionLink" href="#parameter-infra_command" 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 command that will be run to start the infra container. Default is β/pauseβ.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-infra_conmon_pidfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-infra-conmon-pidfile"><strong>infra_conmon_pidfile</strong></p> +<a class="ansibleOptionLink" href="#parameter-infra_conmon_pidfile" 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>Write the pid of the infra containerβs conmon process to a file. As conmon runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-infra_image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-infra-image"><strong>infra_image</strong></p> +<a class="ansibleOptionLink" href="#parameter-infra_image" 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 image that will be created for the infra container. Default is βk8s.gcr.io/pause:3.1β.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-infra_name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-infra-name"><strong>infra_name</strong></p> +<a class="ansibleOptionLink" href="#parameter-infra_name" 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 name that will be used for the podβs infra container.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-ip"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-ip"><strong>ip</strong></p> +<a class="ansibleOptionLink" href="#parameter-ip" 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 a static IP for the podβs shared network.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-label"><strong>label</strong></p> +<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add metadata to a pod, pass dictionary of label keys and values.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-label-file"><strong>label_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-label_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Read in a line delimited file of labels.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-mac_address"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-mac-address"><strong>mac_address</strong></p> +<a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Set a static MAC address for the podβs shared network.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-memory"><strong>memory</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory" 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 memory limit.</p> +<p>A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes).</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-memory_swap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-memory-swap"><strong>memory_swap</strong></p> +<a class="ansibleOptionLink" href="#parameter-memory_swap" 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 limit value equal to memory plus swap.</p> +<p>A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes).</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-containers-podman-podman-pod-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>Assign a name to the pod.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-network"><strong>network</strong></p> +<a class="ansibleOptionLink" href="#parameter-network" 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>Set network mode for the pod. Supported values are bridge (the default), host (do not create a network namespace, all containers in the pod will use the hostβs network), or a list of names of CNI networks to join.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network_alias"></div> +<div class="ansibleOptionAnchor" id="parameter-network_aliases"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-network-aliases"><span id="ansible-collections-containers-podman-podman-pod-module-parameter-network-alias"></span><strong>network_alias</strong></p> +<a class="ansibleOptionLink" href="#parameter-network_alias" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: network_aliases</span></p> +<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>Add a network-scoped alias for the pod, setting the alias for all networks that the pod joins. To set a name only for a specific network, use the alias option as described under the -`network` option. Network aliases work only with the bridge networking mode. This option can be specified multiple times.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-no_hosts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-no-hosts"><strong>no_hosts</strong></p> +<a class="ansibleOptionLink" href="#parameter-no_hosts" 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>Disable creation of /etc/hosts for the pod.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pid"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-pid"><strong>pid</strong></p> +<a class="ansibleOptionLink" href="#parameter-pid" 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 the PID mode for the pod. The default is to create a private PID namespace for the pod. Requires the PID namespace to be shared via `share` option.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-pod_id_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-pod-id-file"><strong>pod_id_file</strong></p> +<a class="ansibleOptionLink" href="#parameter-pod_id_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Write the pod ID to the file.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-publish"></div> +<div class="ansibleOptionAnchor" id="parameter-ports"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-publish"><span id="ansible-collections-containers-podman-podman-pod-module-parameter-ports"></span><strong>publish</strong></p> +<a class="ansibleOptionLink" href="#parameter-publish" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ports</span></p> +<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>Publish a port or range of ports from the pod to the host.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-recreate"><strong>recreate</strong></p> +<a class="ansibleOptionLink" href="#parameter-recreate" 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>Use with present and started states to force the re-creation of an existing pod.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-share"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-share"><strong>share</strong></p> +<a class="ansibleOptionLink" href="#parameter-share" 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>A comma delimited list of kernel namespaces to share. If none or ββ is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, user, uts.</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-containers-podman-podman-pod-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>This variable is set for state</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"created"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"killed"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"restarted"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"started"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stopped"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"paused"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"unpaused"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-subgidname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-subgidname"><strong>subgidname</strong></p> +<a class="ansibleOptionLink" href="#parameter-subgidname" 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 for GID map from the /etc/subgid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `gidmap`.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-subuidname"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-subuidname"><strong>subuidname</strong></p> +<a class="ansibleOptionLink" href="#parameter-subuidname" 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 for UID map from the /etc/subuid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `uidmap`.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-uidmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-uidmap"><strong>uidmap</strong></p> +<a class="ansibleOptionLink" href="#parameter-uidmap" 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>Run the container in a new user namespace using the supplied mapping. This option conflicts with the `userns` and `subuidname` options. This option provides a way to map host UIDs to container UIDs. It can be passed several times to map different ranges.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-userns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-userns"><strong>userns</strong></p> +<a class="ansibleOptionLink" href="#parameter-userns" 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 the user namespace mode for all the containers in a pod. It defaults to the PODMAN_USERNS environment variable. An empty value (ββ) means user namespaces are disabled.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume"></div> +<div class="ansibleOptionAnchor" id="parameter-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-parameter-volumes"><span id="ansible-collections-containers-podman-podman-pod-module-parameter-volume"></span><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: volumes</span></p> +<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>Create a bind mount.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">podman_pod</span><span class="p">:</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">pod1</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">started</span> +<span class="w"> </span><span class="nt">ports</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"4444:5555"</span> -<span class="c1"># Connect random port from localhost to port 80 on pod2</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">Connect random port from localhost to port 80 on pod2</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_pod</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">pod2</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">started</span><span class="w"></span> -<span class="w"> </span><span class="nt">publish</span><span class="p">:</span><span class="w"> </span><span class="s">"127.0.0.1::80"</span><span class="w"></span> +<span class="c1"># Connect random port from localhost to port 80 on pod2</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">Connect random port from localhost to port 80 on pod2</span> +<span class="w"> </span><span class="nt">containers.podman.podman_pod</span><span class="p">:</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">pod2</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">started</span> +<span class="w"> </span><span class="nt">publish</span><span class="p">:</span><span class="w"> </span><span class="s">"127.0.0.1::80"</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-pod"></div> - <b>pod</b> - <a class="ansibleOptionLink" href="#return-pod" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>Pod inspection results for the given pod built.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'Config': {'cgroupParent': '/libpod_parent', 'created': '2020-06-14T15:16:12.230818767+03:00', 'hostname': 'newpod', 'id': 'a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58', 'infraConfig': {'infraPortBindings': None, 'makeInfraContainer': True}, 'labels': {}, 'lockID': 515, 'name': 'newpod', 'sharesCgroup': True, 'sharesIpc': True, 'sharesNet': True, 'sharesUts': True}, 'Containers': [{'id': 'dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2', 'state': 'configured'}], 'State': {'cgroupPath': '/libpod_parent/a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58', 'infraContainerID': 'dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2', 'status': 'Created'}}</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-pod"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-pod-module-return-pod"><strong>pod</strong></p> +<a class="ansibleOptionLink" href="#return-pod" 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>Pod inspection results for the given pod built.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"Config":</span> <span class="pre">{"cgroupParent":</span> <span class="pre">"/libpod_parent",</span> <span class="pre">"created":</span> <span class="pre">"2020-06-14T15:16:12.230818767+03:00",</span> <span class="pre">"hostname":</span> <span class="pre">"newpod",</span> <span class="pre">"id":</span> <span class="pre">"a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58",</span> <span class="pre">"infraConfig":</span> <span class="pre">{"infraPortBindings":</span> <span class="pre">null,</span> <span class="pre">"makeInfraContainer":</span> <span class="pre">true},</span> <span class="pre">"labels":</span> <span class="pre">{},</span> <span class="pre">"lockID":</span> <span class="pre">515,</span> <span class="pre">"name":</span> <span class="pre">"newpod",</span> <span class="pre">"sharesCgroup":</span> <span class="pre">true,</span> <span class="pre">"sharesIpc":</span> <span class="pre">true,</span> <span class="pre">"sharesNet":</span> <span class="pre">true,</span> <span class="pre">"sharesUts":</span> <span class="pre">true},</span> <span class="pre">"Containers":</span> <span class="pre">[{"id":</span> <span class="pre">"dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2",</span> <span class="pre">"state":</span> <span class="pre">"configured"}],</span> <span class="pre">"State":</span> <span class="pre">{"cgroupPath":</span> <span class="pre">"/libpod_parent/a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58",</span> <span class="pre">"infraContainerID":</span> <span class="pre">"dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2",</span> <span class="pre">"status":</span> <span class="pre">"Created"}}</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -961,11 +634,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_play_module.html" title="previous chapter">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> + <li>Next: <a href="podman_pod_info_module.html" title="next chapter">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> </ul></li> </ul> </div> @@ -995,8 +705,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_pod_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_prune_module.html b/ansible_collections/containers/podman/docs/podman_prune_module.html new file mode 100644 index 000000000..a596a9c9d --- /dev/null +++ b/ansible_collections/containers/podman/docs/podman_prune_module.html @@ -0,0 +1,403 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_prune module β Allows to prune various podman objects — Python documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_runlabel module β Run given label from given image" href="podman_runlabel_module.html" /> + <link rel="prev" title="containers.podman.podman_pod_info module β Gather info about podman pods" href="podman_pod_info_module.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <span class="target" id="ansible-collections-containers-podman-podman-prune-module"></span><section id="containers-podman-podman-prune-module-allows-to-prune-various-podman-objects"> +<h1>containers.podman.podman_prune module β Allows to prune various podman objects<a class="headerlink" href="#containers-podman-podman-prune-module-allows-to-prune-various-podman-objects" 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/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-prune-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> +<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_prune</span></code>.</p> +</div> +<p class="ansible-version-added">New in containers.podman 1.10.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> +<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> +<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> +<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> +</ul> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +<ul class="simple"> +<li><p>Allows to run <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">container</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">image</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">network</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">volume</span> <span class="pre">prune</span></code> and <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">system</span> <span class="pre">prune</span></code></p></li> +</ul> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-prune-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +<p>The below requirements are needed on the host that executes this module.</p> +<ul class="simple"> +<li><p>Podman installed on host</p></li> +</ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-container"><strong>container</strong></p> +<a class="ansibleOptionLink" href="#parameter-container" 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>Whether to prune containers.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-container_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-container-filters"><strong>container_filters</strong></p> +<a class="ansibleOptionLink" href="#parameter-container_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting containers to delete.</p> +<p>For example, <code class="docutils literal notranslate"><span class="pre">until:</span> <span class="pre">24h</span></code>.</p> +<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-container-prune.1.html#filter-filters">the podman documentation</a> for more information on possible filters.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" 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>Podman binary.</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#parameter-image" 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>Whether to prune images.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-image-filters"><strong>image_filters</strong></p> +<a class="ansibleOptionLink" href="#parameter-image_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting images to delete.</p> +<p>You can also use <code class="docutils literal notranslate"><span class="pre">dangling_only:</span> <span class="pre">false</span></code> to delete dangling and non-dangling images or <code class="docutils literal notranslate"><span class="pre">external:</span> <span class="pre">true</span></code> to delete images even when they are used by external containers.</p> +<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-image-prune.1.html#filter-filters">the podman documentation</a> for more information on possible filters.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-network"><strong>network</strong></p> +<a class="ansibleOptionLink" href="#parameter-network" 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>Whether to prune networks.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-network_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-network-filters"><strong>network_filters</strong></p> +<a class="ansibleOptionLink" href="#parameter-network_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting networks to delete.</p> +<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-network-prune.1.html#filter">the podman documentation</a> for more information on possible filters.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-system"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system"><strong>system</strong></p> +<a class="ansibleOptionLink" href="#parameter-system" 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>Whether to prune unused pods, containers, image, networks and volume data</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-system_all"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system-all"><strong>system_all</strong></p> +<a class="ansibleOptionLink" href="#parameter-system_all" 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>Whether to prune all unused images, not only dangling images.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-system_volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system-volumes"><strong>system_volumes</strong></p> +<a class="ansibleOptionLink" href="#parameter-system_volumes" 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>Whether to prune volumes currently unused by any container.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-volume"><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume" 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>Whether to prune volumes.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-volume_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-volume-filters"><strong>volume_filters</strong></p> +<a class="ansibleOptionLink" href="#parameter-volume_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting volumes to delete.</p> +<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-volume-prune.1.html#filter">the podman documentation</a> for more information on possible filters.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Prune containers older than 24h</span> +<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span> +<span class="w"> </span><span class="nt">containers</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="nt">containers_filters</span><span class="p">:</span> +<span class="w"> </span><span class="c1"># only consider containers created more than 24 hours ago</span> +<span class="w"> </span><span class="nt">until</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">24h</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">Prune everything</span> +<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span> +<span class="w"> </span><span class="nt">system</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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">Prune everything (including non-dangling images)</span> +<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span> +<span class="w"> </span><span class="nt">system</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="nt">system_all</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="nt">system_volumes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> +</pre></div> +</div> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> +<table class="longtable 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-containers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-containers"><strong>containers</strong></p> +<a class="ansibleOptionLink" href="#return-containers" 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-cell"><p>List of IDs of deleted containers.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>containers</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-images"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-images"><strong>images</strong></p> +<a class="ansibleOptionLink" href="#return-images" 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-cell"><p>List of IDs of deleted images.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>images</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-networks"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-networks"><strong>networks</strong></p> +<a class="ansibleOptionLink" href="#return-networks" 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-cell"><p>List of IDs of deleted networks.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>networks</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-system"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-system"><strong>system</strong></p> +<a class="ansibleOptionLink" href="#return-system" 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-cell"><p>List of ID of deleted containers, volumes, images, network and total reclaimed space</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>system</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="return-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-volumes"><strong>volumes</strong></p> +<a class="ansibleOptionLink" href="#return-volumes" 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-cell"><p>List of IDs of deleted volumes.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>volumes</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></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>Roberto Alfieri (@rebtoor)</p></li> +</ul> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="index.html">Python</a></h1> + + + + + + + + +<h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_pod_info_module.html" title="previous chapter">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> + <li>Next: <a href="podman_runlabel_module.html" title="next chapter">containers.podman.podman_runlabel module β Run given label from given image</a></li> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> + + | + <a href="_sources/podman_prune_module.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/podman_runlabel_module.html b/ansible_collections/containers/podman/docs/podman_runlabel_module.html new file mode 100644 index 000000000..133d14adf --- /dev/null +++ b/ansible_collections/containers/podman/docs/podman_runlabel_module.html @@ -0,0 +1,227 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_runlabel module β Run given label from given image — Python documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_save module β Saves podman image to tar file" href="podman_save_module.html" /> + <link rel="prev" title="containers.podman.podman_prune module β Allows to prune various podman objects" href="podman_prune_module.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <span class="target" id="ansible-collections-containers-podman-podman-runlabel-module"></span><section id="containers-podman-podman-runlabel-module-run-given-label-from-given-image"> +<h1>containers.podman.podman_runlabel module β Run given label from given image<a class="headerlink" href="#containers-podman-podman-runlabel-module-run-given-label-from-given-image" 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/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-runlabel-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> +<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_runlabel</span></code>.</p> +</div> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> +<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> +<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> +</ul> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +<ul class="simple"> +<li><p>podman container runlabel runs selected label from given image</p></li> +</ul> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-runlabel-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +<p>The below requirements are needed on the host that executes this module.</p> +<ul class="simple"> +<li><p>Podman installed on host</p></li> +</ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#parameter-image" 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>Image to get the label from.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-label"><strong>label</strong></p> +<a class="ansibleOptionLink" href="#parameter-label" 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>Label to run.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_runlabel</span><span class="p">:</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/continuumio/miniconda3</span> +<span class="w"> </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INSTALL</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>Pavel Dostal (@pdostal)</p></li> +</ul> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="index.html">Python</a></h1> + + + + + + + + +<h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_prune_module.html" title="previous chapter">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> + <li>Next: <a href="podman_save_module.html" title="next chapter">containers.podman.podman_save module β Saves podman image to tar file</a></li> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> + + | + <a href="_sources/podman_runlabel_module.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/podman_save_module.html b/ansible_collections/containers/podman/docs/podman_save_module.html index cb7002f3c..7a58a96b0 100644 --- a/ansible_collections/containers/podman/docs/podman_save_module.html +++ b/ansible_collections/containers/podman/docs/podman_save_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_save β Saves podman image to tar file — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_save module β Saves podman image to tar file — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_secret module β Manage podman secrets" href="podman_secret_module.html" /> + <link rel="prev" title="containers.podman.podman_runlabel module β Run given label from given image" href="podman_runlabel_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,187 +33,154 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-save-module"></span><div class="section" id="containers-podman-podman-save-saves-podman-image-to-tar-file"> -<h1>containers.podman.podman_save β Saves podman image to tar file<a class="headerlink" href="#containers-podman-podman-save-saves-podman-image-to-tar-file" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-save-module"></span><section id="containers-podman-podman-save-module-saves-podman-image-to-tar-file"> +<h1>containers.podman.podman_save module β Saves podman image to tar file<a class="headerlink" href="#containers-podman-podman-save-module-saves-podman-image-to-tar-file" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-save-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_save</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>podman save saves an image to either docker-archive, oci-archive, oci-dir (directory with oci manifest type), or docker-dir (directory with v2s2 manifest type) on the local machine, default is docker-archive.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-save-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-compress"></div> - <b>compress</b> - <a class="ansibleOptionLink" href="#parameter-compress" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type, compressed or uncompressed, as source)</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-dest"></div> - <b>dest</b> - <a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Destination file to write image to.</div> - <div style="font-size: small; color: darkgreen"><br/>aliases: path</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-force"></div> - <b>force</b> - <a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li><div style="color: blue"><b>yes</b> ←</div></li> - </ul> - </td> - <td> - <div>Force saving to file even if it exists.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-format"></div> - <b>format</b> - <a class="ansibleOptionLink" href="#parameter-format" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>docker-archive</li> - <li>oci-archive</li> - <li>oci-dir</li> - <li>docker-dir</li> - </ul> - </td> - <td> - <div>Save image to docker-archive, oci-archive (see containers-transports(5)), oci-dir (oci transport), or docker-dir (dir transport with v2s2 manifest type).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Image to save.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-multi_image_archive"></div> - <b>multi_image_archive</b> - <a class="ansibleOptionLink" href="#parameter-multi_image_archive" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for docker-archive.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_save</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span><span class="w"></span> -<span class="w"> </span><span class="nt">compress</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">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci-dir</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-compress"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-compress"><strong>compress</strong></p> +<a class="ansibleOptionLink" href="#parameter-compress" 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>Compress tarball image layers when pushing to a directory using the βdirβ transport. (default is same compression type, compressed or uncompressed, as source)</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-dest"></div> +<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-path"><span id="ansible-collections-containers-podman-podman-save-module-parameter-dest"></span><strong>dest</strong></p> +<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: path</span></p> +<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>Destination file to write image to.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Force saving to file even if it exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-format"><strong>format</strong></p> +<a class="ansibleOptionLink" href="#parameter-format" 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>Save image to docker-archive, oci-archive (see containers-transports(5)), oci-dir (oci transport), or docker-dir (dir transport with v2s2 manifest type).</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-archive"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-archive"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-dir"</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-dir"</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#parameter-image" 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>Image to save.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-multi_image_archive"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-multi-image-archive"><strong>multi_image_archive</strong></p> +<a class="ansibleOptionLink" href="#parameter-multi_image_archive" 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>Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for docker-archive.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_save</span><span class="p">:</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/file123.tar</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_save</span><span class="p">:</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fedora</span> +<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/file456.tar</span> +<span class="w"> </span><span class="nt">multi_image_archive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -231,11 +199,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_runlabel_module.html" title="previous chapter">containers.podman.podman_runlabel module β Run given label from given image</a></li> + <li>Next: <a href="podman_secret_module.html" title="next chapter">containers.podman.podman_secret module β Manage podman secrets</a></li> </ul></li> </ul> </div> @@ -265,8 +270,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_save_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_secret_info_module.html b/ansible_collections/containers/podman/docs/podman_secret_info_module.html new file mode 100644 index 000000000..acab00e36 --- /dev/null +++ b/ansible_collections/containers/podman/docs/podman_secret_info_module.html @@ -0,0 +1,257 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_secret_info module β Gather info about podman secrets — Python documentation</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_tag module β Add an additional name to a local image" href="podman_tag_module.html" /> + <link rel="prev" title="containers.podman.podman_secret module β Manage podman secrets" href="podman_secret_module.html" /> + + <link rel="stylesheet" href="_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <span class="target" id="ansible-collections-containers-podman-podman-secret-info-module"></span><section id="containers-podman-podman-secret-info-module-gather-info-about-podman-secrets"> +<h1>containers.podman.podman_secret_info module β Gather info about podman secrets<a class="headerlink" href="#containers-podman-podman-secret-info-module-gather-info-about-podman-secrets" 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/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-secret-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> +<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_secret_info</span></code>.</p> +</div> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> +<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> +<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> +<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> +</ul> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +<ul class="simple"> +<li><p>Gather info about podman secrets with podman inspect command.</p></li> +</ul> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-secret-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +<p>The below requirements are needed on the host that executes this module.</p> +<ul class="simple"> +<li><p>Podman installed on host</p></li> +</ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-secret-info-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></p> +</div></td> +<td><div class="ansible-option-cell"><p>Name of the secret</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-showsecret"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-parameter-showsecret"><strong>showsecret</strong></p> +<a class="ansibleOptionLink" href="#parameter-showsecret" 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>Show secret data value</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Gather info about all present secrets</span> +<span class="w"> </span><span class="nt">podman_secret_info</span><span class="p">:</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">Gather info about specific secret</span> +<span class="w"> </span><span class="nt">podman_secret_info</span><span class="p">:</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">specific_secret</span> +</pre></div> +</div> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> +<table class="longtable 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-secrets"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-return-secrets"><strong>secrets</strong></p> +<a class="ansibleOptionLink" href="#return-secrets" 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-cell"><p>Facts from all or specified secrets</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"CreatedAt":</span> <span class="pre">"2024-01-28T20:32:08.31857841+02:00",</span> <span class="pre">"ID":</span> <span class="pre">"06068c676e9a7f1c7dc0da8dd",</span> <span class="pre">"Spec":</span> <span class="pre">{"Driver":</span> <span class="pre">{"Name":</span> <span class="pre">"file",</span> <span class="pre">"Options":</span> <span class="pre">{"path":</span> <span class="pre">"/home/user/.local/share/containers/storage/secrets/filedriver"}},</span> <span class="pre">"Labels":</span> <span class="pre">{},</span> <span class="pre">"Name":</span> <span class="pre">"secret_name"},</span> <span class="pre">"UpdatedAt":</span> <span class="pre">"2024-01-28T20:32:08.31857841+02:00"}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> +</ul> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="index.html">Python</a></h1> + + + + + + + + +<h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_secret_module.html" title="previous chapter">containers.podman.podman_secret module β Manage podman secrets</a></li> + <li>Next: <a href="podman_tag_module.html" title="next chapter">containers.podman.podman_tag module β Add an additional name to a local image</a></li> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>document.getElementById('searchbox').style.display = "block"</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> + + | + <a href="_sources/podman_secret_info_module.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file diff --git a/ansible_collections/containers/podman/docs/podman_secret_module.html b/ansible_collections/containers/podman/docs/podman_secret_module.html index e6463dc31..ace978f70 100644 --- a/ansible_collections/containers/podman/docs/podman_secret_module.html +++ b/ansible_collections/containers/podman/docs/podman_secret_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_secret β Manage podman secrets — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_secret module β Manage podman secrets — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_secret_info module β Gather info about podman secrets" href="podman_secret_info_module.html" /> + <link rel="prev" title="containers.podman.podman_save module β Saves podman image to tar file" href="podman_save_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,217 +33,186 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-secret-module"></span><div class="section" id="containers-podman-podman-secret-manage-podman-secrets"> -<h1>containers.podman.podman_secret β Manage podman secrets<a class="headerlink" href="#containers-podman-podman-secret-manage-podman-secrets" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-secret-module"></span><section id="containers-podman-podman-secret-module-manage-podman-secrets"> +<h1>containers.podman.podman_secret module β Manage podman secrets<a class="headerlink" href="#containers-podman-podman-secret-module-manage-podman-secrets" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-secret-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_secret</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.7.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.7.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Manage podman secrets</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-secret-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-data"></div> - <b>data</b> - <a class="ansibleOptionLink" href="#parameter-data" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>The value of the secret. Required when <code>state</code> is <code>present</code>.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-driver"></div> - <b>driver</b> - <a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Override default secrets driver, currently podman uses <code>file</code> which is unencrypted.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-driver_opts"></div> - <b>driver_opts</b> - <a class="ansibleOptionLink" href="#parameter-driver_opts" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Driver-specific key-value options.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-force"></div> - <b>force</b> - <a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Use it when <code>state</code> is <code>present</code> to remove and recreate an existing secret.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>The name of the secret.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-skip_existing"></div> - <b>skip_existing</b> - <a class="ansibleOptionLink" href="#parameter-skip_existing" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Use it when <code>state</code> is <code>present</code> and secret with the same name already exists. If set to <code>true</code>, the secret will NOT be recreated and remains as is.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>absent</li> - <li><div style="color: blue"><b>present</b> ←</div></li> - </ul> - </td> - <td> - <div>Whether to create or remove the named secret.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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 secret</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</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="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span><span class="w"></span> -<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"> </span><span class="s">"my</span><span class="nv"> </span><span class="s">super</span><span class="nv"> </span><span class="s">secret</span><span class="nv"> </span><span class="s">content"</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-data"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-data"><strong>data</strong></p> +<a class="ansibleOptionLink" href="#parameter-data" 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 value of the secret. Required when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Enable debug mode for module.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-driver"><strong>driver</strong></p> +<a class="ansibleOptionLink" href="#parameter-driver" 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>Override default secrets driver, currently podman uses <code class="docutils literal notranslate"><span class="pre">file</span></code> which is unencrypted.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-driver_opts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-driver-opts"><strong>driver_opts</strong></p> +<a class="ansibleOptionLink" href="#parameter-driver_opts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Driver-specific key-value options.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-force"><strong>force</strong></p> +<a class="ansibleOptionLink" href="#parameter-force" 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>Use it when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code> to remove and recreate an existing secret.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-labels"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-labels"><strong>labels</strong></p> +<a class="ansibleOptionLink" href="#parameter-labels" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Labels to set on the secret.</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-containers-podman-podman-secret-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>The name of the secret.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-skip_existing"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-skip-existing"><strong>skip_existing</strong></p> +<a class="ansibleOptionLink" href="#parameter-skip_existing" 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>Use it when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and secret with the same name already exists. If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the secret will NOT be recreated and remains as is.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-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>Whether to create or remove the named secret.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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 secret</span> +<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</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="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span> +<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"> </span><span class="s">"my</span><span class="nv"> </span><span class="s">super</span><span class="nv"> </span><span class="s">secret</span><span class="nv"> </span><span class="s">content"</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 container that uses the secret</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">showmysecret</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/alpine:3.14</span><span class="w"></span> -<span class="w"> </span><span class="nt">secrets</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span><span class="w"></span> -<span class="w"> </span><span class="nt">detach</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">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cat /run/secrets/mysecret</span><span class="w"></span> -<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container</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">Create container that uses the secret</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">showmysecret</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/alpine:3.14</span> +<span class="w"> </span><span class="nt">secrets</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span> +<span class="w"> </span><span class="nt">detach</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="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cat /run/secrets/mysecret</span> +<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container</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">Output secret data</span><span class="w"></span> -<span class="w"> </span><span class="nt">debug</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">container.stdout</span> <span class="cp">}}</span><span class="s">'</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">Output secret data</span> +<span class="w"> </span><span class="nt">debug</span><span class="p">:</span> +<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">container.stdout</span> <span class="cp">}}</span><span class="s">'</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">Remove secret</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</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> -<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">mysecret</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">Remove secret</span> +<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</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><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Aliaksandr Mianzhynski (@amenzhinsky)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -261,11 +231,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_save_module.html" title="previous chapter">containers.podman.podman_save module β Saves podman image to tar file</a></li> + <li>Next: <a href="podman_secret_info_module.html" title="next chapter">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> </ul></li> </ul> </div> @@ -295,8 +302,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_secret_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_tag_module.html b/ansible_collections/containers/podman/docs/podman_tag_module.html index 24e3817ee..d7a369d5c 100644 --- a/ansible_collections/containers/podman/docs/podman_tag_module.html +++ b/ansible_collections/containers/podman/docs/podman_tag_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_tag β Add an additional name to a local image — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_tag module β Add an additional name to a local image — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_volume module β Manage Podman volumes" href="podman_volume_module.html" /> + <link rel="prev" title="containers.podman.podman_secret_info module β Gather info about podman secrets" href="podman_secret_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,109 +33,98 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-tag-module"></span><div class="section" id="containers-podman-podman-tag-add-an-additional-name-to-a-local-image"> -<h1>containers.podman.podman_tag β Add an additional name to a local image<a class="headerlink" href="#containers-podman-podman-tag-add-an-additional-name-to-a-local-image" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-tag-module"></span><section id="containers-podman-podman-tag-module-add-an-additional-name-to-a-local-image"> +<h1>containers.podman.podman_tag module β Add an additional name to a local image<a class="headerlink" href="#containers-podman-podman-tag-module-add-an-additional-name-to-a-local-image" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-tag-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_tag</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li> <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>podman tag adds one or more additional names to locally-stored image.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-tag-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-image"></div> - <b>image</b> - <a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Image to tag.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-target_names"></div> - <b>target_names</b> - <a class="ansibleOptionLink" href="#parameter-target_names" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Additional names.</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_tag</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/continuumio/miniconda3</span><span class="w"></span> -<span class="w"> </span><span class="nt">target_names</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda3</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-image"><strong>image</strong></p> +<a class="ansibleOptionLink" href="#parameter-image" 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>Image to tag.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-target_names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-target-names"><strong>target_names</strong></p> +<a class="ansibleOptionLink" href="#parameter-target_names" 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>Additional names.</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_tag</span><span class="p">:</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/continuumio/miniconda3</span> +<span class="w"> </span><span class="nt">target_names</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda3</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Christian Bourque (@ocafebabe)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -153,11 +143,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_secret_info_module.html" title="previous chapter">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> + <li>Next: <a href="podman_volume_module.html" title="next chapter">containers.podman.podman_volume module β Manage Podman volumes</a></li> </ul></li> </ul> </div> @@ -187,8 +214,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_tag_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_unshare_become.html b/ansible_collections/containers/podman/docs/podman_unshare_become.html index 115cc7293..0a149528d 100644 --- a/ansible_collections/containers/podman/docs/podman_unshare_become.html +++ b/ansible_collections/containers/podman/docs/podman_unshare_become.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_unshare β Run tasks using podman unshare — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_unshare become β Run tasks using podman unshare — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.buildah connection β Interact with an existing buildah container" href="buildah_connection.html" /> + <link rel="prev" title="containers.podman.podman_volume_info module β Gather info about podman volumes" href="podman_volume_info_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,218 +33,187 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-unshare-become"></span><div class="section" id="containers-podman-podman-unshare-run-tasks-using-podman-unshare"> -<h1>containers.podman.podman_unshare β Run tasks using podman unshare<a class="headerlink" href="#containers-podman-podman-unshare-run-tasks-using-podman-unshare" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-unshare-become"></span><section id="containers-podman-podman-unshare-become-run-tasks-using-podman-unshare"> +<h1>containers.podman.podman_unshare become β Run tasks using podman unshare<a class="headerlink" href="#containers-podman-podman-unshare-become-run-tasks-using-podman-unshare" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This become plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_unshare</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.9.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.9.0</p> +<nav class="contents local" 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> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>This become plugins allows your remote/login user to execute commands in its container user namespace. Official documentation: <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-unshare.1.html">https://docs.podman.io/en/latest/markdown/podman-unshare.1.html</a></p></li> </ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-become_exe"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-exe"><strong>become_exe</strong></p> +<a class="ansibleOptionLink" href="#parameter-become_exe" 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>Sudo executable</p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sudo"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entries:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">privilege_escalation</span><span class="p">]</span> +<span class="n">become_exe</span> <span class="o">=</span> <span class="n">sudo</span> +</pre></div> +</div> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span> +<span class="n">executable</span> <span class="o">=</span> <span class="n">sudo</span> +</pre></div> +</div> +</li> +<li><p>Environment variable: <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_EXE</span></code></p></li> +<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_EXE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_EXE</span></code></a></p></li> +<li><p>Variable: ansible_become_exe</p></li> +<li><p>Variable: ansible_sudo_exe</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-become_pass"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-pass"><strong>become_pass</strong></p> +<a class="ansibleOptionLink" href="#parameter-become_pass" 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>Password to pass to sudo</p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span> +<span class="n">password</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> </div> -<div class="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 border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th>Configuration</th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-become_exe"></div> - <b>become_exe</b> - <a class="ansibleOptionLink" href="#parameter-become_exe" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"sudo"</div> - </td> - <td> - <div> ini entries: - <p> - [privilege_escalation]<br>become_exe = sudo - </p> - <p> - [sudo_become_plugin]<br>executable = sudo - </p> - </div> - <div> - env:ANSIBLE_BECOME_EXE - </div> - <div> - env:ANSIBLE_SUDO_EXE - </div> - <div> - var: ansible_become_exe - </div> - <div> - var: ansible_sudo_exe - </div> - </td> - <td> - <div>Sudo executable</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-become_pass"></div> - <b>become_pass</b> - <a class="ansibleOptionLink" href="#parameter-become_pass" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div> ini entries: - <p> - [sudo_become_plugin]<br>password = None - </p> - </div> - <div> - env:ANSIBLE_BECOME_PASS - </div> - <div> - env:ANSIBLE_SUDO_PASS - </div> - <div> - var: ansible_become_password - </div> - <div> - var: ansible_become_pass - </div> - <div> - var: ansible_sudo_pass - </div> - </td> - <td> - <div>Password to pass to sudo</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-become_user"></div> - <b>become_user</b> - <a class="ansibleOptionLink" href="#parameter-become_user" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"root"</div> - </td> - <td> - <div> ini entries: - <p> - [privilege_escalation]<br>become_user = root - </p> - <p> - [sudo_become_plugin]<br>user = root - </p> - </div> - <div> - env:ANSIBLE_BECOME_USER - </div> - <div> - env:ANSIBLE_SUDO_USER - </div> - <div> - var: ansible_become_user - </div> - <div> - var: ansible_sudo_user - </div> - </td> - <td> - <div>User you 'become' to execute the task</div> - </td> - </tr> - </table> -<br/></div> -<div class="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">checking uid of file 'foo'</span><span class="w"></span> -<span class="w"> </span><span class="nt">ansible.builtin.stat</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span><span class="w"></span> -<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo.stat.uid</span><span class="w"></span> -<span class="c1"># The output shows that it's owned by the login user</span><span class="w"></span> -<span class="c1"># ok: [test_host] => {</span><span class="w"></span> -<span class="c1"># "foo.stat.uid": "1003"</span><span class="w"></span> -<span class="c1"># }</span><span class="w"></span> +</li> +<li><p>Environment variable: <span class="target" id="index-2"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_BECOME_PASS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_PASS</span></code></a></p></li> +<li><p>Environment variable: <span class="target" id="index-3"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_PASS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_PASS</span></code></a></p></li> +<li><p>Variable: ansible_become_password</p></li> +<li><p>Variable: ansible_become_pass</p></li> +<li><p>Variable: ansible_sudo_pass</p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-become_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-user"><strong>become_user</strong></p> +<a class="ansibleOptionLink" href="#parameter-become_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>User you βbecomeβ to execute the task (βrootβ is not a valid value here).</p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entries:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">privilege_escalation</span><span class="p">]</span> +<span class="n">become_user</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> +</div> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span> +<span class="n">user</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> +</div> +</li> +<li><p>Environment variable: <span class="target" id="index-4"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_USER</span></code></p></li> +<li><p>Environment variable: <span class="target" id="index-5"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_USER"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_USER</span></code></a></p></li> +<li><p>Variable: ansible_become_user</p></li> +<li><p>Variable: ansible_sudo_user</p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">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">checking uid of file 'foo'</span> +<span class="w"> </span><span class="nt">ansible.builtin.stat</span><span class="p">:</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span> +<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span> +<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo.stat.uid</span> +<span class="c1"># The output shows that it's owned by the login user</span> +<span class="c1"># ok: [test_host] => {</span> +<span class="c1"># "foo.stat.uid": "1003"</span> +<span class="c1"># }</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">mounting the file to an unprivileged container and modifying its owner</span><span class="w"></span> -<span class="w"> </span><span class="nt">containers.podman.podman_container</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">chmod_foo</span><span class="w"></span> -<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span><span class="w"></span> -<span class="w"> </span><span class="nt">rm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">:/opt/test:z"</span><span class="w"></span> -<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chown 1000 /opt/test/foo</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">mounting the file to an unprivileged container and modifying its owner</span> +<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</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">chmod_foo</span> +<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span> +<span class="w"> </span><span class="nt">rm</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="nt">volume</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">:/opt/test:z"</span> +<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chown 1000 /opt/test/foo</span> -<span class="c1"># Now the file 'foo' is owned by the container uid 1000,</span><span class="w"></span> -<span class="c1"># which is mapped to something completaly different on the host.</span><span class="w"></span> -<span class="c1"># It creates a situation when the file is unaccessible to the host user (uid 1003)</span><span class="w"></span> -<span class="c1"># Running stat again, debug output will be like this:</span><span class="w"></span> -<span class="c1"># ok: [test_host] => {</span><span class="w"></span> -<span class="c1"># "foo.stat.uid": "328679"</span><span class="w"></span> -<span class="c1"># }</span><span class="w"></span> +<span class="c1"># Now the file 'foo' is owned by the container uid 1000,</span> +<span class="c1"># which is mapped to something completaly different on the host.</span> +<span class="c1"># It creates a situation when the file is unaccessible to the host user (uid 1003)</span> +<span class="c1"># Running stat again, debug output will be like this:</span> +<span class="c1"># ok: [test_host] => {</span> +<span class="c1"># "foo.stat.uid": "328679"</span> +<span class="c1"># }</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">running stat in modified user namespace</span><span class="w"></span> -<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span><span class="w"></span> -<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">ansible.builtin.stat</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span><span class="w"></span> -<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span><span class="w"></span> -<span class="c1"># By gathering file stats with podman_ushare</span><span class="w"></span> -<span class="c1"># we can see the uid set in the container:</span><span class="w"></span> -<span class="c1"># ok: [test_host] => {</span><span class="w"></span> -<span class="c1"># "foo.stat.uid": "1000"</span><span class="w"></span> -<span class="c1"># }</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">running stat in modified user namespace</span> +<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span> +<span class="w"> </span><span class="nt">become</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="nt">ansible.builtin.stat</span><span class="p">:</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span> +<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span> +<span class="c1"># By gathering file stats with podman_ushare</span> +<span class="c1"># we can see the uid set in the container:</span> +<span class="c1"># ok: [test_host] => {</span> +<span class="c1"># "foo.stat.uid": "1000"</span> +<span class="c1"># }</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">resetting file ownership with podman unshare</span><span class="w"></span> -<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span><span class="w"></span> -<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span><span class="w"></span> -<span class="w"> </span><span class="nt">ansible.builtin.file</span><span class="p">:</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">file</span><span class="w"></span> -<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span><span class="w"></span> -<span class="w"> </span><span class="nt">owner</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span><span class="w"> </span><span class="c1"># in a modified user namespace host uid is mapped to 0</span><span class="w"></span> -<span class="c1"># If we run stat and debug with 'become: no',</span><span class="w"></span> -<span class="c1"># we can see that the file is ours again:</span><span class="w"></span> -<span class="c1"># ok: [test_host] => {</span><span class="w"></span> -<span class="c1"># "foo.stat.uid": "1003"</span><span class="w"></span> -<span class="c1"># }</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">resetting file ownership with podman unshare</span> +<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span> +<span class="w"> </span><span class="nt">become</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="nt">ansible.builtin.file</span><span class="p">:</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">file</span> +<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span> +<span class="w"> </span><span class="nt">owner</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span><span class="w"> </span><span class="c1"># in a modified user namespace host uid is mapped to 0</span> +<span class="c1"># If we run stat and debug with 'become: false',</span> +<span class="c1"># we can see that the file is ours again:</span> +<span class="c1"># ok: [test_host] => {</span> +<span class="c1"># "foo.stat.uid": "1003"</span> +<span class="c1"># }</span> </pre></div> </div> -<div class="section" id="authors"> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">ΒΆ</a></h3> <ul class="simple"> <li><p>Janos Gerzson (@grzs)</p></li> </ul> +<div class="admonition hint"> +<p class="admonition-title">Hint</p> +<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p> </div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -262,11 +232,48 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_volume_info_module.html" title="previous chapter">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> + <li>Next: <a href="buildah_connection.html" title="next chapter">containers.podman.buildah connection β Interact with an existing buildah container</a></li> </ul></li> </ul> </div> @@ -296,8 +303,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_unshare_become.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_volume_info_module.html b/ansible_collections/containers/podman/docs/podman_volume_info_module.html index 0b045908f..94481a108 100644 --- a/ansible_collections/containers/podman/docs/podman_volume_info_module.html +++ b/ansible_collections/containers/podman/docs/podman_volume_info_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_volume_info β Gather info about podman volumes — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_volume_info module β Gather info about podman volumes — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_unshare become β Run tasks using podman unshare" href="podman_unshare_become.html" /> + <link rel="prev" title="containers.podman.podman_volume module β Manage Podman volumes" href="podman_volume_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,15 +33,19 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-volume-info-module"></span><div class="section" id="containers-podman-podman-volume-info-gather-info-about-podman-volumes"> -<h1>containers.podman.podman_volume_info β Gather info about podman volumes<a class="headerlink" href="#containers-podman-podman-volume-info-gather-info-about-podman-volumes" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-volume-info-module"></span><section id="containers-podman-podman-volume-info-module-gather-info-about-podman-volumes"> +<h1>containers.podman.podman_volume_info module β Gather info about podman volumes<a class="headerlink" href="#containers-podman-podman-volume-info-module-gather-info-about-podman-volumes" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_volume_info</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -48,107 +53,94 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Gather info about podman volumes with podman inspect command.</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-volume-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>Podman installed on host</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Name of the volume</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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">Gather info about all present volumes</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_volume_info</span><span class="p">:</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">Gather info about specific volume</span><span class="w"></span> -<span class="w"> </span><span class="nt">podman_volume_info</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">specific_volume</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-info-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></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-containers-podman-podman-volume-info-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></p> +</div></td> +<td><div class="ansible-option-cell"><p>Name of the volume</p> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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">Gather info about all present volumes</span> +<span class="w"> </span><span class="nt">podman_volume_info</span><span class="p">:</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">Gather info about specific volume</span> +<span class="w"> </span><span class="nt">podman_volume_info</span><span class="p">:</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">specific_volume</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-volumes"></div> - <b>volumes</b> - <a class="ansibleOptionLink" href="#return-volumes" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td>always</td> - <td> - <div>Facts from all or specified volumes</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{'driver': 'local', 'labels': {}, 'mountPoint': '/home/ansible/.local/share/testvolume/_data', 'name': 'testvolume', 'options': {}, 'scope': 'local'}]</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-info-module-return-volumes"><strong>volumes</strong></p> +<a class="ansibleOptionLink" href="#return-volumes" 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-cell"><p>Facts from all or specified volumes</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"driver":</span> <span class="pre">"local",</span> <span class="pre">"labels":</span> <span class="pre">{},</span> <span class="pre">"mountPoint":</span> <span class="pre">"/home/ansible/.local/share/testvolume/_data",</span> <span class="pre">"name":</span> <span class="pre">"testvolume",</span> <span class="pre">"options":</span> <span class="pre">{},</span> <span class="pre">"scope":</span> <span class="pre">"local"}]</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -167,11 +159,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_volume_module.html" title="previous chapter">containers.podman.podman_volume module β Manage Podman volumes</a></li> + <li>Next: <a href="podman_unshare_become.html" title="next chapter">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> </ul></li> </ul> </div> @@ -201,8 +230,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_volume_info_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/podman_volume_module.html b/ansible_collections/containers/podman/docs/podman_volume_module.html index ef6400aa0..d982f9e1b 100644 --- a/ansible_collections/containers/podman/docs/podman_volume_module.html +++ b/ansible_collections/containers/podman/docs/podman_volume_module.html @@ -1,21 +1,22 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman_volume β Manage Podman volumes — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman_volume module β Manage Podman volumes — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="next" title="containers.podman.podman_volume_info module β Gather info about podman volumes" href="podman_volume_info_module.html" /> + <link rel="prev" title="containers.podman.podman_tag module β Add an additional name to a local image" href="podman_tag_module.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,18 +33,20 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-volume-module"></span><div class="section" id="containers-podman-podman-volume-manage-podman-volumes"> -<h1>containers.podman.podman_volume β Manage Podman volumes<a class="headerlink" href="#containers-podman-podman-volume-manage-podman-volumes" title="Permalink to this heading">ΒΆ</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-volume-module"></span><section id="containers-podman-podman-volume-module-manage-podman-volumes"> +<h1>containers.podman.podman_volume module β Manage Podman volumes<a class="headerlink" href="#containers-podman-podman-volume-module-manage-podman-volumes" title="Permalink to this heading">ΒΆ</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</p> -<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p> +<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.0).</p> +<p>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">containers.podman</span></code>. +You need further requirements to be able to use this module, +see <a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_volume</span></code>.</p> </div> -<div class="versionadded"> -<p><span class="versionmodified added">New in version 1.1.0: </span>of containers.podman</p> -</div> -<div class="contents local topic" id="contents"> +<p class="ansible-version-added">New in containers.podman 1.1.0</p> +<nav class="contents local" 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="#requirements" id="id2">Requirements</a></p></li> @@ -51,213 +54,155 @@ <li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li> <li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">ΒΆ</a></h2> <ul class="simple"> <li><p>Manage Podman volumes</p></li> </ul> -</div> -<div class="section" id="requirements"> -<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="requirements"> +<span id="ansible-collections-containers-podman-podman-volume-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">ΒΆ</a></h2> <p>The below requirements are needed on the host that executes this module.</p> <ul class="simple"> <li><p>podman</p></li> </ul> -</div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-debug"></div> - <b>debug</b> - <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Return additional information which can be helpful for investigations.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-driver"></div> - <b>driver</b> - <a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Specify volume driver name (default local).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-executable"></div> - <b>executable</b> - <a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-label"></div> - <b>label</b> - <a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Add metadata to a pod volume (e.g., label com.example.key=value).</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-name"></div> - <b>name</b> - <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Name of volume.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-options"></div> - <b>options</b> - <a class="ansibleOptionLink" href="#parameter-options" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">list</span> - / <span style="color: purple">elements=string</span> </div> - </td> - <td> - </td> - <td> - <div>Set driver specific options. For example 'device=tpmfs', 'type=tmpfs'. UID and GID idempotency is not supported due to changes in podman.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-recreate"></div> - <b>recreate</b> - <a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>no</b> ←</div></li> - <li>yes</li> - </ul> - </td> - <td> - <div>Recreate volume even if exists.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-state"></div> - <b>state</b> - <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>present</b> ←</div></li> - <li>absent</li> - </ul> - </td> - <td> - <div>State of volume, default 'present'</div> - </td> - </tr> - </table> -<br/></div> -<div class="section" id="examples"> -<h2><a class="toc-backref" href="#id4">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="c1"># What modules does for example</span><span class="w"></span> -<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">podman_volume</span><span class="p">:</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="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">volume1</span><span class="w"></span> -<span class="w"> </span><span class="nt">label</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value</span><span class="w"></span> -<span class="w"> </span><span class="nt">key2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value2</span><span class="w"></span> -<span class="w"> </span><span class="nt">options</span><span class="p">:</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"device=/dev/loop1"</span><span class="w"></span> -<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"type=ext4"</span><span class="w"></span> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">ΒΆ</a></h2> +<table class="longtable 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-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-debug"><strong>debug</strong></p> +<a class="ansibleOptionLink" href="#parameter-debug" 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>Return additional information which can be helpful for investigations.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-driver"><strong>driver</strong></p> +<a class="ansibleOptionLink" href="#parameter-driver" 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>Specify volume driver name (default local).</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-executable"><strong>executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-label"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-label"><strong>label</strong></p> +<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p> +</div></td> +<td><div class="ansible-option-cell"><p>Add metadata to a pod volume (e.g., label com.example.key=value).</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-containers-podman-podman-volume-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 volume.</p> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-options"><strong>options</strong></p> +<a class="ansibleOptionLink" href="#parameter-options" 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>Set driver specific options. For example βdevice=tpmfsβ, βtype=tmpfsβ. UID and GID idempotency is not supported due to changes in podman.</p> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-recreate"><strong>recreate</strong></p> +<a class="ansibleOptionLink" href="#parameter-recreate" 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>Recreate volume even if exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-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 of volume, default βpresentβ</p> +<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p> +<ul class="simple"> +<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">β (default)</span></p></li> +<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +</section> +<section id="examples"> +<h2><a class="toc-backref" href="#id4" role="doc-backlink">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="c1"># What modules does for example</span> +<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">podman_volume</span><span class="p">:</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="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">volume1</span> +<span class="w"> </span><span class="nt">label</span><span class="p">:</span> +<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value</span> +<span class="w"> </span><span class="nt">key2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value2</span> +<span class="w"> </span><span class="nt">options</span><span class="p">:</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"device=/dev/loop1"</span> +<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"type=ext4"</span> </pre></div> </div> -</div> -<div class="section" id="return-values"> -<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> +</section> +<section id="return-values"> +<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">ΒΆ</a></h2> <p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Key</th> - <th>Returned</th> - <th width="100%">Description</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="return-volume"></div> - <b>volume</b> - <a class="ansibleOptionLink" href="#return-volume" title="Permalink to this return value"></a> - <div style="font-size: small"> - <span style="color: purple">dictionary</span> - </div> - </td> - <td>always</td> - <td> - <div>Volume inspection results if exists.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'CreatedAt': '2020-06-05T16:38:55.277628769+03:00', 'Driver': 'local', 'Labels': {'key.com': 'value', 'key.org': 'value2'}, 'Mountpoint': '/home/user/.local/share/containers/storage/volumes/test/_data', 'Name': 'test', 'Options': {}, 'Scope': 'local'}</div> - </td> - </tr> - </table> -<br/><br/><div class="section" id="authors"> +<table class="longtable 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-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-return-volume"><strong>volume</strong></p> +<a class="ansibleOptionLink" href="#return-volume" 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>Volume inspection results if exists.</p> +<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p> +<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"CreatedAt":</span> <span class="pre">"2020-06-05T16:38:55.277628769+03:00",</span> <span class="pre">"Driver":</span> <span class="pre">"local",</span> <span class="pre">"Labels":</span> <span class="pre">{"key.com":</span> <span class="pre">"value",</span> <span class="pre">"key.org":</span> <span class="pre">"value2"},</span> <span class="pre">"Mountpoint":</span> <span class="pre">"/home/user/.local/share/containers/storage/volumes/test/_data",</span> <span class="pre">"Name":</span> <span class="pre">"test",</span> <span class="pre">"Options":</span> <span class="pre">{},</span> <span class="pre">"Scope":</span> <span class="pre">"local"}</span></code></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>Sagi Shnaidman (@sshnaidm)</p></li> </ul> -</div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">ΒΆ</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -276,11 +221,48 @@ <h3>Navigation</h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="podman_tag_module.html" title="previous chapter">containers.podman.podman_tag module β Add an additional name to a local image</a></li> + <li>Next: <a href="podman_volume_info_module.html" title="next chapter">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> </ul></li> </ul> </div> @@ -310,8 +292,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_volume_module.rst.txt" diff --git a/ansible_collections/containers/podman/docs/search.html b/ansible_collections/containers/podman/docs/search.html index 3057e9a7f..aeb228ad7 100644 --- a/ansible_collections/containers/podman/docs/search.html +++ b/ansible_collections/containers/podman/docs/search.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -11,10 +10,8 @@ <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <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/sphinx_highlight.js"></script> <script src="_static/searchtools.js"></script> <script src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> @@ -85,6 +82,41 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module β Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module β Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module β Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module β Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module β Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module β Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module β Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module β Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module β Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module β Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module β Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module β Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module β Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module β Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module β Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module β Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module β Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module β Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module β Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module β Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module β Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module β Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module β Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module β Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module β Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module β Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become β Run tasks using podman unshare</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection β Interact with an existing buildah container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection β Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> @@ -109,8 +141,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> </div> |