From 9b31d8f01d25649fdac885aa78f1acfdc3bc1c90 Mon Sep 17 00:00:00 2001 From: Sergey <6213510+sshnaidm@users.noreply.github.com> Date: Sat, 4 Nov 2023 12:28:13 +0200 Subject: [PATCH] Release 1.11.0 version (#666) Signed-off-by: Sagi Shnaidman --- CHANGELOG.rst | 8 + changelogs/changelog.yaml | 5 + docs/_static/alabaster.css | 4 +- docs/_static/antsibull-minimal.css | 3 +- docs/_static/basic.css | 47 +- docs/_static/doctools.js | 132 +- docs/_static/documentation_options.js | 2 +- docs/_static/language_data.js | 2 +- docs/_static/pygments.css | 1 + docs/_static/searchtools.js | 93 +- docs/buildah_connection.html | 189 +- docs/genindex.html | 100 +- docs/index.html | 161 +- docs/objects.inv | Bin 1193 -> 6664 bytes docs/podman_connection.html | 279 +- docs/podman_container_info_module.html | 246 +- docs/podman_container_module.html | 3518 ++++++++-------------- docs/podman_containers_module.html | 203 +- docs/podman_export_module.html | 239 +- docs/podman_generate_systemd_module.html | 786 +++-- docs/podman_image_info_module.html | 238 +- docs/podman_image_module.html | 1198 ++++---- docs/podman_import_module.html | 284 +- docs/podman_load_module.html | 225 +- docs/podman_login_info_module.html | 256 +- docs/podman_login_module.html | 308 +- docs/podman_logout_module.html | 284 +- docs/podman_network_info_module.html | 232 +- docs/podman_network_module.html | 654 ++-- docs/podman_play_module.html | 575 ++-- docs/podman_pod_info_module.html | 232 +- docs/podman_pod_module.html | 1500 ++++----- docs/podman_save_module.html | 331 +- docs/podman_secret_module.html | 373 ++- docs/podman_tag_module.html | 202 +- docs/podman_unshare_become.html | 398 +-- docs/podman_volume_info_module.html | 228 +- docs/podman_volume_module.html | 399 ++- docs/search.html | 43 +- docs/searchindex.js | 2 +- galaxy.yml | 2 +- 41 files changed, 6473 insertions(+), 7509 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 27a9e66a..ca7b7e2b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,14 @@ Ansible Podman modules and plugins Release Notes .. contents:: Topics +v1.11.0 +======= + +Minor Changes +------------- + +- Update docs + v1.10.4 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 42c0a08e..df32454c 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -222,6 +222,11 @@ releases: name: podman_runlabel namespace: '' release_date: '2023-11-01' + 1.11.0: + changes: + minor_changes: + - Update docs + release_date: '2023-11-05' 1.2.0: changes: minor_changes: diff --git a/docs/_static/alabaster.css b/docs/_static/alabaster.css index 0eddaeb0..517d0b29 100644 --- a/docs/_static/alabaster.css +++ b/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/docs/_static/antsibull-minimal.css b/docs/_static/antsibull-minimal.css index 6f287270..3b17984c 100644 --- a/docs/_static/antsibull-minimal.css +++ b/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/docs/_static/basic.css b/docs/_static/basic.css index 7d5974c3..7577acb1 100644 --- a/docs/_static/basic.css +++ b/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/docs/_static/doctools.js b/docs/_static/doctools.js index c3db08d1..d06a71d7 100644 --- a/docs/_static/doctools.js +++ b/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(); @@ -18,73 +25,11 @@ 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(); }, @@ -126,51 +71,6 @@ const Documentation = { Documentation.LOCALE = catalog.locale; }, - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords: () => { - const highlight = - new URLSearchParams(window.location.search).get("highlight") || ""; - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '

' + - '' + - Documentation.gettext("Hide Search Matches") + - "

" - ) - ); - }, - - /** - * 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 */ @@ -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/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index a750e4d5..b57ae3b8 100644 --- a/docs/_static/documentation_options.js +++ b/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/docs/_static/language_data.js b/docs/_static/language_data.js index 2e22b06a..250f5665 100644 --- a/docs/_static/language_data.js +++ b/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/docs/_static/pygments.css b/docs/_static/pygments.css index 87f8bd12..9abe04ba 100644 --- a/docs/_static/pygments.css +++ b/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/docs/_static/searchtools.js b/docs/_static/searchtools.js index ac4d5861..97d56a74 100644 --- a/docs/_static/searchtools.js +++ b/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/docs/buildah_connection.html b/docs/buildah_connection.html index e0df468d..a20951e7 100644 --- a/docs/buildah_connection.html +++ b/docs/buildah_connection.html @@ -1,21 +1,22 @@ - - - containers.podman.buildah – Interact with an existing buildah container — Python documentation + + + + containers.podman.buildah connection – Interact with an existing buildah container — Python documentation - - - + + + @@ -32,93 +33,89 @@
-
-

containers.podman.buildah – Interact with an existing buildah containerΒΆ

+
+

containers.podman.buildah connection – Interact with an existing buildah containerΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This connection plugin is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.buildah.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Run commands or put/fetch files to an existing container using buildah tool.

+
+
+

ParametersΒΆ

+ + + + + + + + + + + + + + +

Parameter

Comments

+

remote_addr

+

string

+

The ID of the container you want to access.

+

Default: "inventory_hostname"

+

Configuration:

+
    +

  • Variable: ansible_host

    • +

  • Variable: inventory_hostname

    • +
+
+

remote_user

+

string

+

User specified via name or ID which is used to execute commands inside the container.

+

Configuration:

+
    +

  • INI entry:

    +
    [defaults]
+remote_user = VALUE
+
    -
    -

    ParametersΒΆ

    - - - - - - - - - - - - - - - - - - - -
    ParameterChoices/DefaultsConfigurationComments
    -
    - remote_addr - -
    - string -
    -     		- Default:
    "inventory_hostname"
    -     		-
    - var: ansible_host -
    -     		-
    The ID of the container you want to access.
    -
    -
    - remote_user - -
    - string -
    -     		- -
    ini entries: -

    - [defaults]
    remote_user = None -

    -
    -
    - env:ANSIBLE_REMOTE_USER -
    -
    - var: ansible_user -
    -     		-
    User specified via name or ID which is used to execute commands inside the container.
    -
    -
    +
    • +

  • Environment variable: ANSIBLE_REMOTE_USER

    • +

  • Variable: ansible_user

    • +
+
+

AuthorsΒΆ

  • Tomas Tomecek (@TomasTomecek)

+
+

Hint

+

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.

-
-
+ + + +
@@ -137,11 +134,47 @@

Python

Navigation

+ + +

Related Topics

@@ -171,8 +204,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | @@ -10,10 +9,8 @@ - - - + @@ -36,8 +33,65 @@

Index

+ A + | E
+

A

+ + + +
+ +

E

+ + +
+ @@ -56,6 +110,40 @@

Python

Navigation

+ + +

Related Topics

@@ -90,8 +178,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13
diff --git a/docs/index.html b/docs/index.html index 8ded11c9..c625626b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,21 +1,21 @@ - - + + + Containers.Podman — Python documentation - - - + + @@ -32,60 +32,88 @@
-
+

Containers.PodmanΒΆ

-

Collection version 1.10.1

-
-
-
-

Plugin IndexΒΆ

-

These are the plugins in the containers.podman collection

-
-

Become PluginsΒΆ

+

Collection version 1.11.0

+
-
-

Connection PluginsΒΆ

+ +
+

DescriptionΒΆ

+

Podman container Ansible modules

+

Authors:

    -

  • buildah – Interact with an existing buildah container

    • -

  • podman – Interact with an existing podman container

    • +

  • Sagi Shnaidman <sshnaidm@redhat.com>

    • +

  • Ansible team

+

Supported ansible-core versions:

+
    +

  • 2.8 or newer

    • +
+ +
-
+
+
+

Plugin IndexΒΆ

+

These are the plugins in the containers.podman collection:

+

ModulesΒΆ

-
-

See also

-

List of collections with docs hosted here.

-
+
+
+
+

Become PluginsΒΆ

+ +
+
+
+

Connection PluginsΒΆ

+ +
+
+
+
@@ -104,11 +132,46 @@

Python

Navigation

+ + +

Related Topics

@@ -138,8 +201,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | HGJCkmY~S=H(^t4u3kR|FDiXHEm?3eqs5sqT=VXtgD~wIe+Be4&=ipcbl)j|K-c4 zzh$5Q>+>&v{QZ;q1>|Ob|Mn^S^zE;^oPGb}FTZPFyYI305t*C(@%{6+kelR#I#Iqb;(E<7Dsk@mUkzS8b|38qYHxLO}^1ULK5#5 zg!{A`8zC^|+5;v*WHm2)e~P$2GmO9`ikrknHlPWmd_zUk`p`^E zC2bNYu!46?^~$^FlHr049$?ryD*Mhxz!}3xVIu>Cm9SJ@fd{0tL0J?C?K(Ujrw`4< zdx^@V^?yN_I{MF^si2=WQlJox<#7@fHbN8e|6)njC467H?GEX0E$ zvo@d!Hw1ri+4cp06DpTHua_Z!-FpCGdmx*LLj{~oY|0@3Aok`9Gp!M2nVq>)ttgNIjtf0tr#JK>3Eb>-2>mz_EWt|H`!;~Fwk!XxGEKYu86_bn#9Hgr} zB-W|peXD;^VFw16(I-wH9IO#&OihIMghvAl!%CzuVo-*JsmsMq<(M>e8QQPx$Jx|> z7Jr3iZ?D-LOjGkFYw^A}V}P^~KD)NhTG}y=@~YaNIB{U4fA*^0f<$Dsfq^=S`JAusuz%DY=xg4{ zcTr+lBao;}oq{o$!3jg6m?8f-6HV-Jf8ePmXk+8yhsLXFLnY6}nHJ9oJY)4ZP}x(? zs=lLHULbWK#Yh%&~A=;VqXMd5cFCG*HO>2`~iw4aB3Atg>i8wq?8WKm!HfuZn1EV28 zixVpjh{WprgzVtH8nmt-)6Ol$D*z>oKZ3N}M=xV5Ew^;G`Z!WVL~Tcq@@` zv@$%*$2$L!3HC3FM@5tcVk|_!LyAWSH0Y3Yz>@h1kxHw>L+KmfK^gTpQ12j(nd>8_ zGlPkn*39*h(wo6UO@DLddf;?d=Y`p$h6;>yr_{-y4he--1A(u4*gNWh>$+D6sWZ-+ zAY&8oh~gEc4BOiQ%7&>#Yf1oWLC^(;a6Dm4`2!_um- z5PH)Q91x=n50m8;%LU5d0q1}W4kExIwZsl&(5JX#M8WlttMVU6Y(}4GeL%35VT{0OSqTh*l|3kF@T@`IQ)CsZQM#P9 zII-f8NGJonTG%mNShKFdXIpRHelQ9Rz@~#UNd2*50;6qfP=<$5@mz%mM6^0Q6wWty z(T)Lxwj9I70e^fJVOAOBO@+}+XOfpWCJx+RoO)F><*x{$H+dB$0mI&`fWKSKh@ra0#2gK4N%y5=b z8I*xxSaZtofRsAS$}k<3eK(Rz#&ajU7sYi3)imW`>WS#L(I0^@!g*T;5C8)CWwjnY+{J- zc`glrag@}vGgB-CBM9YwW$&U`4B@*Lc}dI;E=eJ*B9#Ay8b>UEu)4;SU^VlEH4l_& z-Y&Vklzn>64M4eDUpXvG^%xp|O#WSXqSKID7w~kOHr`1Ix_8%|4b0wRCM9P`(X)Zg zw}0tmO0+E*MtEZuvgOt z(&ZhRQgQ}w&$NYdbyKFKql%UE<*mj>ADE<2` zr6dg6bjeHSI+89e*|qwoL}HwHA%hoS(&6X6VQ4RNYK2%UK%A=$ZYl6U8sY3#0jzoA zOU-Y0X9a-RT>rh7_gvY1q+4so}#=V zq|m_tMTj3P6jBgjpdv&P7}+>@){PuS#Ec^Ff`~{l1ab%wGlD=1AmYRisDI%@yyyWj zc!(7{AcYPwA_v64Ay(Xg7&b(R8j3tCXeYh%lH<@6Ink;i^O1cZn>w7KIrerlKQd@M z4nffHaG&{=?r~`E;ho|$Lxyu9UU`?Y!|fsoh9J*L?Mtve=eGAO>L1B^|M)8Ye(NIX zQ}4wY(t7HsU2B4d>KBNQ1%Izw@1CHMX~;z!9Lqb&EjCif#I|iXtVvz5pHdC_;Bd+7 zAy+QgddL;YuKsTqvz2{EagvvHK}IgXLG`_};~NT|)+Wa{cqrMa8|t~@C|Fl@ATa*| z(Q#0M7KZkj_wBQvObvx3a4d+eEtdS_zuT(Bti0cM3Q60K&H zahdjHn+sGOJuxA>Hx#Ce_zSh zbDF8~(oXsYlEfhx6oCLXWvtK)d$ZFA2Q$Qh2p!DeL)cIlKqKrc0v>H|j>8b#-t2=| zY;TUk5Zc~6LD*P+!FY!&wRkUAimmGzVXoEn;RV-Kd{T0G2Je8nB~v{x?<=Kl9Dwk0 zcb;Os+={}ntAFI0Ct;_CcQh+`@l3m{=xC|Z5z8x)6wJCH)&&{6fZ|*$-=bjcDB(sF zTe4O_`#_m%L#5sYX|+9L=DYv|cb7eF8Z$;7Nb=DzK$8Con>XM{K@}2u%<{MjxjQBj z1Kp|v5UnQsm^7f7z=rg{+y1^(|Hzh7z?S!JCbfXTgn!O0va%7WL98+<8v%&Zu@}!u z>Jdq-C>X@Xas(b^f9dha?3s8RK{IIl2&Y`q*ZeIp#Gnd>!5XP+@l|4ui!2;Sn|0oi zND)C=(uIshS^|0b_v8>t5)7cuiK{xEj+`XkoF#cw=%JRtq5uVBNM#x zjUgh62t3J{F~ zTY_}7=xF-v>mmyV;-AhFk0NMF&jLb!Y-sA#;Y4>rOk0SOAlyjq1K8Xg1?L{55vr~7 zx1|=S(eVJ!`s%>8r;+gHE;2B)0NrCA|Ne#4V}F5s%O!D<4&2Y=IX4F5rm#vbP@t&=hAhqp_57@qqh&5~xIT9E+epcOx5 z3ys||5R_zKQ}+TxMPF!@6u~OO5G)01G5iNcX&(2BV-jQ74;_){@voviPn;jayj6p7 zzJFL(W;}bP>~u~AU?ho?1c%5<`oao|z(Sld2vTwCc;99VU3l;?Rx_~o&V$kRnK6XWTVk&X);IyLirb_j>QtR zKJ^kp!bEKe0F!m9jFbUoqSk2|&rSi%c9t;N8U+HESnIsV^0M@98VOIJ6v?0ngFtKE zrK(UmF+k&)cuf}eSVdwKL4ObuW|452GiF_EfsVNe6H zzC8a2+Y$K13|5go{U1XV+5rKW1$&73PD&S z{E~TukIL>m4*WqawtqTB!3b@6S_VLPA49_p@Eft6*a>4ka`1)F6y6ZukXx?Kf1#>*b54Ns;eQT+70w$257cbHt%KBW z7I^$soR}y<6`chN{{Wbn6hT8_ZYfq1F+2fKQWp8kVvEt}cz|hrbzt%x2~S&E>ef3{ z2h1#)5rpwyQqSrxF}xcw7~d;dW(@b?S*3@;zcEw{`$1bm`JLCfOle)q!Fcx{>ASTv51VPRAM>qRiA zcc5Ze=BK4H_yF z1Bb>aLx1Dwk)Sv@M)^S;*TKBDsQmqD0sdW|@{XnD?`=F#bVXtSDaw|?yn%Ckq>vDL z4rW82Xe^k0{i8E5s|8*>5|9GW*;`NUd%f>Ug2|H~ejVNM!}T=hVRXhX*N5=cJcJLGV$1l`=!3|V zXYKXoCHqN!()S?zY4nzfI-8h#JVvSB{S0Mmb|V{Me6it~yy3rxxwON?#9Nxnx2sh8jd;#nv2?dJ!1zOQ#}31>zG3q4)bZLHKJd<@g&WIu zq|5Rbe|OG`&FlFyU%L6(e&}xK{oF@xZ?WQNyP2_%uf59Ko%EA>D7~PEWu*prmdB!^0;|3FDpNsR86}%bo8W(o$hUFbH(9ybJK^U ze~^5fdM^62AFsNF`n(t2T#v8Y(Me_M=b(SmQOZ_F!z9M#_c(Lbio5X@%YSLzWtqd2 zm0M%0o*uE|FFbDLM?25XXy5Kjdsy7=c9O^Fzn}Xf?UbU*Xa4)sm)}gfnteNS+s)oM znb~Obu)2@urZ=KD3jHv@ZRWj)t@1N(;OmUs?a~D|g13`k4$HG^#-g99ioXh-YV9Fi z2jIOJp!xA1DyF>{nVZ`(^?x!qmjAFiRbZ06^^MEB>>-ok+8;~~{J}Fgf9m6Q=;L8= zMCDljyZZaWZ}WWhbcX!?gLfq3jsD%ZkHgB45`SW}$1gA8X7t8X_oi?Au+(8b`3}lb zS5oq_WV#BIR|nI;W^(h27kM>(_%nUhQy(*(i-)y7%!9kz@D<2hJV#HXo`XB{!*Xxo z)QYF~S%XhGZ5o{Oni6)%DdDIlxMPP4Em}klSzk8= zs)Q9G(h3+azBMSr4WwVe>_1ezZN4DsJzaQDXYZ->o~qI5!hd_3piN-%$H`@M--D%o zc2UWWQ%%nF)Y77FunW+%jANA@>EI_-5u>p;5q|>gPENK7lzjpzi$ujA7usgaoiR@P={><^5iL1o+9Dv7L_=-!wjnk;L*pPoh2cHlsf@q*+MC* zSwzw8NYREOZ+}`Y`XkVW(a~UKO@irXSVch!AA8bILIf#y0!FjZo(JG&i#R$lJ`#^$ z{!Y8s;5u9EB2bl=J!?IIY+&7u8Ao_&(A9^x=#O9{;IdAi%c^ zEslzzH}Cgt(I3GzjE)7vd568_MYD*38^=fDaa8))=6~)8Fflliswb>M9X@3^r>&h# zH;JHA4pJ54PQo|Z^lkX?XPQNjN+)~vtilL`?q$5;IdpqLbB}5Vr~Ze3fBwQF;o{hy zb9k?L1&9Fts2Q(GIr*E%C*p`-lLCL}FFQSz(H@6pGMg#5g~j)o=Q#2t;sq^!FJr}D z41AXJAb%rVnqC}Fn8<>Y@q)Ua*~1q#NUXX!=@u^gb%c5&`(*^U(j_q2%4nYJ;H86s z;ka^ujTagt;7`OW+`(BeGC-L)VJ(J3&t}xbcfH_ZyANw5dPYR3AY*=5;=ML-0I)j= zm={5079hwF&#T0FGoX{0_W}^OWf%#5$R={8iGNS>>jXZ*51X$PWU{D-Fg@%^&Eee9 zR+0kkM8jaUD}0^OuJ2*Pt-&&l$Nw^mM+18X8#3O8vYlcCIQC65#XO5?=oyCWY6SKt zi>c5dp!a2wk*AjBYf}pJ5Fo6!2q7Zl2#HFomXxpjOviZoIJM;}u%Rp=pi?bLB|C1fx)O|fz?EDC zpX?k%Jru=ownRly59d - - containers.podman.podman – Interact with an existing podman container — Python documentation + + + + containers.podman.podman connection – Interact with an existing podman container — Python documentation - - - + + @@ -32,152 +32,122 @@
-
-

containers.podman.podman – Interact with an existing podman containerΒΆ

+
+

containers.podman.podman connection – Interact with an existing podman containerΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This connection plugin is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Run commands or put/fetch files to an existing container using podman tool.

+
+
+

ParametersΒΆ

+ + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

podman_executable

+

string

+

Executable for podman command.

+

Default: "podman"

+

Configuration:

+ +
+

podman_extra_args

+

string

+

Extra arguments to pass to the podman command line.

+

Default: ""

+

Configuration:

+
    +

  • INI entry:

    +
    [defaults]
+podman_extra_args = ""
+
    +
    +
    • +

  • Environment variable: ANSIBLE_PODMAN_EXTRA_ARGS

    • +

  • Variable: ansible_podman_extra_args

    • +
+
+

remote_addr

+

string

+

The ID of the container you want to access.

+

Default: "inventory_hostname"

+

Configuration:

+
    +

  • Variable: ansible_host

    • +

  • Variable: inventory_hostname

    • +

  • Variable: ansible_podman_host

    • +
+
+

remote_user

+

string

+

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 ANSIBLE_REMOTE_TMP to a path that exits inside the container and is writable by Ansible.

+

Configuration:

+
    +

  • INI entry:

    +
    [defaults]
+remote_user = VALUE
+
    -
    -

    ParametersΒΆ

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterChoices/DefaultsConfigurationComments
    -
    - podman_executable - -
    - string -
    -     		- Default:
    "podman"
    -     		-
    - env:ANSIBLE_PODMAN_EXECUTABLE -
    -
    - var: ansible_podman_executable -
    -     		-
    Executable for podman command.
    -
    -
    - podman_extra_args - -
    - string -
    -     		- Default:
    ""
    -     		-
    ini entries: -

    - [defaults]
    podman_extra_args = -

    -
    -
    - env:ANSIBLE_PODMAN_EXTRA_ARGS -
    -
    - var: ansible_podman_extra_args -
    -     		-
    Extra arguments to pass to the podman command line.
    -
    -
    - remote_addr - -
    - string -
    -     		- Default:
    "inventory_hostname"
    -     		-
    - var: ansible_host -
    -
    - var: inventory_hostname -
    -
    - var: ansible_podman_host -
    -     		-
    The ID of the container you want to access.
    -
    -
    - remote_user - -
    - string -
    -     		- -
    ini entries: -

    - [defaults]
    remote_user = None -

    -
    -
    - env:ANSIBLE_REMOTE_USER -
    -
    - var: ansible_user -
    -     		-
    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 ANSIBLE_REMOTE_TMP to a path that exits inside the container and is writable by Ansible.
    -
    -
    +
    • +

  • Environment variable: ANSIBLE_REMOTE_USER

    • +

  • Variable: ansible_user

    • +
+
+

AuthorsΒΆ

  • Tomas Tomecek (@TomasTomecek)

+
+

Hint

+

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.

-
-
+ + + +
@@ -196,11 +166,46 @@

Python

Navigation

+ + +

Related Topics

@@ -230,8 +235,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_container_info – Gather facts about containers using podman — Python documentation + + + + containers.podman.podman_container_info module – Gather facts about containers using podman — Python documentation - - - + + + @@ -32,15 +33,19 @@
-
-

containers.podman.podman_container_info – Gather facts about containers using podmanΒΆ

+
+

containers.podman.podman_container_info module – Gather facts about containers using podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_container_info.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Gather facts about containers using podman

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- name - -
- list - / elements=string
- 		- -
List of container names to gather facts about. If no name is given return facts about all containers.
-
-
-
-

NotesΒΆ

+ +
+

ParametersΒΆ

+ + + + + + + + + + + + + + +

Parameter

Comments

+

executable

+

string

+

Path to podman executable if it is not in the $PATH on the machine running podman

+

Default: "podman"

+
+

name

+

list / elements=string

+

List of container names to gather facts about. If no name is given return facts about all containers.

+
+
+
+

NotesΒΆ

Note

  • Podman may require elevated privileges in order to run properly.

-
-
-

ExamplesΒΆ

-
- name: Gather facts for all containers
-  containers.podman.podman_container_info:
-
-- name: Gather facts on a specific container
-  containers.podman.podman_container_info:
-    name: web1
-
-- name: Gather facts on several containers
-  containers.podman.podman_container_info:
-    name:
-      - redis
-      - web1
+
+

+
ExamplesΒΆ

+
- name: Gather facts for all containers
+  containers.podman.podman_container_info:
+
+- name: Gather facts on a specific container
+  containers.podman.podman_container_info:
+    name: web1
+
+- name: Gather facts on several containers
+  containers.podman.podman_container_info:
+    name:
+      - redis
+      - web1
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- containers - -
- list - / elements=dictionary
- 		always -
Facts from all or specified containers
-
-
Sample:
-
[{'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'}}]
-
-

+ + + + + + + + + + + +

Key

Description

+

containers

+

list / elements=dictionary

+

Facts from all or specified containers

+

Returned: always

+

Sample: [{"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": null, "OpenStdin": false, "StdinOnce": false, "StopSignal": 15, "Tty": false, "User": "", "Volumes": null, "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": null, "BlkioDeviceReadIOps": null, "BlkioDeviceWriteBps": null, "BlkioDeviceWriteIOps": null, "BlkioWeight": 0, "BlkioWeightDevice": null, "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": null, "LogConfig": {"Config": null, "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": null}, "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": null, "SecondaryIPv6Addresses": null}, "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": null, "Status": ""}, "OOMKilled": false, "OciVersion": "1.0.1-dev", "Paused": false, "Pid": 0, "Restarting": false, "Running": false, "StartedAt": "0001-01-01T00:00:00Z", "Status": "configured"}}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

  • Emilien Macchi (@EmilienM)

-
-
-
+ + + +
@@ -184,11 +176,47 @@

Python

Navigation

+ + +

Related Topics

@@ -218,8 +246,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_container – Manage podman containers — Python documentation + + + + containers.podman.podman_container module – Manage podman containers — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_container – Manage podman containersΒΆ

+
+

containers.podman.podman_container module – Manage podman containersΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_container.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Start, stop, restart and manage Podman containers

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
+

ParametersΒΆ

+
ParameterChoices/DefaultsComments
-
- annotation - -
- dictionary -
- 		- -
Add an annotation to the container. The format is key value, multiple times.
-
-
- authfile - -
- path -
- 		- -
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``
-
-
- blkio_weight - -
- integer -
- 		- -
Block IO weight (relative weight) accepts a weight value between 10 and 1000
-
-
- blkio_weight_device - -
- dictionary -
- 		- -
Block IO weight (relative device weight, format DEVICE_NAME[:]WEIGHT).
-
-
- cap_add - -
- list - / elements=string
- 		- -
List of capabilities to add to the container.
-

aliases: capabilities
-
-
- cap_drop - -
- list - / elements=string
- 		- -
List of capabilities to drop from the container.
-
-
- cgroup_parent - -
- path -
- 		- -
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.
-
-
- cgroupns - -
- string -
- 		- -
Path to cgroups under which the cgroup for the container will be created.
-
-
- cgroups - -
- string -
- 		- -
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.
-
-
- cidfile - -
- path -
- 		- -
Write the container ID to the file
-
-
- cmd_args - -
- list - / elements=string
- 		- -
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.
-
-
- command - -
- raw -
- 		- -
Override command of container. Can be a string or a list.
-
-
- conmon_pidfile - -
- path -
- 		- -
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.
-
-
- cpu_period - -
- integer -
- 		- -
Limit the CPU real-time period in microseconds
-
-
- cpu_rt_period - -
- integer -
- 		- -
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.
-
-
- cpu_rt_runtime - -
- integer -
- 		- -
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.
-
-
- cpu_shares - -
- integer -
- 		- -
CPU shares (relative weight)
-
-
- cpus - -
- string -
- 		- -
Number of CPUs. The default is 0.0 which means no limit.
-
-
- cpuset_cpus - -
- string -
- 		- -
CPUs in which to allow execution (0-3, 0,1)
-
-
- cpuset_mems - -
- string -
- 		- -
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
-
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Return additional information which can be helpful for investigations.
-
-
- detach - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Run container in detach mode
-
-
- detach_keys - -
- string -
- 		- -
Override the key sequence for detaching a container. Format is a single character or ctrl-value
-
-
- device - -
- list - / elements=string
- 		- -
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)
-
-
- device_read_bps - -
- list - / elements=string
- 		- -
Limit read rate (bytes per second) from a device (e.g. device-read-bps /dev/sda:1mb)
-
-
- device_read_iops - -
- list - / elements=string
- 		- -
Limit read rate (IO per second) from a device (e.g. device-read-iops /dev/sda:1000)
-
-
- device_write_bps - -
- list - / elements=string
- 		- -
Limit write rate (bytes per second) to a device (e.g. device-write-bps /dev/sda:1mb)
-
-
- device_write_iops - -
- list - / elements=string
- 		- -
Limit write rate (IO per second) to a device (e.g. device-write-iops /dev/sda:1000)
-
-
- dns - -
- list - / elements=string
- 		- -
Set custom DNS servers
-

aliases: dns_servers
-
-
- dns_option - -
- string -
- 		- -
Set custom DNS options
-

aliases: dns_opts
-
- - dns_search - -
- string -
- 		- -
Set custom DNS search domains (Use dns_search with '' if you don't wish to set the search domain)
-

aliases: dns_search_domains
-
-
- entrypoint - -
- string -
- 		- -
Overwrite the default ENTRYPOINT of the image
-
-
- env - -
- dictionary -
- 		- -
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.
-
-
- env_file - -
- path -
- 		- -
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.
-
-
- env_host - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Use all current host environment variables in container. Defaults to false.
-
-
- etc_hosts - -
- dictionary -
- 		- -
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.
-

aliases: add_hosts
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- expose - -
- list - / elements=string
- 		- -
Expose a port, or a range of ports (e.g. expose "3300-3310") to set up port redirection on the host system.
-

aliases: exposed, exposed_ports
-
-
- force_restart - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Force restart of container.
-

aliases: restart
-
-
- generate_systemd - -
- dictionary -
- 		- Default:
{}
- 		-
Generate systemd unit file for container.
-
-
- after - -
- list - / elements=string
- 		- -
Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.
-
-
- container_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for containers. The default is "container".
-
-
- names - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Use names of the containers for the start, stop, and description in the unit file. Default is true.
-
-
- new - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
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.
-
-
- no_header - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.
-
-
- path - -
- string -
- 		- -
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.
-
-
- pod_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for pods. The default is "pod".
-
-
- requires - -
- list - / elements=string
- 		- -
Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.
-
-
- restart_policy - -
- string -
- 		-
    Choices: -
  • no
    • -
  • on-success
    • -
  • on-failure
    • -
  • on-abnormal
    • -
  • on-watchdog
    • -
  • on-abort
    • -
  • always
    • -
- 		-
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".
-
-
- separator - -
- string -
- 		- -
Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is "-" (dash).
-
-
- time - -
- integer -
- 		- -
Override the default stop timeout for the container with the given value.
-
-
- wants - -
- list - / elements=string
- 		- -
Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.
-
-
- gidmap - -
- list - / elements=string
- 		- -
Run the container in a new user namespace using the supplied mapping.
-
-
- group_add - -
- list - / elements=string
- 		- -
Add additional groups to run as
-

aliases: groups
-
-
- healthcheck - -
- string -
- 		- -
Set or alter a healthcheck command for a container.
-
-
- healthcheck_interval - -
- string -
- 		- -
Set an interval for the healthchecks (a value of disable results in no automatic timer setup) (default "30s")
-
-
- healthcheck_retries - -
- integer -
- 		- -
The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is 3.
-
-
- healthcheck_start_period - -
- string -
- 		- -
The initialization time needed for a container to bootstrap. The value can be expressed in time format like 2m3s. The default value is 0s
-
-
- healthcheck_timeout - -
- string -
- 		- -
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
-
-
- hostname - -
- string -
- 		- -
Container host name. Sets the container host name that is available inside the container.
-
-
- http_proxy - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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
-
-
- image - -
- string -
- 		- -
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, latest will be used.
-
Can also be an image ID. If this is the case, the image is assumed to be available locally.
-
-
- image_strict - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether to compare images in idempotency by taking into account a full name with registry and namespaces.
-
-
- image_volume - -
- string -
- 		-
    Choices: -
  • bind
    • -
  • tmpfs
    • -
  • ignore
    • -
- 		-
Tells podman how to handle the builtin image volumes. The options are bind, tmpfs, or ignore (default bind)
-
-
- init - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Run an init inside the container that forwards signals and reaps processes. The default is false.
-
-
- init_path - -
- string -
- 		- -
Path to the container-init binary.
-
-
- interactive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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.
-
-
- ip - -
- string -
- 		- -
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).
-
-
- ipc - -
- string -
- 		- -
Default is to create a private IPC namespace (POSIX SysV IPC) for the container
-

aliases: ipc_mode
-
-
- kernel_memory - -
- string -
- 		- -
Kernel memory limit (format <number>[<unit>], where unit = b, k, m or g) Note - idempotency is supported for integers only.
-
-
- label - -
- dictionary -
- 		- -
Add metadata to a container, pass dictionary of label names and values
-

aliases: labels
-
-
- label_file - -
- string -
- 		- -
Read in a line delimited file of labels
-
-
- log_driver - -
- string -
- 		-
    Choices: -
  • k8s-file
    • -
  • journald
    • -
  • json-file
    • -
- 		-
Logging driver. Used to set the log driver for the container. For example log_driver "k8s-file".
-
-
- log_level - -
- string -
- 		-
    Choices: -
  • debug
    • -
  • info
    • -
  • warn
    • -
  • error
    • -
  • fatal
    • -
  • panic
    • -
- 		-
Logging level for Podman. Log messages above specified level ("debug"|"info"|"warn"|"error"|"fatal"|"panic") (default "error")
-
-
- log_opt - -
- dictionary -
- 		- -
Logging driver specific options. Used to set the path to the container log file.
-

aliases: log_options
-
-
- max_size - -
- string -
- 		- -
Specify a max size of the log file (e.g 10mb).
-
-
- path - -
- string -
- 		- -
Specify a path to the log file (e.g. /var/log/container/mycontainer.json).
-
-
- tag - -
- string -
- 		- -
Specify a custom log tag for the container.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

annotation

+

dictionary

+

Add an annotation to the container. The format is key value, multiple times.

+
+

authfile

+

path

+

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``

+
+

blkio_weight

+

integer

+

Block IO weight (relative weight) accepts a weight value between 10 and 1000

+
+

blkio_weight_device

+

dictionary

+

Block IO weight (relative device weight, format DEVICE_NAME[:]WEIGHT).

+
+
+

cap_add

+

aliases: capabilities

+

list / elements=string

+

List of capabilities to add to the container.

+
+

cap_drop

+

list / elements=string

+

List of capabilities to drop from the container.

+
+

cgroup_parent

+

path

+

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.

+
+

cgroupns

+

string

+

Path to cgroups under which the cgroup for the container will be created.

+
+

cgroups

+

string

+

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.

+
+

cidfile

+

path

+

Write the container ID to the file

+
+

cmd_args

+

list / elements=string

+

Any additional command options you want to pass to podman command itself, for example --log-level=debug or --syslog. This is NOT command to run in container, but rather options for podman itself. For container command please use command option.

+
+

command

+

any

+

Override command of container. Can be a string or a list.

+
+

conmon_pidfile

+

path

+

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.

+
+

cpu_period

+

integer

+

Limit the CPU CFS (Completely Fair Scheduler) period

+
+

cpu_quota

+

integer

+

Limit the CPU CFS (Completely Fair Scheduler) quota

+
+

cpu_rt_period

+

integer

+

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.

+
+

cpu_rt_runtime

+

integer

+

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.

+
+

cpu_shares

+

integer

+

CPU shares (relative weight)

+
+

cpus

+

string

+

Number of CPUs. The default is 0.0 which means no limit.

+
+

cpuset_cpus

+

string

+

CPUs in which to allow execution (0-3, 0,1)

+
+

cpuset_mems

+

string

+

Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.

+
+

debug

+

boolean

+

Return additional information which can be helpful for investigations.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

detach

+

boolean

+

Run container in detach mode

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+

detach_keys

+

string

+

Override the key sequence for detaching a container. Format is a single character or ctrl-value

+
+

device

+

list / elements=string

+

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)

+
+

device_read_bps

+

list / elements=string

+

Limit read rate (bytes per second) from a device (e.g. device-read-bps /dev/sda:1mb)

+
+

device_read_iops

+

list / elements=string

+

Limit read rate (IO per second) from a device (e.g. device-read-iops /dev/sda:1000)

+
+

device_write_bps

+

list / elements=string

+

Limit write rate (bytes per second) to a device (e.g. device-write-bps /dev/sda:1mb)

+
+

device_write_iops

+

list / elements=string

+

Limit write rate (IO per second) to a device (e.g. device-write-iops /dev/sda:1000)

+
+
+

dns

+

aliases: dns_servers

+

list / elements=string

+

Set custom DNS servers

+
+
+

dns_option

+

aliases: dns_opts

+

string

+

Set custom DNS options

+
+ +

dns_search

+

aliases: dns_search_domains

+

string

+

Set custom DNS search domains (Use dns_search with β€˜β€™ if you don’t wish to set the search domain)

+
+

entrypoint

+

string

+

Overwrite the default ENTRYPOINT of the image

+
+

env

+

dictionary

+

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.

+
+

env_file

+

path

+

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.

+
+

env_host

+

boolean

+

Use all current host environment variables in container. Defaults to false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+
+

etc_hosts

+

aliases: add_hosts

+

dictionary

+

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.

+
+

executable

+

string

+

Path to podman executable if it is not in the $PATH on the machine running podman

+

Default: "podman"

+
+
+
+

expose

+

aliases: exposed, exposed_ports

+

list / elements=string

+

Expose a port, or a range of ports (e.g. expose β€œ3300-3310”) to set up port redirection on the host system.

+
+
+

force_restart

+

aliases: restart

+

boolean

+

Force restart of container.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

generate_systemd

+

dictionary

+

Generate systemd unit file for container.

+

Default: {}

+
+

after

+

list / elements=string

+

Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.

+
+

container_prefix

+

string

+

Set the systemd unit name prefix for containers. The default is β€œcontainer”.

+
+

names

+

boolean

+

Use names of the containers for the start, stop, and description in the unit file. Default is true.

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+

new

+

boolean

+

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.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

no_header

+

boolean

+

Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

path

+

string

+

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.

+
+

pod_prefix

+

string

+

Set the systemd unit name prefix for pods. The default is β€œpod”.

+
+

requires

+

list / elements=string

+

Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.

+
+

restart_policy

+

string

+

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”.

+

Choices:

+
    +

  • "no"

    • +

  • "on-success"

    • +

  • "on-failure"

    • +

  • "on-abnormal"

    • +

  • "on-watchdog"

    • +

  • "on-abort"

    • +

  • "always"

    • +
+
+

restart_sec

+

integer

+

Set the systemd service restartsec value.

+
+

separator

+

string

+

Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is β€œ-” (dash).

+
+

start_timeout

+

integer

+

Override the default start timeout for the container with the given value.

+
+

stop_timeout

+

integer

+

Override the default stop timeout for the container with the given value.

+
+

time

+

integer

+

Override the default stop timeout for the container with the given value.

+
+

wants

+

list / elements=string

+

Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.

+
+

gidmap

+

list / elements=string

+

Run the container in a new user namespace using the supplied mapping.

+
+
+

group_add

+

aliases: groups

+

list / elements=string

+

Add additional groups to run as

+
+

healthcheck

+

string

+

Set or alter a healthcheck command for a container.

+
+

healthcheck_failure_action

+

string

+

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”.

+

Choices:

+
    +

  • "none"

    • +

  • "kill"

    • +

  • "restart"

    • +

  • "stop"

    • +
+
+

healthcheck_interval

+

string

+

Set an interval for the healthchecks (a value of disable results in no automatic timer setup) (default β€œ30s”)

+
+

healthcheck_retries

+

integer

+

The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is 3.

+
+

healthcheck_start_period

+

string

+

The initialization time needed for a container to bootstrap. The value can be expressed in time format like 2m3s. The default value is 0s

+
+

healthcheck_timeout

+

string

+

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

+
+

hooks_dir

+

list / elements=string

+

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.

+
+

hostname

+

string

+

Container host name. Sets the container host name that is available inside the container.

+
+

http_proxy

+

boolean

+

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

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

image

+

string

+

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, latest will be used.

+

Can also be an image ID. If this is the case, the image is assumed to be available locally.

+
+

image_strict

+

boolean

+

Whether to compare images in idempotency by taking into account a full name with registry and namespaces.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

image_volume

+

string

+

Tells podman how to handle the builtin image volumes. The options are bind, tmpfs, or ignore (default bind)

+

Choices:

+
    +

  • "bind"

    • +

  • "tmpfs"

    • +

  • "ignore"

    • +
+
+

init

+

boolean

+

Run an init inside the container that forwards signals and reaps processes. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

init_path

+

string

+

Path to the container-init binary.

+
+

interactive

+

boolean

+

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.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

ip

+

string

+

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).

+
+
+

ipc

+

aliases: ipc_mode

+

string

+

Default is to create a private IPC namespace (POSIX SysV IPC) for the container

+
+

kernel_memory

+

string

+

Kernel memory limit (format <number>[<unit>], where unit = b, k, m or g) Note - idempotency is supported for integers only.

+
+
+

label

+

aliases: labels

+

dictionary

+

Add metadata to a container, pass dictionary of label names and values

+
+

label_file

+

string

+

Read in a line delimited file of labels

+
+

log_driver

+

string

+

Logging driver. Used to set the log driver for the container. For example log_driver β€œk8s-file”.

+

Choices:

+
    +

  • "k8s-file"

    • +

  • "journald"

    • +

  • "json-file"

    • +
+
+

log_level

+

string

+

Logging level for Podman. Log messages above specified level (β€œdebug”|”info”|”warn”|”error”|”fatal”|”panic”) (default β€œerror”)

+

Choices:

+
    +

  • "debug"

    • +

  • "info"

    • +

  • "warn"

    • +

  • "error"

    • +

  • "fatal"

    • +

  • "panic"

    • +
+
+
+

log_opt

+

aliases: log_options

+

dictionary

+

Logging driver specific options. Used to set the path to the container log file.

+
+
+

max_size

+

string

+

Specify a max size of the log file (e.g 10mb).

+
+
+

path

+

string

+

Specify a path to the log file (e.g. /var/log/container/mycontainer.json).

+
+
+

tag

+

string

+

Specify a custom log tag for the container.

+
+

mac_address

+

string

+

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.

+
+

memory

+

string

+

Memory limit (format 10k, where unit = b, k, m or g) Note - idempotency is supported for integers only.

+
+

memory_reservation

+

string

+

Memory soft limit (format 100m, where unit = b, k, m or g) Note - idempotency is supported for integers only.

+
+

memory_swap

+

string

+

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.

+
+

memory_swappiness

+

integer

+

Tune a container’s memory swappiness behavior. Accepts an integer between 0 and 100.

+
+
+

mount

+

aliases: mounts

+

list / elements=string

+

Attach a filesystem mount to the container. bind or tmpfs For example mount β€œtype=bind,source=/path/on/host,destination=/path/in/container”

+
+

name

+

string / required

+

Name of the container

+
+
+
+

network

+

aliases: net, network_mode

+

list / elements=string

+

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

+
+

network_aliases

+

list / elements=string

+

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.

+
+

no_hosts

+

boolean

+

Do not create /etc/hosts for the container Default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

oom_kill_disable

+

boolean

+

Whether to disable OOM Killer for the container or not. Default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

oom_score_adj

+

integer

+

Tune the host’s OOM preferences for containers (accepts -1000 to 1000)

+
+
+

pid

+

aliases: pid_mode

+

string

+

Set the PID mode for the container

+
+

pids_limit

+

string

+

Tune the container’s PIDs limit. Set -1 to have unlimited PIDs for the container.

+
+

pod

+

string

+

Run container in an existing pod. If you want podman to make the pod for you, prefix the pod name with β€œnew:”

+
+

privileged

+

boolean

+

Give extended privileges to this container. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+
+
+
+

publish

+

aliases: ports, published, published_ports

+

list / elements=string

+

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.

+
+

publish_all

+

boolean

+

Publish all exposed ports to random ports on the host interfaces. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

read_only

+

boolean

+

Mount the container’s root filesystem as read only. Default is false

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

read_only_tmpfs

+

boolean

+

If container is running in –read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is true

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

recreate

+

boolean

+

Use with present and started states to force the re-creation of an existing container.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

requires

+

list / elements=string

+

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.

+
+

restart_policy

+

string

+

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

+
+
+
+

rm

+

aliases: remove, auto_remove

+

boolean

+

Automatically remove the container when it exits. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

rootfs

+

boolean

+

If true, the first argument refers to an exploded container on the file system. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

sdnotify

+

string

+

Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Can be container, conmon, ignore.

+
+

secrets

+

list / elements=string

+

Add the named secrets into the container. The format is secret[,opt=opt...], see documentation for more details.

+
+

security_opt

+

list / elements=string

+

Security Options. For example security_opt β€œseccomp=unconfined”

+
+

shm_size

+

string

+

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

+
+

sig_proxy

+

boolean

+

Proxy signals sent to the podman run command to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

state

+

string

+

absent - A container matching the specified name will be stopped and removed.

+

present - 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.

+

started - 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.

+

stopped - Asserts that the container is first present, and then if the container is running moves it to a stopped state.

+

created - 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

+

Choices:

+
    +

  • "absent"

    • +

  • "present"

    • +

  • "stopped"

    • +

  • "started" ← (default)

    • +

  • "created"

    • +
+
+

stop_signal

+

integer

+

Signal to stop a container. Default is SIGTERM.

+
+

stop_timeout

+

integer

+

Timeout (in seconds) to stop a container. Default is 10.

+
+

subgidname

+

string

+

Run the container in a new user namespace using the map with β€˜name’ in the /etc/subgid file.

+
+

subuidname

+

string

+

Run the container in a new user namespace using the map with β€˜name’ in the /etc/subuid file.

+
+

sysctl

+

dictionary

+

Configure namespaced kernel parameters at runtime

+
+

systemd

+

string

+

Run container in systemd mode. The default is true.

+
+

timezone

+

string

+

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.

+
+

tmpfs

+

dictionary

+

Create a tmpfs mount. For example tmpfs β€œ/tmp” β€œrw,size=787448k,mode=1777”

+
+

tty

+

boolean

+

Allocate a pseudo-TTY. The default is false.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

uidmap

+

list / elements=string

+

Run the container in a new user namespace using the supplied mapping.

+
+
+

ulimit

+

aliases: ulimits

+

list / elements=string

+

Ulimit options

+
+

user

+

string

+

Sets the username or UID used and optionally the groupname or GID for the specified command.

+
+
+

userns

+

aliases: userns_mode

+

string

+

Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value means user namespaces are disabled.

+
+

uts

+

string

+

Set the UTS mode for the container

+
+
+

volume

+

aliases: volumes

+

list / elements=string

+

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.

+
+

volumes_from

+

list / elements=string

+

Mount volumes from the specified container(s).

+
+
+

workdir

+

aliases: working_dir

+

string

+

Working directory inside the container. The default working directory for running binaries within a container is the root directory (/).

+
+ +
+

ExamplesΒΆ

+
- name: Run container
+  containers.podman.podman_container:
+    name: container
+    image: quay.io/bitnami/wildfly
+    state: started
 
-                            
-                                                            
-                

-                mac_address
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                    
-        
-                            
-                                                            
-                

-                memory
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Memory limit (format 10k, where unit = b, k, m or g) Note - idempotency is supported for integers only.

-                                                    
-        
-                            
-                                                            
-                

-                memory_reservation
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Memory soft limit (format 100m, where unit = b, k, m or g) Note - idempotency is supported for integers only.

-                                                    
-        
-                            
-                                                            
-                

-                memory_swap
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                    
-        
-                            
-                                                            
-                

-                memory_swappiness
-                
-                

-                    integer
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

-                                                    
-        
-                            
-                                                            
-                

-                mount
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Attach a filesystem mount to the container. bind or tmpfs For example mount "type=bind,source=/path/on/host,destination=/path/in/container"

-                                                            

aliases: mounts

-                                
-        
-                            
-                                                            
-                

-                name
-                
-                

-                    string
-                                             / required                    

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Name of the container

-                                                    
-        
-                            
-                                                            
-                

-                network
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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

-                                                            

aliases: net, network_mode

-                                
-        
-                            
-                                                            
-                

-                network_aliases
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                    
-        
-                            
-                                                            
-                

-                no_hosts
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Do not create /etc/hosts for the container Default is false.

-                                                    
-        
-                            
-                                                            
-                

-                oom_kill_disable
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Whether to disable OOM Killer for the container or not. Default is false.

-                                                    
-        
-                            
-                                                            
-                

-                oom_score_adj
-                
-                

-                    integer
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Tune the host's OOM preferences for containers (accepts -1000 to 1000)

-                                                    
-        
-                            
-                                                            
-                

-                pid
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Set the PID mode for the container

-                                                            

aliases: pid_mode

-                                
-        
-                            
-                                                            
-                

-                pids_limit
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Tune the container's PIDs limit. Set -1 to have unlimited PIDs for the container.

-                                                    
-        
-                            
-                                                            
-                

-                pod
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Run container in an existing pod. If you want podman to make the pod for you, prefix the pod name with "new:"

-                                                    
-        
-                            
-                                                            
-                

-                privileged
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Give extended privileges to this container. The default is false.

-                                                    
-        
-                            
-                                                            
-                

-                publish
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                            

aliases: ports, published, published_ports

-                                
-        
-                            
-                                                            
-                

-                publish_all
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Publish all exposed ports to random ports on the host interfaces. The default is false.

-                                                    
-        
-                            
-                                                            
-                

-                read_only
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Mount the container's root filesystem as read only. Default is false

-                                                    
-        
-                            
-                                                            
-                

-                read_only_tmpfs
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
If container is running in --read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is true

-                                                    
-        
-                            
-                                                            
-                

-                recreate
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                                                                
    Choices:
-                                                                                                                                                            
  • no ←
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Use with present and started states to force the re-creation of an existing container.

-                                                    
-        
-                            
-                                                            
-                

-                requires
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                    
-        
-                            
-                                                            
-                

-                restart_policy
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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

-                                                    
-        
-                            
-                                                            
-                

-                rm
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Automatically remove the container when it exits. The default is false.

-                                                            

aliases: remove, auto_remove

-                                
-        
-                            
-                                                            
-                

-                rootfs
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
If true, the first argument refers to an exploded container on the file system. The default is false.

-                                                    
-        
-                            
-                                                            
-                

-                sdnotify
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Can be container, conmon, ignore.

-                                                    
-        
-                            
-                                                            
-                

-                secrets
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Add the named secrets into the container. The format is secret[,opt=opt...], see documentation for more details.

-                                                    
-        
-                            
-                                                            
-                

-                security_opt
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Security Options. For example security_opt "seccomp=unconfined"

-                                                    
-        
-                            
-                                                            
-                

-                shm_size
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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

-                                                    
-        
-                            
-                                                            
-                

-                sig_proxy
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Proxy signals sent to the podman run command to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.

-                                                    
-        
-                            
-                                                            
-                

-                state
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                        
    Choices:
-                                                                                                                                                            
  • absent
    • 
-                                                                                                                                                                                            
  • present
    • 
-                                                                                                                                                                                            
  • stopped
    • 
-                                                                                                                                                                                            
  • started ←
    • 
-                                                                                                                                                                                            
  • created
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
absent - A container matching the specified name will be stopped and removed.

-                                        
present - 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.

-                                        
started - 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.

-                                        
stopped - Asserts that the container is first present, and then if the container is running moves it to a stopped state.

-                                        
created - 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

-                                                    
-        
-                            
-                                                            
-                

-                stop_signal
-                
-                

-                    integer
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Signal to stop a container. Default is SIGTERM.

-                                                    
-        
-                            
-                                                            
-                

-                stop_timeout
-                
-                

-                    integer
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Timeout (in seconds) to stop a container. Default is 10.

-                                                    
-        
-                            
-                                                            
-                

-                subgidname
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Run the container in a new user namespace using the map with 'name' in the /etc/subgid file.

-                                                    
-        
-                            
-                                                            
-                

-                subuidname
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Run the container in a new user namespace using the map with 'name' in the /etc/subuid file.

-                                                    
-        
-                            
-                                                            
-                

-                sysctl
-                
-                

-                    dictionary
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Configure namespaced kernel parameters at runtime

-                                                    
-        
-                            
-                                                            
-                

-                systemd
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Run container in systemd mode. The default is true.

-                                                    
-        
-                            
-                                                            
-                

-                timezone
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                    
-        
-                            
-                                                            
-                

-                tmpfs
-                
-                

-                    dictionary
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Create a tmpfs mount. For example tmpfs "/tmp" "rw,size=787448k,mode=1777"

-                                                    
-        
-                            
-                                                            
-                

-                tty
-                
-                

-                    boolean
-                                                                

-                                                    
-                            
-                                                                                                                                                                    
    Choices:
-                                                                                                                                                            
  • no
    • 
-                                                                                                                                                                                            
  • yes
    • 
-                                                                                

-                                                                        
-                                                            
-                                        
Allocate a pseudo-TTY. The default is false.

-                                                    
-        
-                            
-                                                            
-                

-                uidmap
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Run the container in a new user namespace using the supplied mapping.

-                                                    
-        
-                            
-                                                            
-                

-                ulimit
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Ulimit options

-                                                            

aliases: ulimits

-                                
-        
-                            
-                                                            
-                

-                user
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Sets the username or UID used and optionally the groupname or GID for the specified command.

-                                                    
-        
-                            
-                                                            
-                

-                userns
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value means user namespaces are disabled.

-                                                            

aliases: userns_mode

-                                
-        
-                            
-                                                            
-                

-                uts
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Set the UTS mode for the container

-                                                    
-        
-                            
-                                                            
-                

-                volume
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
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.

-                                                            

aliases: volumes

-                                
-        
-                            
-                                                            
-                

-                volumes_from
-                
-                

-                    list
-                     / elements=string                                            

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Mount volumes from the specified container(s).

-                                                    
-        
-                            
-                                                            
-                

-                workdir
-                
-                

-                    string
-                                                                

-                                                    
-                            
-                                                                                                                                                        
-                                                            
-                                        
Working directory inside the container. The default working directory for running binaries within a container is the root directory (/).

-                                                            

aliases: working_dir

-                                
-        
-                    
-
-
-

ExamplesΒΆ

-
- name: Run container
-  containers.podman.podman_container:
-    name: container
-    image: quay.io/bitnami/wildfly
-    state: started
+- name: Create a data container
+  containers.podman.podman_container:
+    name: mydata
+    image: busybox
+    volume:
+      - /tmp/data
 
-- name: Create a data container
-  containers.podman.podman_container:
-    name: mydata
-    image: busybox
-    volume:
-      - /tmp/data
+- name: Re-create a redis container with systemd service file generated in /tmp/
+  containers.podman.podman_container:
+    name: myredis
+    image: redis
+    command: redis-server --appendonly yes
+    state: present
+    recreate: true
+    expose:
+      - 6379
+    volumes_from:
+      - mydata
+    generate_systemd:
+      path: /tmp/
+      restart_policy: always
+      time: 120
+      names: true
+      container_prefix: ainer
 
-- name: Re-create a redis container with systemd service file generated in /tmp/
-  containers.podman.podman_container:
-    name: myredis
-    image: redis
-    command: redis-server --appendonly yes
-    state: present
-    recreate: yes
-    expose:
-      - 6379
-    volumes_from:
-      - mydata
-    generate_systemd:
-      path: /tmp/
-      restart_policy: always
-      time: 120
-      names: true
-      container_prefix: ainer
+- name: Restart a container
+  containers.podman.podman_container:
+    name: myapplication
+    image: redis
+    state: started
+    restart: true
+    etc_hosts:
+        other: "127.0.0.1"
+    restart_policy: "no"
+    device: "/dev/sda:/dev/xvda:rwm"
+    ports:
+        - "8080:9000"
+        - "127.0.0.1:8081:9001/udp"
+    env:
+        SECRET_KEY: "ssssh"
+        BOOLEAN_KEY: "yes"
 
-- name: Restart a container
-  containers.podman.podman_container:
-    name: myapplication
-    image: redis
-    state: started
-    restart: yes
-    etc_hosts:
-        other: "127.0.0.1"
-    restart_policy: "no"
-    device: "/dev/sda:/dev/xvda:rwm"
-    ports:
-        - "8080:9000"
-        - "127.0.0.1:8081:9001/udp"
-    env:
-        SECRET_KEY: "ssssh"
-        BOOLEAN_KEY: "yes"
+- name: Container present
+  containers.podman.podman_container:
+    name: mycontainer
+    state: present
+    image: ubuntu:14.04
+    command: "sleep 1d"
 
-- name: Container present
-  containers.podman.podman_container:
-    name: mycontainer
-    state: present
-    image: ubuntu:14.04
-    command: "sleep 1d"
+- name: Stop a container
+  containers.podman.podman_container:
+    name: mycontainer
+    state: stopped
 
-- name: Stop a container
-  containers.podman.podman_container:
-    name: mycontainer
-    state: stopped
+- name: Start 4 load-balanced containers
+  containers.podman.podman_container:
+    name: "container{{ item }}"
+    recreate: true
+    image: someuser/anotherappimage
+    command: sleep 1d
+  with_sequence: count=4
 
-- name: Start 4 load-balanced containers
-  containers.podman.podman_container:
-    name: "container{{ item }}"
-    recreate: yes
-    image: someuser/anotherappimage
-    command: sleep 1d
-  with_sequence: count=4
+- name: remove container
+  containers.podman.podman_container:
+    name: ohno
+    state: absent
 
-- name: remove container
-  containers.podman.podman_container:
-    name: ohno
-    state: absent
+- name: Writing output
+  containers.podman.podman_container:
+    name: myservice
+    image: busybox
+    log_options: path=/var/log/container/mycontainer.json
+    log_driver: k8s-file
 
-- name: Writing output
-  containers.podman.podman_container:
-    name: myservice
-    image: busybox
-    log_options: path=/var/log/container/mycontainer.json
-    log_driver: k8s-file
+- name: Run container with complex command with quotes
+  containers.podman.podman_container:
+    name: mycontainer
+    image: certbot/certbot
+    command:
+      - renew
+      - --deploy-hook
+      - "echo 1 > /var/lib/letsencrypt/complete"
-
-
+
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- container - -
- dictionary -
- 		always -
Facts representing the current state of the container. Matches the podman inspection output.
-
Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as podman_container. Note that the returned fact will be removed in Ansible 2.12.
-
Empty if state is absent.
-
-
Sample:
-
{ "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": "..." ... }
-
-

+ + + + + + + + + + + +

Key

Description

+

container

+

dictionary

+

Facts representing the current state of the container. Matches the podman inspection output.

+

Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as podman_container. Note that the returned fact will be removed in Ansible 2.12.

+

Empty if state is absent.

+

Returned: always

+

Sample: "{ \"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\": \"...\" ... }"

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -2270,11 +1364,47 @@

Python

Navigation

+ + +

Related Topics

@@ -2304,8 +1434,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_containers – Manage podman containers in a batch — Python documentation + + + + containers.podman.podman_containers module – Manage podman containers in a batch — Python documentation - - - + + + @@ -32,105 +33,101 @@
-
-

containers.podman.podman_containers – Manage podman containers in a batchΒΆ

+
+

containers.podman.podman_containers module – Manage podman containers in a batchΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_containers.

-
-

New in version 1.4.0: of containers.podman

-
-
+

New in containers.podman 1.4.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Manage groups of podman containers

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- containers - -
- list - / elements=dictionary / required
- 		- -
List of dictionaries with data for running containers for podman_container module.
-
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Return additional information which can be helpful for investigations.
-
-
-
-

ExamplesΒΆ

-
- name: Run three containers at once
-  podman_containers:
-    containers:
-      - name: alpine
-        image: alpine
-        command: sleep 1d
-      - name: web
-        image: nginx
-      - name: test
-        image: python:3.10-alpine
-        command: python -V
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
containers

+
list / elements=dictionary / required

+
List of dictionaries with data for running containers for podman_container module.

+

+
debug

+
boolean

+
Return additional information which can be helpful for investigations.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+

+

+
ExamplesΒΆ

+
- name: Run three containers at once
+  podman_containers:
+    containers:
+      - name: alpine
+        image: alpine
+        command: sleep 1d
+      - name: web
+        image: nginx
+      - name: test
+        image: python:3.10-alpine
+        command: python -V
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Sagi Shnaidman (@sshnaidm)
    • 
 

-

-
-
+ + + +
@@ -149,11 +146,47 @@

Python

Navigation

+ + +

Related Topics

@@ -183,8 +216,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | Quick search - + \ No newline at end of file diff --git a/docs/podman_export_module.html b/docs/podman_export_module.html index af1a4956..2f33a5c0 100644 --- a/docs/podman_export_module.html +++ b/docs/podman_export_module.html @@ -1,21 +1,22 @@ - - - containers.podman.podman_export – Export a podman container — Python documentation + + + + containers.podman.podman_export module – Export a podman container — Python documentation - - - + + + @@ -32,126 +33,118 @@
-
-

containers.podman.podman_export – Export a podman containerΒΆ

+
+

containers.podman.podman_export module – Export a podman containerΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_export.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • podman export exports the filesystem of a container and saves it as a tarball on the local machine

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- container - -
- string - / required
- 		- -
Container to export.
-
-
- dest - -
- string - / required
- 		- -
Path to export container to.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Force saving to file even if it exists.
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- containers.podman.podman_export:
-    dest: /path/to/tar/file
-    container: container-name
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
container

+
string

+
Container to export.

+

+
dest

+
string / required

+
Path to export container to.

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
force

+
boolean

+
Force saving to file even if it exists.

+
Choices:

+
    
+
  • false
    • 
+
  • true ← (default)
    • 
+

+

+
volume

+
string

+
Volume to export.

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- containers.podman.podman_export:
+    dest: /path/to/tar/file
+    container: container-name
+- containers.podman.podman_export:
+    dest: /path/to/tar/file
+    volume: volume-name
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Sagi Shnaidman (@sshnaidm)
    • 
 

-

-
-
+ + + +
@@ -170,11 +163,47 @@

Python

Navigation

+ + +

Related Topics

@@ -204,8 +233,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_generate_systemd – Generate systemd unit from a pod or a container — Python documentation + + + + containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container — Python documentation - - - + + + @@ -32,15 +33,19 @@
-
-

containers.podman.podman_generate_systemd – Generate systemd unit from a pod or a containerΒΆ

+
+

containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a containerΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_generate_systemd.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Generate systemd .service unit file(s) from a pod or a container

  • Support Ansible check mode

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on target host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- after - -
- list - / elements=string
- 		- -
Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.
-
This option may be specified more than once.
-
User-defined dependencies will be appended to the generated unit file
-
But any existing options such as needed or defined by default (e.g. online.target) will not be removed or overridden.
-
Only with Podman 4.0.0 and above
-
-
- container_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for containers.
-
If not set, use the default defined by podman, container.
-
Refer to podman-generate-systemd(1) man page for more information.
-
-
- dest - -
- path -
- 		- -
Destination of the generated systemd unit file(s)
-
-
- env - -
- dictionary -
- 		- -
Set environment variables to the systemd unit files.
-
Keys are the environment variable names, and values are the environment variable values
-
Only with Podman 4.3.0 and above
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Podman executable name or full path
-
-
- name - -
- string - / required
- 		- -
Name of the pod or container to export
-
-
- new - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Generate unit files that create containers and pods, not only start them.
-
Refer to podman-generate-systemd(1) man page for more information.
-
-
- no_header - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Do not generate the header including meta data such as the Podman version and the timestamp.
-
-
- pod_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for pods.
-
If not set, use the default defined by podman, pod.
-
Refer to podman-generate-systemd(1) man page for more information.
-
-
- requires - -
- list - / elements=string
- 		- -
Set the systemd unit requires (Requires=) option.
-
Similar to wants, but declares a stronger requirement dependency.
-
Only with Podman 4.0.0 and above
-
-
- restart_policy - -
- string -
- 		-
    Choices: -
  • no-restart
    • -
  • on-success
    • -
  • on-failure
    • -
  • on-abnormal
    • -
  • on-watchdog
    • -
  • on-abort
    • -
  • always
    • -
- 		-
Restart policy of the service
-
-
- restart_sec - -
- integer -
- 		- -
Configures the time to sleep before restarting a service (as configured with restart-policy).
-
Takes a value in seconds.
-
Only with Podman 4.0.0 and above
-
-
- separator - -
- string -
- 		- -
Systemd unit name separator between the name/id of a container/pod and the prefix.
-
If not set, use the default defined by podman, -.
-
Refer to podman-generate-systemd(1) man page for more information.
-
-
- start_timeout - -
- integer -
- 		- -
Override the default start timeout for the container with the given value in seconds.
-
Only with Podman 4.0.0 and above
-
-
- stop_timeout - -
- integer -
- 		- -
Override the default stop timeout for the container with the given value in seconds.
-
-
- use_names - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Use name of the containers for the start, stop, and description in the unit file.
-
-
- wants - -
- list - / elements=string
- 		- -
Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.
-
This option may be specified more than once.
-
This option does not influence the order in which services are started or stopped.
-
User-defined dependencies will be appended to the generated unit file
-
But any existing options such as needed or defined by default (e.g. online.target) will not be removed or overridden.
-
Only with Podman 4.0.0 and above
-
-
-
-

NotesΒΆ

+ +
+

ParametersΒΆ

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

after

+

list / elements=string

+

Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.

+

This option may be specified more than once.

+

User-defined dependencies will be appended to the generated unit file

+

But any existing options such as needed or defined by default (e.g. online.target) will not be removed or overridden.

+

Only with Podman 4.0.0 and above

+
+

container_prefix

+

string

+

Set the systemd unit name prefix for containers.

+

If not set, use the default defined by podman, container.

+

Refer to podman-generate-systemd(1) man page for more information.

+
+

dest

+

path

+

Destination of the generated systemd unit file(s).

+

Use /etc/systemd/system for the system-wide systemd instance.

+

Use /etc/systemd/user or ~/.config/systemd/user for use with per-user instances of systemd.

+
+

env

+

dictionary

+

Set environment variables to the systemd unit files.

+

Keys are the environment variable names, and values are the environment variable values

+

Only with Podman 4.3.0 and above

+
+

executable

+

string

+

Podman executable name or full path

+

Default: "podman"

+
+

force

+

boolean

+

Replace the systemd unit file(s) even if it already exists.

+

This works with dest option.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

name

+

string / required

+

Name of the pod or container to export

+
+

new

+

boolean

+

Generate unit files that create containers and pods, not only start them.

+

Refer to podman-generate-systemd(1) man page for more information.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

no_header

+

boolean

+

Do not generate the header including meta data such as the Podman version and the timestamp.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

pod_prefix

+

string

+

Set the systemd unit name prefix for pods.

+

If not set, use the default defined by podman, pod.

+

Refer to podman-generate-systemd(1) man page for more information.

+
+

requires

+

list / elements=string

+

Set the systemd unit requires (Requires=) option.

+

Similar to wants, but declares a stronger requirement dependency.

+

Only with Podman 4.0.0 and above

+
+

restart_policy

+

string

+

Restart policy of the service

+

Choices:

+
    +

  • "no-restart"

    • +

  • "on-success"

    • +

  • "on-failure"

    • +

  • "on-abnormal"

    • +

  • "on-watchdog"

    • +

  • "on-abort"

    • +

  • "always"

    • +
+
+

restart_sec

+

integer

+

Configures the time to sleep before restarting a service (as configured with restart-policy).

+

Takes a value in seconds.

+

Only with Podman 4.0.0 and above

+
+

separator

+

string

+

Systemd unit name separator between the name/id of a container/pod and the prefix.

+

If not set, use the default defined by podman, -.

+

Refer to podman-generate-systemd(1) man page for more information.

+
+

start_timeout

+

integer

+

Override the default start timeout for the container with the given value in seconds.

+

Only with Podman 4.0.0 and above

+
+

stop_timeout

+

integer

+

Override the default stop timeout for the container with the given value in seconds.

+
+

use_names

+

boolean

+

Use name of the containers for the start, stop, and description in the unit file.

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+

wants

+

list / elements=string

+

Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.

+

This option may be specified more than once.

+

This option does not influence the order in which services are started or stopped.

+

User-defined dependencies will be appended to the generated unit file

+

But any existing options such as needed or defined by default (e.g. online.target) will not be removed or overridden.

+

Only with Podman 4.0.0 and above

+
+
+
+

NotesΒΆ

Note

    -

  • You can store your systemd unit files in /etc/systemd/user/ for system wide usage

    • -

  • Or you can store them in ~/.config/systemd/user/ for usage at a specific user

  • If you indicate a pod, the systemd units for it and all its containers will be generated

  • Create all your pods, containers and their dependencies before generating the systemd files

    • -

  • If a container or pod is already started before you do a systemctl daemon reload, systemd will not see the container or pod as started

    • -

  • Stop your container or pod before you do a systemctl daemon reload, then you can start them with systemctl start my_container.service

    • +

  • If a container or pod is already started before you do a systemctl daemon-reload, systemd will not see the container or pod as started

    • +

  • Stop your container or pod before you do a systemctl daemon-reload, then you can start them with systemctl start my_container.service

-
-
-

ExamplesΒΆ

-
# Example of creating a container and integrate it into systemd
-- name: A postgres container must exist, stopped
-  containers.podman.podman_container:
-    name: postgres_local
-    image: docker.io/library/postgres:latest
-    state: stopped
-
-- name: Systemd unit files for postgres container must exist
-  containers.podman.podman_generate_systemd:
-    name: postgres_local
-    dest: ~/.config/systemd/user/
-
-- name: Postgres container must be started and enabled on systemd
-  ansible.builtin.systemd:
-    name: container-postgres_local
-    daemon_reload: yes
-    state: started
-    enabled: yes
-
-
-# Generate the unit files, but store them on an Ansible variable
-# instead of writing them on target host
-- name: Systemd unit files for postgres container must be generated
-  containers.podman.podman_generate_systemd:
-    name: postgres_local
-  register: postgres_local_systemd_unit
-
-# Generate the unit files with environment variables sets
-- name: Systemd unit files for postgres container must be generated
-  containers.podman.podman_generate_systemd:
-    name: postgres_local
-    env:
-      POSTGRES_USER: my_app
-      POSTGRES_PASSWORD: example
-  register: postgres_local_systemd_unit
+
+

+
ExamplesΒΆ

+
# Example of creating a container and systemd unit file.
+# When using podman_generate_systemd with new:true then
+# the container needs rm:true for idempotence.
+- name: Create postgres container
+  containers.podman.podman_container:
+    name: postgres
+    image: docker.io/library/postgres:latest
+    rm: true
+    state: created
+
+- name: Generate systemd unit file for postgres container
+  containers.podman.podman_generate_systemd:
+    name: postgres
+    new: true
+    no_header: true
+    dest: /etc/systemd/system
+
+- name: Ensure postgres container is started and enabled
+  ansible.builtin.systemd:
+    name: container-postgres
+    daemon_reload: true
+    state: started
+    enabled: true
+
+
+# Example of creating a container and integrate it into systemd
+- name: A postgres container must exist, stopped
+  containers.podman.podman_container:
+    name: postgres_local
+    image: docker.io/library/postgres:latest
+    state: stopped
+
+- name: Systemd unit files for postgres container must exist
+  containers.podman.podman_generate_systemd:
+    name: postgres_local
+    dest: ~/.config/systemd/user/
+
+- name: Postgres container must be started and enabled on systemd
+  ansible.builtin.systemd:
+    name: container-postgres_local
+    daemon_reload: true
+    state: started
+    enabled: true
+
+
+# Generate the unit files, but store them on an Ansible variable
+# instead of writing them on target host
+- name: Systemd unit files for postgres container must be generated
+  containers.podman.podman_generate_systemd:
+    name: postgres_local
+  register: postgres_local_systemd_unit
+
+# Generate the unit files with environment variables sets
+- name: Systemd unit files for postgres container must be generated
+  containers.podman.podman_generate_systemd:
+    name: postgres_local
+    env:
+      POSTGRES_USER: my_app
+      POSTGRES_PASSWORD: example
+  register: postgres_local_systemd_unit
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- podman_command - -
- string -
- 		always -
A copy of the podman command used to generate the systemd unit(s)
-
-
Sample:
-
podman generate systemd my_webapp
-
-
- systemd_units - -
- dictionary -
- 		always -
A copy of the generated systemd .service unit(s)
-
-
Sample:
-
{'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'}
-
-

+ + + + + + + + + + + + + + +

Key

Description

+

podman_command

+

string

+

A copy of the podman command used to generate the systemd unit(s)

+

Returned: always

+

Sample: "podman generate systemd my_webapp"

+
+

systemd_units

+

dictionary

+

A copy of the generated systemd .service unit(s)

+

Returned: always

+

Sample: {"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"}

+
+

AuthorsΒΆ

  • SΓ©bastien Gendre (@CyberFox001)

-
-
-
+ + + +
@@ -498,11 +404,47 @@

Python

Navigation

+ + +

Related Topics

@@ -532,8 +474,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_image_info – Gather info about images using podman — Python documentation + + + + containers.podman.podman_image_info module – Gather info about images using podman — Python documentation - - - + + + @@ -32,15 +33,17 @@
-
-

containers.podman.podman_image_info – Gather info about images using podmanΒΆ

+
+

containers.podman.podman_image_info module – Gather info about images using podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman_image_info.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Gather info about images using podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- name - -
- list - / elements=string
- 		- -
List of tags or UID to gather info about. If no name is given return info about all images.
-
-
-
+
+

ParametersΒΆ

+ + + + + + + + + + + + + + +

Parameter

Comments

+

executable

+

string

+

Path to podman executable if it is not in the $PATH on the machine running podman

+

Default: "podman"

+
+

name

+

list / elements=string

+

List of tags or UID to gather info about. If no name is given return info about all images.

+
+
+
+

NotesΒΆ

Note

  • Podman may required elevated privileges in order to run properly.

-
-
-

ExamplesΒΆ

-
- name: Gather info for all images
-  containers.podman.podman_image_info:
-
-- name: Gather info on a specific image
-  containers.podman.podman_image_info:
-    name: nginx
-
-- name: Gather info on several images
-  containers.podman.podman_image_info:
-    name:
-      - redis
-      - quay.io/bitnami/wildfly
+
+

+
ExamplesΒΆ

+
- name: Gather info for all images
+  containers.podman.podman_image_info:
+
+- name: Gather info on a specific image
+  containers.podman.podman_image_info:
+    name: nginx
+
+- name: Gather info on several images
+  containers.podman.podman_image_info:
+    name:
+      - redis
+      - quay.io/bitnami/wildfly
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- images - -
- dictionary -
- 		always -
info from all or specified images
-
-
Sample:
-
[{'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}]
-
-

+ + + + + + + + + + + +

Key

Description

+

images

+

dictionary

+

info from all or specified images

+

Returned: always

+

Sample: [{"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}]

+
+

AuthorsΒΆ

  • Sam Doran (@samdoran)

-
-
-
+ + + +
@@ -175,11 +165,47 @@

Python

Navigation

+ + +

Related Topics

@@ -209,8 +235,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_image – Pull images for use by podman — Python documentation + + + + containers.podman.podman_image module – Pull images for use by podman — Python documentation - - - + + + @@ -32,692 +33,505 @@
-
-

containers.podman.podman_image – Pull images for use by podmanΒΆ

+
+

containers.podman.podman_image module – Pull images for use by podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman_image.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Build, pull, or push images using Podman.

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- auth_file - -
- path -
- 		- -
Path to file containing authorization credentials to the remote registry.
-

aliases: authfile
-
-
- build - -
- dictionary -
- 		- Default:
{}
- 		-
Arguments that control image build.
-

aliases: build_args, buildargs
-
-
- annotation - -
- dictionary -
- 		- -
Dictionary of key=value pairs to add to the image. Only works with OCI images. Ignored for Docker containers.
-
-
- cache - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Whether or not to use cached layers when building an image
-
-
- extra_args - -
- string -
- 		- -
Extra args to pass to build, if executed. Does not idempotently check for new build args.
-
-
- file - -
- path -
- 		- -
Path to the Containerfile if it is not in the build context directory.
-
-
- force_rm - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Always remove intermediate containers after a build, even if the build is unsuccessful.
-
-
- format - -
- string -
- 		-
    Choices: -
  • docker
    • -
  • oci ←
    • -
- 		-
Format of the built image.
-
-
- rm - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Remove intermediate containers after a successful build
-
-
- volume - -
- list - / elements=string
- 		- -
Specify multiple volume / mount options to mount one or more mounts to a container.
-
-
- ca_cert_dir - -
- path -
- 		- -
Path to directory containing TLS certificates and keys to use.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman.
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether or not to force push or pull an image.
-
When building, force the build even if the image already exists.
-
-
- name - -
- string - / required
- 		- -
Name of the image to pull, push, or delete. It may contain a tag using the format image:tag.
-
-
- password - -
- string -
- 		- -
Password to use when authenticating to remote registries.
-
-
- path - -
- string -
- 		- -
Path to the build context directory.
-
-
- pull - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Whether or not to pull the image.
-
-
- push - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether or not to push an image.
-
-
- push_args - -
- dictionary -
- 		- Default:
{}
- 		-
Arguments that control pushing images.
-
-
- compress - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compress tarball image layers when pushing to a directory using the 'dir' transport.
-
-
- dest - -
- string -
- 		- -
Path or URL where image will be pushed.
-

aliases: destination
-
-
- format - -
- string -
- 		-
    Choices: -
  • oci
    • -
  • v2s1
    • -
  • v2s2
    • -
- 		-
Manifest type to use when pushing an image using the 'dir' transport (default is manifest type of source).
-
-
- remove_signatures - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Discard any pre-existing signatures in the image
-
-
- sign_by - -
- string -
- 		- -
Path to a key file to use to sign the image.
-
-
- transport - -
- string -
- 		-
    Choices: -
  • dir
    • -
  • docker-archive
    • -
  • docker-daemon
    • -
  • oci-archive
    • -
  • ostree
    • -
- 		-
Transport to use when pushing in image. If no transport is set, will attempt to push to a remote registry.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • build
    • -
- 		-
Whether an image should be present, absent, or built.
-
-
- tag - -
- string -
- 		- Default:
"latest"
- 		-
Tag of the image to pull, push, or delete.
-
-
- username - -
- string -
- 		- -
username to use when authenticating to remote registries.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Require HTTPS and validate certificates when pulling or pushing. Also used during build if a pull or push is necessary.
-

aliases: tlsverify, tls_verify
-
-
-
-

ExamplesΒΆ

-
- name: Pull an image
-  containers.podman.podman_image:
-    name: quay.io/bitnami/wildfly
-
-- name: Remove an image
-  containers.podman.podman_image:
-    name: quay.io/bitnami/wildfly
-    state: absent
-
-- name: Remove an image with image id
-  containers.podman.podman_image:
-    name: 0e901e68141f
-    state: absent
-
-- name: Pull a specific version of an image
-  containers.podman.podman_image:
-    name: redis
-    tag: 4
-
-- name: Build a basic OCI image
-  containers.podman.podman_image:
-    name: nginx
-    path: /path/to/build/dir
-
-- name: Build a basic OCI image with advanced parameters
-  containers.podman.podman_image:
-    name: nginx
-    path: /path/to/build/dir
-    build:
-      cache: no
-      force_rm: yes
-      format: oci
-      annotation:
-        app: nginx
-        function: proxy
-        info: Load balancer for my cool app
-      extra_args: "--build-arg KEY=value"
-
-- name: Build a Docker formatted image
-  containers.podman.podman_image:
-    name: nginx
-    path: /path/to/build/dir
-    build:
-      format: docker
-
-- name: Build and push an image using existing credentials
-  containers.podman.podman_image:
-    name: nginx
-    path: /path/to/build/dir
-    push: yes
-    push_args:
-      dest: quay.io/acme
-
-- name: Build and push an image using an auth file
-  containers.podman.podman_image:
-    name: nginx
-    push: yes
-    auth_file: /etc/containers/auth.json
-    push_args:
-      dest: quay.io/acme
-
-- name: Build and push an image using username and password
-  containers.podman.podman_image:
-    name: nginx
-    push: yes
-    username: bugs
-    password: "{{ vault_registry_password }}"
-    push_args:
-      dest: quay.io/acme
-
-- name: Build and push an image to multiple registries
-  containers.podman.podman_image:
-    name: "{{ item }}"
-    path: /path/to/build/dir
-    push: yes
-    auth_file: /etc/containers/auth.json
-    loop:
-    - quay.io/acme/nginx
-    - docker.io/acme/nginx
-
-- name: Build and push an image to multiple registries with separate parameters
-  containers.podman.podman_image:
-    name: "{{ item.name }}"
-    tag: "{{ item.tag }}"
-    path: /path/to/build/dir
-    push: yes
-    auth_file: /etc/containers/auth.json
-    push_args:
-      dest: "{{ item.dest }}"
-    loop:
-    - name: nginx
-      tag: 4
-      dest: docker.io/acme
-
-    - name: nginx
-      tag: 3
-      dest: docker.io/acme
+
+
+

ParametersΒΆ

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+

arch

+

string

+

CPU architecture for the container image

+
+
+

auth_file

+

aliases: authfile

+

path

+

Path to file containing authorization credentials to the remote registry.

+
+
+
+

build

+

aliases: build_args, buildargs

+

dictionary

+

Arguments that control image build.

+

Default: {}

+
+
+
+

annotation

+

dictionary

+

Dictionary of key=value pairs to add to the image. Only works with OCI images. Ignored for Docker containers.

+
+
+
+

cache

+

boolean

+

Whether or not to use cached layers when building an image

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+
+
+

extra_args

+

string

+

Extra args to pass to build, if executed. Does not idempotently check for new build args.

+
+
+
+

file

+

path

+

Path to the Containerfile if it is not in the build context directory.

+
+
+
+

force_rm

+

boolean

+

Always remove intermediate containers after a build, even if the build is unsuccessful.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+
+
+

format

+

string

+

Format of the built image.

+

Choices:

+
    +

  • "docker"

    • +

  • "oci" ← (default)

    • +
+
+
+
+

rm

+

boolean

+

Remove intermediate containers after a successful build

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+
+
+

target

+

string

+

Specify the target build stage to build.

+
+
+
+

volume

+

list / elements=string

+

Specify multiple volume / mount options to mount one or more mounts to a container.

+
+

ca_cert_dir

+

path

+

Path to directory containing TLS certificates and keys to use.

+
+

executable

+

string

+

Path to podman executable if it is not in the $PATH on the machine running podman.

+

Default: "podman"

+
+

force

+

boolean

+

Whether or not to force push or pull an image.

+

When building, force the build even if the image already exists.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

name

+

string / required

+

Name of the image to pull, push, or delete. It may contain a tag using the format image:tag.

+
+

password

+

string

+

Password to use when authenticating to remote registries.

+
+

path

+

string

+

Path to the build context directory.

+
+

pull

+

boolean

+

Whether or not to pull the image.

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+
+

push

+

boolean

+

Whether or not to push an image.

+

Choices:

+
    +

  • false ← (default)

    • +

  • true

    • +
+
+

push_args

+

dictionary

+

Arguments that control pushing images.

+

Default: {}

+
+

compress

+

boolean

+

Compress tarball image layers when pushing to a directory using the β€˜dir’ transport.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+
+

dest

+

aliases: destination

+

string

+

Path or URL where image will be pushed.

+
+

format

+

string

+

Manifest type to use when pushing an image using the β€˜dir’ transport (default is manifest type of source).

+

Choices:

+
    +

  • "oci"

    • +

  • "v2s1"

    • +

  • "v2s2"

    • +
+
+

remove_signatures

+

boolean

+

Discard any pre-existing signatures in the image

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+

sign_by

+

string

+

Path to a key file to use to sign the image.

+
+

transport

+

string

+

Transport to use when pushing in image. If no transport is set, will attempt to push to a remote registry.

+

Choices:

+
    +

  • "dir"

    • +

  • "docker-archive"

    • +

  • "docker-daemon"

    • +

  • "oci-archive"

    • +

  • "ostree"

    • +
+
+

state

+

string

+

Whether an image should be present, absent, or built.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +

  • "build"

    • +
+
+

tag

+

string

+

Tag of the image to pull, push, or delete.

+

Default: "latest"

+
+

username

+

string

+

username to use when authenticating to remote registries.

+
+
+
+

validate_certs

+

aliases: tlsverify, tls_verify

+

boolean

+

Require HTTPS and validate certificates when pulling or pushing. Also used during build if a pull or push is necessary.

+

Choices:

+
    +

  • false

    • +

  • true

    • +
+
+
+
+

ExamplesΒΆ

+
- name: Pull an image
+  containers.podman.podman_image:
+    name: quay.io/bitnami/wildfly
+
+- name: Remove an image
+  containers.podman.podman_image:
+    name: quay.io/bitnami/wildfly
+    state: absent
+
+- name: Remove an image with image id
+  containers.podman.podman_image:
+    name: 0e901e68141f
+    state: absent
+
+- name: Pull a specific version of an image
+  containers.podman.podman_image:
+    name: redis
+    tag: 4
+
+- name: Build a basic OCI image
+  containers.podman.podman_image:
+    name: nginx
+    path: /path/to/build/dir
+
+- name: Build a basic OCI image with advanced parameters
+  containers.podman.podman_image:
+    name: nginx
+    path: /path/to/build/dir
+    build:
+      cache: no
+      force_rm: true
+      format: oci
+      annotation:
+        app: nginx
+        function: proxy
+        info: Load balancer for my cool app
+      extra_args: "--build-arg KEY=value"
+
+- name: Build a Docker formatted image
+  containers.podman.podman_image:
+    name: nginx
+    path: /path/to/build/dir
+    build:
+      format: docker
+
+- name: Build and push an image using existing credentials
+  containers.podman.podman_image:
+    name: nginx
+    path: /path/to/build/dir
+    push: true
+    push_args:
+      dest: quay.io/acme
+
+- name: Build and push an image using an auth file
+  containers.podman.podman_image:
+    name: nginx
+    push: true
+    auth_file: /etc/containers/auth.json
+    push_args:
+      dest: quay.io/acme
+
+- name: Build and push an image using username and password
+  containers.podman.podman_image:
+    name: nginx
+    push: true
+    username: bugs
+    password: "{{ vault_registry_password }}"
+    push_args:
+      dest: quay.io/acme
+
+- name: Build and push an image to multiple registries
+  containers.podman.podman_image:
+    name: "{{ item }}"
+    path: /path/to/build/dir
+    push: true
+    auth_file: /etc/containers/auth.json
+    loop:
+    - quay.io/acme/nginx
+    - docker.io/acme/nginx
+
+- name: Build and push an image to multiple registries with separate parameters
+  containers.podman.podman_image:
+    name: "{{ item.name }}"
+    tag: "{{ item.tag }}"
+    path: /path/to/build/dir
+    push: true
+    auth_file: /etc/containers/auth.json
+    push_args:
+      dest: "{{ item.dest }}"
+    loop:
+    - name: nginx
+      tag: 4
+      dest: docker.io/acme
+
+    - name: nginx
+      tag: 3
+      dest: docker.io/acme
+
+- name: Pull an image for a specific CPU architecture
+  containers.podman.podman_image:
+    name: nginx
+    arch: amd64
-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- image - -
- dictionary -
- 		success -
Image inspection results for the image that was pulled, pushed, or built.
-
-
Sample:
-
[{'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}]
-
-

+ + + + + + + + + + + +

Key

Description

+

image

+

dictionary

+

Image inspection results for the image that was pulled, pushed, or built.

+

Returned: success

+

Sample: [{"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}]

+
+

AuthorsΒΆ

  • Sam Doran (@samdoran)

-
-
-
+ + + +
@@ -736,11 +550,47 @@

Python

Navigation

+ + +

Related Topics

@@ -770,8 +620,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_import – Import Podman container from a tar file. — Python documentation + + + + containers.podman.podman_import module – Import Podman container from a tar file. — Python documentation - - - + + + @@ -32,15 +33,19 @@
-
-

containers.podman.podman_import – Import Podman container from a tar file.ΒΆ

+
+

containers.podman.podman_import module – Import Podman container from a tar file.ΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_import.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • podman import imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) and saves it as a filesystem image.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- change - -
- list - / elements=dictionary
- 		- -
Set changes as list of key-value pairs, see example.
-
-
- commit_message - -
- string -
- 		- -
Set commit message for imported image
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- src - -
- string - / required
- 		- -
Path to image file to load.
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- containers.podman.podman_import:
-    src: /path/to/tar/file
-    change:
-      - "CMD": /bin/bash
-      - "User": root
-    commit_message: "Importing image"
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
change

+
list / elements=dictionary

+
Set changes as list of key-value pairs, see example.

+

+
commit_message

+
string

+
Set commit message for imported image

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
src

+
string / required

+
Path to image file to load.

+

+
volume

+
string

+
Volume to import, cannot be used with change and commit_message

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- containers.podman.podman_import:
+    src: /path/to/tar/file
+    change:
+      - "CMD": /bin/bash
+      - "User": root
+    commit_message: "Importing image"
+- containers.podman.podman_import:
+    src: /path/to/tar/file
+    volume: myvolume
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- image - -
- dictionary -
- 		always -
info from loaded image
-
-
Sample:
-
{'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}
-
-

+ + + + + + + + + + + +

Key

Description

+

image

+

dictionary

+

info from loaded image

+

Returned: always

+

Sample: {"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": null, "ManifestType": "application/vnd.oci.image.manifest.v1+json", "NamesHistory": null, "Os": "linux", "Parent": "", "RepoDigests": [], "RepoTags": [], "RootFS": {"Layers": ["sha256:...."], "Type": "layers"}, "Size": 5882449, "User": "", "Version": "", "VirtualSize": 5882449}

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -198,11 +184,47 @@

Python

Navigation

+ + +

Related Topics

@@ -232,8 +254,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_load – Load image from a tar file. — Python documentation + + + + containers.podman.podman_load module – Load image from a tar file. — Python documentation - - - + + + @@ -32,15 +33,19 @@
-
-

containers.podman.podman_load – Load image from a tar file.ΒΆ

+
+

containers.podman.podman_load module – Load image from a tar file.ΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_load.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • 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.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- input - -
- string - / required
- 		- -
Path to image file to load.
-

aliases: path
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- containers.podman.podman_load:
-    input: /path/to/tar/file
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+

+
input

+
aliases: path

+
string / required

+
Path to image file to load.

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- containers.podman.podman_load:
+    input: /path/to/tar/file
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- image - -
- dictionary -
- 		always -
info from loaded image
-
-
Sample:
-
[{'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}]
-
-

+ + + + + + + + + + + +

Key

Description

+

image

+

dictionary

+

info from loaded image

+

Returned: always

+

Sample: [{"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}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -165,11 +158,47 @@

Python

Navigation

+ + +

Related Topics

@@ -199,8 +228,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_login_info – Return the logged-in user if any for a given registry — Python documentation + + + + containers.podman.podman_login_info module – Return the logged-in user if any for a given registry — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_login_info – Return the logged-in user if any for a given registryΒΆ

+
+

containers.podman.podman_login_info module – Return the logged-in user if any for a given registryΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_login_info.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Return the logged-in user if any for a given registry.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authfile - -
- path -
- 		- -
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``
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- registry - -
- string - / required
- 		- -
Registry server.
-
-
-
-

ExamplesΒΆ

-
- name: Return the logged-in user for docker hub registry
-  containers.podman.podman_login_info:
-    registry: docker.io
-
-- name: Return the logged-in user for quay.io registry
-  containers.podman.podman_login_info:
-    registry: quay.io
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
authfile

+
path

+
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``

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
registry

+
string / required

+
Registry server.

+

+

+

+
ExamplesΒΆ

+
- name: Return the logged-in user for docker hub registry
+  containers.podman.podman_login_info:
+    registry: docker.io
+
+- name: Return the logged-in user for quay.io registry
+  containers.podman.podman_login_info:
+    registry: quay.io
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- login - -
- dictionary -
- 		always -
Logged in user for a registry
-
-
Sample:
-
{'logged_in': True, 'registry': 'docker.io', 'username': 'clelange'}
-
-

+ + + + + + + + + + + +

Key

Description

+

login

+

dictionary

+

Logged in user for a registry

+

Returned: always

+

Sample: {"logged_in": true, "registry": "docker.io", "username": "clelange"}

+
+

AuthorsΒΆ

  • Clemens Lange (@clelange)

-
-
-
+ + + +
@@ -186,11 +168,47 @@

Python

Navigation

+ + +

Related Topics

@@ -220,8 +238,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_login – Login to a container registry using podman — Python documentation + + + + containers.podman.podman_login module – Login to a container registry using podman — Python documentation - - - + + + @@ -32,178 +33,137 @@
-
-

containers.podman.podman_login – Login to a container registry using podmanΒΆ

+
+

containers.podman.podman_login module – Login to a container registry using podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_login.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

    -

  • 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.

    • +

  • 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`.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authfile - -
- path -
- 		- -
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``
-
-
- certdir - -
- path -
- 		- -
Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- password - -
- string - / required
- 		- -
Password for the registry server.
-
-
- registry - -
- string -
- 		- -
Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.
-
-
- tlsverify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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.
-
-
- username - -
- string - / required
- 		- -
Username for the registry server.
-
-
-
-

ExamplesΒΆ

-
- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
-  containers.podman.podman_login:
-    username: user
-    password: 'p4ssw0rd'
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
authfile

+
path

+
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``

+

+
certdir

+
path

+
Use certificates at path (*.crt, *.cert, *.key) to connect to the registry.  Default certificates directory is /etc/containers/certs.d.

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
password

+
string / required

+
Password for the registry server.

+

+
registry

+
string

+
Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.

+

+
tlsverify

+
boolean

+
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.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
username

+
string / required

+
Username for the registry server.

+

+

+

+
ExamplesΒΆ

+
- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
+  containers.podman.podman_login:
+    username: user
+    password: 'p4ssw0rd'
 
-- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
-  containers.podman.podman_login:
-    username: user
-    password: 'p4ssw0rd'
-    registry: quay.io
+- name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
+  containers.podman.podman_login:
+    username: user
+    password: 'p4ssw0rd'
+    registry: quay.io
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Jason Hiatt (@jthiatt)
    • 
 
  • Clemens Lange (@clelange)
    • 
+
  • Michael Fox (@spmfox)
    • 
 

-

-
-
+ + + +
@@ -222,11 +182,47 @@

Python

Navigation

+ + +

Related Topics

@@ -256,8 +252,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_logout – Log out of a container registry using podman — Python documentation + + + + containers.podman.podman_logout module – Log out of a container registry using podman — Python documentation - - - + + + @@ -32,156 +33,131 @@
-
-

containers.podman.podman_logout – Log out of a container registry using podmanΒΆ

+
+

containers.podman.podman_logout module – Log out of a container registry using podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_logout.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

    -

  • 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.

    • +

  • 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.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- all - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Remove the cached credentials for all registries in the auth file.
-
-
- authfile - -
- path -
- 		- -
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``
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- ignore_docker_credentials - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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.
-
-
- registry - -
- string -
- 		- -
Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.
-
-
-
-

ExamplesΒΆ

-
- name: Log out of default registry
-  podman_logout:
-
-- name: Log out of quay.io
-  podman_logout:
-    registry: quay.io
-
-- name: Log out of all registries in auth file
-  podman_logout:
-    all: yes
-
-- name: Log out of all registries in specified auth file
-  podman_logout:
-    authfile: $HOME/.docker/config.json
-    all: yes
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
all

+
boolean

+
Remove the cached credentials for all registries in the auth file.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
authfile

+
path

+
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``

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
ignore_docker_credentials

+
boolean

+
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.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
registry

+
string

+
Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.

+

+

+

+
ExamplesΒΆ

+
- name: Log out of default registry
+  podman_logout:
+
+- name: Log out of quay.io
+  podman_logout:
+    registry: quay.io
+
+- name: Log out of all registries in auth file
+  podman_logout:
+    all: true
+
+- name: Log out of all registries in specified auth file
+  podman_logout:
+    authfile: $HOME/.docker/config.json
+    all: true
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Clemens Lange (@clelange)
    • 
 

-

-
-
+ + + +
@@ -200,11 +176,47 @@

Python

Navigation

+ + +

Related Topics

@@ -234,8 +246,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_network_info – Gather info about podman networks — Python documentation + + + + containers.podman.podman_network_info module – Gather info about podman networks — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_network_info – Gather info about podman networksΒΆ

+
+

containers.podman.podman_network_info module – Gather info about podman networksΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_network_info.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Gather info about podman networks with podman inspect command.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- name - -
- string -
- 		- -
Name of the network
-
-
-
-

ExamplesΒΆ

-
- name: Gather info about all present networks
-  containers.podman.podman_network_info:
-
-- name: Gather info about specific network
-  containers.podman.podman_network_info:
-    name: podman
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
name

+
string

+
Name of the network

+

+

+

+
ExamplesΒΆ

+
- name: Gather info about all present networks
+  containers.podman.podman_network_info:
+
+- name: Gather info about specific network
+  containers.podman.podman_network_info:
+    name: podman
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- networks - -
- list - / elements=string
- 		always -
Facts from all or specified networks
-
-
Sample:
-
[{'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'}]}]
-
-

+ + + + + + + + + + + +

Key

Description

+

networks

+

list / elements=string

+

Facts from all or specified networks

+

Returned: always

+

Sample: [{"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"}]}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -170,11 +160,47 @@

Python

Navigation

+ + +

Related Topics

@@ -204,8 +230,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_network – Manage podman networks — Python documentation + + + + containers.podman.podman_network module – Manage podman networks — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_network – Manage podman networksΒΆ

+
+

containers.podman.podman_network module – Manage podman networksΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_network.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Manage podman networks with podman network command.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Return additional information which can be helpful for investigations.
-
-
- disable_dns - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
disable dns plugin (default "false")
-
-
- driver - -
- string -
- 		- -
Driver to manage the network (default "bridge")
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- gateway - -
- string -
- 		- -
IPv4 or IPv6 gateway for the subnet
-
-
- internal - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Restrict external access from this network (default "false")
-
-
- ip_range - -
- string -
- 		- -
Allocate container IP from range
-
-
- ipv6 - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The subnet option must be used with the ipv6 option.
-
-
- macvlan - -
- string -
- 		- -
Create a Macvlan connection based on this device
-
-
- name - -
- string - / required
- 		- -
Name of the network
-
-
- opt - -
- dictionary -
- 		- -
Add network options. Currently 'vlan' and 'mtu' are supported.
-
-
- mtu - -
- integer -
- 		- -
MTU size for bridge network interface.
-
-
- vlan - -
- integer -
- 		- -
VLAN tag for bridge which enables vlan_filtering.
-
-
- recreate - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Recreate network even if exists.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of network, default 'present'
-
-
- subnet - -
- string -
- 		- -
Subnet in CIDR format
-
-
-
-

ExamplesΒΆ

-
- name: Create a podman network
-  containers.podman.podman_network:
-    name: podman_network
-  become: true
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
debug

+
boolean

+
Return additional information which can be helpful for investigations.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
disable_dns

+
boolean

+
disable dns plugin (default β€œfalse”)

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
driver

+
string

+
Driver to manage the network (default β€œbridge”)

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
force

+
boolean

+
Remove all containers that use the network. If the container is running, it is stopped and removed.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
gateway

+
string

+
IPv4 or IPv6 gateway for the subnet

+

+
internal

+
boolean

+
Restrict external access from this network (default β€œfalse”)

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
ip_range

+
string

+
Allocate container IP from range

+

+
ipv6

+
boolean

+
Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The subnet option must be used with the ipv6 option.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
macvlan

+
string

+
Create a Macvlan connection based on this device

+

+
name

+
string / required

+
Name of the network

+

+
opt

+
dictionary

+
Add network options. Currently β€˜vlan’ and β€˜mtu’ are supported.

+

+
isolate

+
boolean

+
This option isolates networks by blocking traffic between those that have this option enabled.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
metric

+
integer

+
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.

+

+
mode

+
string

+
This option sets the specified ip/macvlan mode on the interface.

+

+
mtu

+
integer

+
MTU size for bridge network interface.

+

+
parent

+
string

+
The host device which should be used for the macvlan interface. Defaults to the default route interface.

+

+
vlan

+
integer

+
VLAN tag for bridge which enables vlan_filtering.

+

+
recreate

+
boolean

+
Recreate network even if exists.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
state

+
string

+
State of network, default β€˜present’

+
Choices:

+
    
+
  • "present" ← (default)
    • 
+
  • "absent"
    • 
+

+

+
subnet

+
string

+
Subnet in CIDR format

+

+

+

+
ExamplesΒΆ

+
- name: Create a podman network
+  containers.podman.podman_network:
+    name: podman_network
+  become: true
 
-- name: Create internal podman network
-  containers.podman.podman_network:
-    name: podman_internal
-    internal: true
-    ip_range: 192.168.22.128/25
-    subnet: 192.168.22.0/24
-    gateway: 192.168.22.1
-  become: true
+- name: Create internal podman network
+  containers.podman.podman_network:
+    name: podman_internal
+    internal: true
+    ip_range: 192.168.22.128/25
+    subnet: 192.168.22.0/24
+    gateway: 192.168.22.1
+  become: true
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- network - -
- list - / elements=string
- 		always -
Facts from created or updated networks
-
-
Sample:
-
[{'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'}]}]
-
-

+ + + + + + + + + + + +

Key

Description

+

network

+

list / elements=string

+

Facts from created or updated networks

+

Returned: always

+

Sample: [{"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"}]}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -414,11 +340,47 @@

Python

Navigation

+ + +

Related Topics

@@ -448,8 +410,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_play – Play kubernetes YAML file using podman — Python documentation + + + + containers.podman.podman_play module – Play kubernetes YAML file using podman — Python documentation - - - + + + @@ -32,331 +33,249 @@
-
-

containers.podman.podman_play – Play kubernetes YAML file using podmanΒΆ

+
+

containers.podman.podman_play module – Play kubernetes YAML file using podmanΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_play.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • The module reads in a structured file of Kubernetes YAML. It will then recreate the pod and containers described in the YAML.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authfile - -
- path -
- 		- -
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
-
-
- cert_dir - -
- path -
- 		- -
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)
-
-
- configmap - -
- list - / elements=path
- 		- -
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
-
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Enable debug for the module.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Name of executable to run, by default 'podman'
-
-
- kube_file - -
- path - / required
- 		- -
Path to file with YAML configuration for a Pod.
-
-
- log_driver - -
- string -
- 		- -
Set logging driver for all created containers.
-
-
- log_level - -
- string -
- 		-
    Choices: -
  • debug
    • -
  • info
    • -
  • warn
    • -
  • error
    • -
  • fatal
    • -
  • panic
    • -
- 		-
Set logging level for podman calls. Log messages above specified level ("debug"|"info"|"warn"|"error"|"fatal"|"panic") (default "error")
-
-
- network - -
- list - / elements=string
- 		- -
List of the names of CNI networks the pod should join.
-
-
- password - -
- string -
- 		- -
The username and password to use to authenticate with the registry if required.
-
-
- quiet - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Hide image pulls logs from output.
-
-
- recreate - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
If pod already exists, delete it and run the new one.
-
-
- seccomp_profile_root - -
- path -
- 		- -
Directory path for seccomp profiles (default is "/var/lib/kubelet/seccomp"). This option is not available with the remote Podman client
-
-
- state - -
- string - / required
- 		-
    Choices: -
  • created
    • -
  • started
    • -
  • absent
    • -
- 		-
Start the pod after creating it, or to leave it created only.
-
-
- tls_verify - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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.
-
-
- username - -
- string -
- 		- -
The username and password to use to authenticate with the registry if required.
-
-
-
-

ExamplesΒΆ

-
- name: Play kube file
-  containers.podman.podman_play:
-    kube_file: ~/kube.yaml
-    state: started
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
authfile

+
path

+
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

+

+
build

+
boolean

+
Build images even if they are found in the local storage.

+
It is required to exist subdirectories matching the image names to be build.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
cert_dir

+
path

+
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)

+

+
configmap

+
list / elements=path

+
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

+

+
context_dir

+
path

+
Use path as the build context directory for each image. Requires build option be true.

+

+
debug

+
boolean

+
Enable debug for the module.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
executable

+
string

+
Name of executable to run, by default β€˜podman’

+
Default: "podman"

+

+
kube_file

+
path / required

+
Path to file with YAML configuration for a Pod.

+

+
log_driver

+
string

+
Set logging driver for all created containers.

+

+
log_level

+
string

+
Set logging level for podman calls. Log messages above specified level (β€œdebug”|”info”|”warn”|”error”|”fatal”|”panic”) (default β€œerror”)

+
Choices:

+
    
+
  • "debug"
    • 
+
  • "info"
    • 
+
  • "warn"
    • 
+
  • "error"
    • 
+
  • "fatal"
    • 
+
  • "panic"
    • 
+

+

+
network

+
list / elements=string

+
List of the names of CNI networks the pod should join.

+

+
password

+
string

+
The username and password to use to authenticate with the registry if required.

+

+
quiet

+
boolean

+
Hide image pulls logs from output.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
recreate

+
boolean

+
If pod already exists, delete it and run the new one.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
seccomp_profile_root

+
path

+
Directory path for seccomp profiles (default is β€œ/var/lib/kubelet/seccomp”). This option is not available with the remote Podman client

+

+
state

+
string / required

+
Start the pod after creating it, or to leave it created only.

+
Choices:

+
    
+
  • "created"
    • 
+
  • "started"
    • 
+
  • "absent"
    • 
+

+

+
tls_verify

+
boolean

+
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.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
username

+
string

+
The username and password to use to authenticate with the registry if required.

+

+
userns

+
string

+
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.

+

+

+

+
ExamplesΒΆ

+
- name: Play kube file
+  containers.podman.podman_play:
+    kube_file: ~/kube.yaml
+    state: started
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Sagi Shnaidman (@sshnaidm)
    • 
 

-

-
-
+ + + +
@@ -375,11 +294,47 @@

Python

Navigation

+ + +

Related Topics

@@ -409,8 +364,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_pod_info – Gather info about podman pods — Python documentation + + + + containers.podman.podman_pod_info module – Gather info about podman pods — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_pod_info – Gather info about podman podsΒΆ

+
+

containers.podman.podman_pod_info module – Gather info about podman podsΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_pod_info.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Gather info about podman pods with podman inspect command.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- name - -
- string -
- 		- -
Name of the pod
-
-
-
-

ExamplesΒΆ

-
- name: Gather info about all present pods
-  containers.podman.podman_pod_info:
-
-- name: Gather info about specific pods
-  containers.podman.podman_pod_info:
-    name: special_pod
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
name

+
string

+
Name of the pod

+

+

+

+
ExamplesΒΆ

+
- name: Gather info about all present pods
+  containers.podman.podman_pod_info:
+
+- name: Gather info about specific pods
+  containers.podman.podman_pod_info:
+    name: special_pod
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- pods - -
- list - / elements=string
- 		always -
Facts from all or specified pods
-
-
Sample:
-
[{'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'}}]
-
-

+ + + + + + + + + + + +

Key

Description

+

pods

+

list / elements=string

+

Facts from all or specified pods

+

Returned: always

+

Sample: [{"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"}}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -170,11 +160,47 @@

Python

Navigation

+ + +

Related Topics

@@ -204,8 +230,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_pod – Manage Podman pods — Python documentation + + + + containers.podman.podman_pod module – Manage Podman pods — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_pod – Manage Podman podsΒΆ

+
+

containers.podman.podman_pod module – Manage Podman podsΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_pod.

-
-

New in version 1.0.0: of containers.podman

-
-
+

New in containers.podman 1.0.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Manage podman pods.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- add_host - -
- list - / elements=string
- 		- -
Add a host to the /etc/hosts file shared between all containers in the pod.
-
-
- cgroup_parent - -
- string -
- 		- -
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.
-
-
- cpus - -
- string -
- 		- -
Set the total number of CPUs delegated to the pod. Default is 0.000 which indicates that there is no limit on computation power.
-
-
- cpuset_cpus - -
- string -
- 		- -
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
-
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Return additional information which can be helpful for investigations.
-
-
- device - -
- list - / elements=string
- 		- -
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)
-
-
- device_read_bps - -
- list - / elements=string
- 		- -
Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)
-
-
- dns - -
- list - / elements=string
- 		- -
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.
-
-
- dns_opt - -
- list - / elements=string
- 		- -
Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.
-
- - dns_search - -
- list - / elements=string
- 		- -
Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- generate_systemd - -
- dictionary -
- 		- Default:
{}
- 		-
Generate systemd unit file for container.
-
-
- after - -
- list - / elements=string
- 		- -
Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.
-
-
- container_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for containers. The default is "container".
-
-
- names - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Use names of the containers for the start, stop, and description in the unit file. Default is true.
-
-
- new - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
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.
-
-
- no_header - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.
-
-
- path - -
- string -
- 		- -
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.
-
-
- pod_prefix - -
- string -
- 		- -
Set the systemd unit name prefix for pods. The default is "pod".
-
-
- requires - -
- list - / elements=string
- 		- -
Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.
-
-
- restart_policy - -
- string -
- 		-
    Choices: -
  • no
    • -
  • on-success
    • -
  • on-failure
    • -
  • on-abnormal
    • -
  • on-watchdog
    • -
  • on-abort
    • -
  • always
    • -
- 		-
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".
-
-
- separator - -
- string -
- 		- -
Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is "-" (dash).
-
-
- time - -
- integer -
- 		- -
Override the default stop timeout for the container with the given value.
-
-
- wants - -
- list - / elements=string
- 		- -
Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.
-
-
- gidmap - -
- list - / elements=string
- 		- -
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.
-
-
- hostname - -
- string -
- 		- -
Set a hostname to the pod
-
-
- infra - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
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.
-
-
- infra_command - -
- string -
- 		- -
The command that will be run to start the infra container. Default is "/pause".
-
-
- infra_conmon_pidfile - -
- string -
- 		- -
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.
-
-
- infra_image - -
- string -
- 		- -
The image that will be created for the infra container. Default is "k8s.gcr.io/pause:3.1".
-
-
- infra_name - -
- string -
- 		- -
The name that will be used for the pod's infra container.
-
-
- ip - -
- string -
- 		- -
Set a static IP for the pod's shared network.
-
-
- label - -
- dictionary -
- 		- -
Add metadata to a pod, pass dictionary of label keys and values.
-
-
- label_file - -
- string -
- 		- -
Read in a line delimited file of labels.
-
-
- mac_address - -
- string -
- 		- -
Set a static MAC address for the pod's shared network.
-
-
- name - -
- string - / required
- 		- -
Assign a name to the pod.
-
-
- network - -
- list - / elements=string
- 		- -
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.
-
-
- network_alias - -
- list - / elements=string
- 		- -
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.
-

aliases: network_aliases
-
-
- no_hosts - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Disable creation of /etc/hosts for the pod.
-
-
- pid - -
- string -
- 		- -
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.
-
-
- pod_id_file - -
- string -
- 		- -
Write the pod ID to the file.
-
-
- publish - -
- list - / elements=string
- 		- -
Publish a port or range of ports from the pod to the host.
-

aliases: ports
-
-
- recreate - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use with present and started states to force the re-creation of an existing pod.
-
-
- share - -
- string -
- 		- -
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.
-
-
- state - -
- string -
- 		-
    Choices: -
  • created ←
    • -
  • killed
    • -
  • restarted
    • -
  • absent
    • -
  • started
    • -
  • stopped
    • -
  • paused
    • -
  • unpaused
    • -
- 		-
This variable is set for state
-
-
- subgidname - -
- string -
- 		- -
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`.
-
-
- subuidname - -
- string -
- 		- -
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`.
-
-
- uidmap - -
- list - / elements=string
- 		- -
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.
-
-
- userns - -
- string -
- 		- -
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.
-
-
- volume - -
- list - / elements=string
- 		- -
Create a bind mount.
-

aliases: volumes
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- podman_pod:
-    name: pod1
-    state: started
-    ports:
-      - "4444:5555"
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
add_host

+
list / elements=string

+
Add a host to the /etc/hosts file shared between all containers in the pod.

+

+
blkio_weight

+
string

+
Block IO relative weight. The weight is a value between 10 and 1000.

+
This option is not supported on cgroups V1 rootless systems.

+

+
blkio_weight_device

+
list / elements=string

+
Block IO relative device weight.

+

+
cgroup_parent

+
string

+
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.

+

+
cpu_shares

+
string

+
CPU shares (relative weight).

+

+
cpus

+
string

+
Set the total number of CPUs delegated to the pod. Default is 0.000 which indicates that there is no limit on computation power.

+

+
cpuset_cpus

+
string

+
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

+

+
cpuset_mems

+
string

+
Memory nodes in which to allow execution (0-3, 0,1). Only effective on NUMA systems.

+

+
debug

+
boolean

+
Return additional information which can be helpful for investigations.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
device

+
list / elements=string

+
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)

+

+
device_read_bps

+
list / elements=string

+
Limit read rate (bytes per second) from a device (e.g. device-read-bps=/dev/sda:1mb)

+

+
device_write_bps

+
list / elements=string

+
Limit write rate (in bytes per second) to a device.

+

+
dns

+
list / elements=string

+
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.

+

+
dns_opt

+
list / elements=string

+
Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.

+

+
+
list / elements=string

+
Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
generate_systemd

+
dictionary

+
Generate systemd unit file for container.

+
Default: {}

+

+
after

+
list / elements=string

+
Add the systemd unit after (After=) option, that ordering dependencies between the list of dependencies and this service.

+

+
container_prefix

+
string

+
Set the systemd unit name prefix for containers. The default is β€œcontainer”.

+

+
names

+
boolean

+
Use names of the containers for the start, stop, and description in the unit file. Default is true.

+
Choices:

+
    
+
  • false
    • 
+
  • true ← (default)
    • 
+

+

+
new

+
boolean

+
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.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
no_header

+
boolean

+
Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
path

+
string

+
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.

+

+
pod_prefix

+
string

+
Set the systemd unit name prefix for pods. The default is β€œpod”.

+

+
requires

+
list / elements=string

+
Set the systemd unit requires (Requires=) option. Similar to wants, but declares a stronger requirement dependency.

+

+
restart_policy

+
string

+
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”.

+
Choices:

+
    
+
  • "no"
    • 
+
  • "on-success"
    • 
+
  • "on-failure"
    • 
+
  • "on-abnormal"
    • 
+
  • "on-watchdog"
    • 
+
  • "on-abort"
    • 
+
  • "always"
    • 
+

+

+
restart_sec

+
integer

+
Set the systemd service restartsec value.

+

+
separator

+
string

+
Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is β€œ-” (dash).

+

+
start_timeout

+
integer

+
Override the default start timeout for the container with the given value.

+

+
stop_timeout

+
integer

+
Override the default stop timeout for the container with the given value.

+

+
time

+
integer

+
Override the default stop timeout for the container with the given value.

+

+
wants

+
list / elements=string

+
Add the systemd unit wants (Wants=) option, that this service is (weak) dependent on.

+

+
gidmap

+
list / elements=string

+
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.

+

+
hostname

+
string

+
Set a hostname to the pod

+

+
infra

+
boolean

+
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.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
infra_command

+
string

+
The command that will be run to start the infra container. Default is β€œ/pause”.

+

+
infra_conmon_pidfile

+
string

+
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.

+

+
infra_image

+
string

+
The image that will be created for the infra container. Default is β€œk8s.gcr.io/pause:3.1”.

+

+
infra_name

+
string

+
The name that will be used for the pod’s infra container.

+

+
ip

+
string

+
Set a static IP for the pod’s shared network.

+

+
label

+
dictionary

+
Add metadata to a pod, pass dictionary of label keys and values.

+

+
label_file

+
string

+
Read in a line delimited file of labels.

+

+
mac_address

+
string

+
Set a static MAC address for the pod’s shared network.

+

+
memory

+
string

+
Set memory limit.

+
A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes).

+

+
memory_swap

+
string

+
Set limit value equal to memory plus swap.

+
A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes).

+

+
name

+
string / required

+
Assign a name to the pod.

+

+
network

+
list / elements=string

+
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.

+

+

+
network_alias

+
aliases: network_aliases

+
list / elements=string

+
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.

+

+
no_hosts

+
boolean

+
Disable creation of /etc/hosts for the pod.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+
pid

+
string

+
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.

+

+
pod_id_file

+
string

+
Write the pod ID to the file.

+

+

+
publish

+
aliases: ports

+
list / elements=string

+
Publish a port or range of ports from the pod to the host.

+

+
recreate

+
boolean

+
Use with present and started states to force the re-creation of an existing pod.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
share

+
string

+
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.

+

+
state

+
string

+
This variable is set for state

+
Choices:

+
    
+
  • "created" ← (default)
    • 
+
  • "killed"
    • 
+
  • "restarted"
    • 
+
  • "absent"
    • 
+
  • "started"
    • 
+
  • "stopped"
    • 
+
  • "paused"
    • 
+
  • "unpaused"
    • 
+

+

+
subgidname

+
string

+
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`.

+

+
subuidname

+
string

+
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`.

+

+
uidmap

+
list / elements=string

+
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.

+

+
userns

+
string

+
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.

+

+

+
volume

+
aliases: volumes

+
list / elements=string

+
Create a bind mount.

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- podman_pod:
+    name: pod1
+    state: started
+    ports:
+      - "4444:5555"
 
-# Connect random port from localhost to port 80 on pod2
-- name: Connect random port from localhost to port 80 on pod2
-  containers.podman.podman_pod:
-    name: pod2
-    state: started
-    publish: "127.0.0.1::80"
+# Connect random port from localhost to port 80 on pod2
+- name: Connect random port from localhost to port 80 on pod2
+  containers.podman.podman_pod:
+    name: pod2
+    state: started
+    publish: "127.0.0.1::80"
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- pod - -
- dictionary -
- 		always -
Pod inspection results for the given pod built.
-
-
Sample:
-
{'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'}}
-
-

+ + + + + + + + + + + +

Key

Description

+

pod

+

dictionary

+

Pod inspection results for the given pod built.

+

Returned: always

+

Sample: {"Config": {"cgroupParent": "/libpod_parent", "created": "2020-06-14T15:16:12.230818767+03:00", "hostname": "newpod", "id": "a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58", "infraConfig": {"infraPortBindings": null, "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"}}

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -961,11 +639,47 @@

Python

Navigation

+ + +

Related Topics

@@ -995,8 +709,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_save – Saves podman image to tar file — Python documentation + + + + containers.podman.podman_save module – Saves podman image to tar file — Python documentation - - - + + + @@ -32,187 +33,149 @@
-
-

containers.podman.podman_save – Saves podman image to tar fileΒΆ

+
+

containers.podman.podman_save module – Saves podman image to tar fileΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_save.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • 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.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- compress - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Compress tarball image layers when pushing to a directory using the 'dir' transport. (default is same compression type, compressed or uncompressed, as source)
-
-
- dest - -
- string - / required
- 		- -
Destination file to write image to.
-

aliases: path
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Force saving to file even if it exists.
-
-
- format - -
- string -
- 		-
    Choices: -
  • docker-archive
    • -
  • oci-archive
    • -
  • oci-dir
    • -
  • docker-dir
    • -
- 		-
Save image to docker-archive, oci-archive (see containers-transports(5)), oci-dir (oci transport), or docker-dir (dir transport with v2s2 manifest type).
-
-
- image - -
- string - / required
- 		- -
Image to save.
-
-
- multi_image_archive - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for docker-archive.
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- containers.podman.podman_save:
-    dest: /path/to/tar/file
-    compress: true
-    format: oci-dir
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
compress

+
boolean

+
Compress tarball image layers when pushing to a directory using the β€˜dir’ transport. (default is same compression type, compressed or uncompressed, as source)

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+

+
dest

+
aliases: path

+
string / required

+
Destination file to write image to.

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
force

+
boolean

+
Force saving to file even if it exists.

+
Choices:

+
    
+
  • false
    • 
+
  • true ← (default)
    • 
+

+

+
format

+
string

+
Save image to docker-archive, oci-archive (see containers-transports(5)), oci-dir (oci transport), or docker-dir (dir transport with v2s2 manifest type).

+
Choices:

+
    
+
  • "docker-archive"
    • 
+
  • "oci-archive"
    • 
+
  • "oci-dir"
    • 
+
  • "docker-dir"
    • 
+

+

+
image

+
string / required

+
Image to save.

+

+
multi_image_archive

+
boolean

+
Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for docker-archive.

+
Choices:

+
    
+
  • false
    • 
+
  • true
    • 
+

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- containers.podman.podman_save:
+    dest: /path/to/tar/file
+    compress: true
+    format: oci-dir
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Sagi Shnaidman (@sshnaidm)
    • 
 

-

-
-
+ + + +
@@ -231,11 +194,47 @@

Python

Navigation

+ + +

Related Topics

@@ -265,8 +264,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_secret – Manage podman secrets — Python documentation + + + + containers.podman.podman_secret module – Manage podman secrets — Python documentation - - - + + + @@ -32,217 +33,167 @@
-
-

containers.podman.podman_secret – Manage podman secretsΒΆ

+
+

containers.podman.podman_secret module – Manage podman secretsΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_secret.

-
-

New in version 1.7.0: of containers.podman

-
-
+

New in containers.podman 1.7.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Manage podman secrets

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- data - -
- string -
- 		- -
The value of the secret. Required when state is present.
-
-
- driver - -
- string -
- 		- -
Override default secrets driver, currently podman uses file which is unencrypted.
-
-
- driver_opts - -
- dictionary -
- 		- -
Driver-specific key-value options.
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- force - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use it when state is present to remove and recreate an existing secret.
-
-
- name - -
- string - / required
- 		- -
The name of the secret.
-
-
- skip_existing - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use it when state is present and secret with the same name already exists. If set to true, the secret will NOT be recreated and remains as is.
-
-
- state - -
- string -
- 		-
    Choices: -
  • absent
    • -
  • present ←
    • -
- 		-
Whether to create or remove the named secret.
-
-
-
-

ExamplesΒΆ

-
- name: Create secret
-  containers.podman.podman_secret:
-    state: present
-    name: mysecret
-    data: "my super secret content"
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
data

+
string

+
The value of the secret. Required when state is present.

+

+
driver

+
string

+
Override default secrets driver, currently podman uses file which is unencrypted.

+

+
driver_opts

+
dictionary

+
Driver-specific key-value options.

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
force

+
boolean

+
Use it when state is present to remove and recreate an existing secret.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
name

+
string / required

+
The name of the secret.

+

+
skip_existing

+
boolean

+
Use it when state is present and secret with the same name already exists. If set to true, the secret will NOT be recreated and remains as is.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
state

+
string

+
Whether to create or remove the named secret.

+
Choices:

+
    
+
  • "absent"
    • 
+
  • "present" ← (default)
    • 
+

+

+

+

+
ExamplesΒΆ

+
- name: Create secret
+  containers.podman.podman_secret:
+    state: present
+    name: mysecret
+    data: "my super secret content"
 
-- name: Create container that uses the secret
-  containers.podman.podman_container:
-    name: showmysecret
-    image: docker.io/alpine:3.14
-    secrets:
-      - mysecret
-    detach: false
-    command: cat /run/secrets/mysecret
-    register: container
+- name: Create container that uses the secret
+  containers.podman.podman_container:
+    name: showmysecret
+    image: docker.io/alpine:3.14
+    secrets:
+      - mysecret
+    detach: false
+    command: cat /run/secrets/mysecret
+    register: container
 
-- name: Output secret data
-  debug:
-    msg: '{{ container.stdout }}'
+- name: Output secret data
+  debug:
+    msg: '{{ container.stdout }}'
 
-- name: Remove secret
-  containers.podman.podman_secret:
-    state: absent
-    name: mysecret
+- name: Remove secret
+  containers.podman.podman_secret:
+    state: absent
+    name: mysecret
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Aliaksandr Mianzhynski (@amenzhinsky)
    • 
 

-

-
-
+ + + +
@@ -261,11 +212,47 @@

Python

Navigation

+ + +

Related Topics

@@ -295,8 +282,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_tag – Add an additional name to a local image — Python documentation + + + + containers.podman.podman_tag module – Add an additional name to a local image — Python documentation - - - + + + @@ -32,109 +33,98 @@
-
-

containers.podman.podman_tag – Add an additional name to a local imageΒΆ

+
+

containers.podman.podman_tag module – Add an additional name to a local imageΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_tag.

- -
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • podman tag adds one or more additional names to locally-stored image.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- image - -
- string - / required
- 		- -
Image to tag.
-
-
- target_names - -
- list - / elements=string / required
- 		- -
Additional names.
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- containers.podman.podman_tag:
-    image: docker.io/continuumio/miniconda3
-    target_names:
-      - miniconda3
-      - miniconda
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
image

+
string / required

+
Image to tag.

+

+
target_names

+
list / elements=string / required

+
Additional names.

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- containers.podman.podman_tag:
+    image: docker.io/continuumio/miniconda3
+    target_names:
+      - miniconda3
+      - miniconda
 

 

-

+

 
AuthorsΒΆ

 
    
 
  • Christian Bourque (@ocafebabe)
    • 
 

-

-
-
+ + + +
@@ -153,11 +143,47 @@

Python

Navigation

+ + +

Related Topics

@@ -187,8 +213,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_unshare – Run tasks using podman unshare — Python documentation + + + + containers.podman.podman_unshare become – Run tasks using podman unshare — Python documentation - - - + + + @@ -32,218 +33,187 @@
-
-

containers.podman.podman_unshare – Run tasks using podman unshareΒΆ

+
+

containers.podman.podman_unshare become – Run tasks using podman unshareΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This become plugin is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman_unshare.

-
-

New in version 1.9.0: of containers.podman

-
-
+

New in containers.podman 1.9.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

+
+
+

ParametersΒΆ

+ + + + + + + + + + + + + + + + + +

Parameter

Comments

+

become_exe

+

string

+

Sudo executable

+

Default: "sudo"

+

Configuration:

+
    +

  • INI entries:

    +
    [privilege_escalation]
+become_exe = sudo
+
    +
    +
    [sudo_become_plugin]
+executable = sudo
+
    +
    +
    • +

  • Environment variable: ANSIBLE_BECOME_EXE

    • +

  • Environment variable: ANSIBLE_SUDO_EXE

    • +

  • Variable: ansible_become_exe

    • +

  • Variable: ansible_sudo_exe

    • +
+
+

become_pass

+

string

+

Password to pass to sudo

+

Configuration:

+
    +

  • INI entry:

    +
    [sudo_become_plugin]
+password = VALUE
+
    -
    -

    ParametersΒΆ

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterChoices/DefaultsConfigurationComments
    -
    - become_exe - -
    - string -
    -     		- Default:
    "sudo"
    -     		-
    ini entries: -

    - [privilege_escalation]
    become_exe = sudo -

    -

    - [sudo_become_plugin]
    executable = sudo -

    -
    -
    - env:ANSIBLE_BECOME_EXE -
    -
    - env:ANSIBLE_SUDO_EXE -
    -
    - var: ansible_become_exe -
    -
    - var: ansible_sudo_exe -
    -     		-
    Sudo executable
    -
    -
    - become_pass - -
    - string -
    -     		- -
    ini entries: -

    - [sudo_become_plugin]
    password = None -

    -
    -
    - env:ANSIBLE_BECOME_PASS -
    -
    - env:ANSIBLE_SUDO_PASS -
    -
    - var: ansible_become_password -
    -
    - var: ansible_become_pass -
    -
    - var: ansible_sudo_pass -
    -     		-
    Password to pass to sudo
    -
    -
    - become_user - -
    - string -
    -     		- Default:
    "root"
    -     		-
    ini entries: -

    - [privilege_escalation]
    become_user = root -

    -

    - [sudo_become_plugin]
    user = root -

    -
    -
    - env:ANSIBLE_BECOME_USER -
    -
    - env:ANSIBLE_SUDO_USER -
    -
    - var: ansible_become_user -
    -
    - var: ansible_sudo_user -
    -     		-
    User you 'become' to execute the task
    -
    -
    -
    -

    ExamplesΒΆ

    -
    - name: checking uid of file 'foo'
-  ansible.builtin.stat:
-    path: "{{ test_dir }}/foo"
-  register: foo
-- ansible.builtin.debug:
-    var: foo.stat.uid
-# The output shows that it's owned by the login user
-# ok: [test_host] => {
-#     "foo.stat.uid": "1003"
-# }
+
    • +

  • Environment variable: ANSIBLE_BECOME_PASS

    • +

  • Environment variable: ANSIBLE_SUDO_PASS

    • +

  • Variable: ansible_become_password

    • +

  • Variable: ansible_become_pass

    • +

  • Variable: ansible_sudo_pass

    • +
+
+

become_user

+

string

+

User you β€˜become’ to execute the task (β€˜root’ is not a valid value here).

+

Configuration:

+
    +

  • INI entries:

    +
    [privilege_escalation]
+become_user = VALUE
+
    +
    +
    [sudo_become_plugin]
+user = VALUE
+
    +
    +
    • +

  • Environment variable: ANSIBLE_BECOME_USER

    • +

  • Environment variable: ANSIBLE_SUDO_USER

    • +

  • Variable: ansible_become_user

    • +

  • Variable: ansible_sudo_user

    • +
+
+
+
+

ExamplesΒΆ

+
- name: checking uid of file 'foo'
+  ansible.builtin.stat:
+    path: "{{ test_dir }}/foo"
+  register: foo
+- ansible.builtin.debug:
+    var: foo.stat.uid
+# The output shows that it's owned by the login user
+# ok: [test_host] => {
+#     "foo.stat.uid": "1003"
+# }
 
-- name: mounting the file to an unprivileged container and modifying its owner
-  containers.podman.podman_container:
-    name: chmod_foo
-    image: alpine
-    rm: yes
-    volume:
-    - "{{ test_dir }}:/opt/test:z"
-    command: chown 1000 /opt/test/foo
+- name: mounting the file to an unprivileged container and modifying its owner
+  containers.podman.podman_container:
+    name: chmod_foo
+    image: alpine
+    rm: true
+    volume:
+    - "{{ test_dir }}:/opt/test:z"
+    command: chown 1000 /opt/test/foo
 
-# Now the file 'foo' is owned by the container uid 1000,
-# which is mapped to something completaly different on the host.
-# It creates a situation when the file is unaccessible to the host user (uid 1003)
-# Running stat again, debug output will be like this:
-# ok: [test_host] => {
-#     "foo.stat.uid": "328679"
-# }
+# Now the file 'foo' is owned by the container uid 1000,
+# which is mapped to something completaly different on the host.
+# It creates a situation when the file is unaccessible to the host user (uid 1003)
+# Running stat again, debug output will be like this:
+# ok: [test_host] => {
+#     "foo.stat.uid": "328679"
+# }
 
-- name: running stat in modified user namespace
-  become_method: containers.podman.podman_unshare
-  become: yes
-  ansible.builtin.stat:
-    path: "{{ test_dir }}/foo"
-  register: foo
-# By gathering file stats with podman_ushare
-# we can see the uid set in the container:
-# ok: [test_host] => {
-#     "foo.stat.uid": "1000"
-# }
+- name: running stat in modified user namespace
+  become_method: containers.podman.podman_unshare
+  become: true
+  ansible.builtin.stat:
+    path: "{{ test_dir }}/foo"
+  register: foo
+# By gathering file stats with podman_ushare
+# we can see the uid set in the container:
+# ok: [test_host] => {
+#     "foo.stat.uid": "1000"
+# }
 
-- name: resetting file ownership with podman unshare
-  become_method: containers.podman.podman_unshare
-  become: yes
-  ansible.builtin.file:
-    state: file
-    path: "{{ test_dir }}/foo"
-    owner: 0  # in a modified user namespace host uid is mapped to 0
-# If we run stat and debug with 'become: no',
-# we can see that the file is ours again:
-# ok: [test_host] => {
-#     "foo.stat.uid": "1003"
-# }
+- name: resetting file ownership with podman unshare
+  become_method: containers.podman.podman_unshare
+  become: true
+  ansible.builtin.file:
+    state: file
+    path: "{{ test_dir }}/foo"
+    owner: 0  # in a modified user namespace host uid is mapped to 0
+# If we run stat and debug with 'become: false',
+# we can see that the file is ours again:
+# ok: [test_host] => {
+#     "foo.stat.uid": "1003"
+# }
-
+

AuthorsΒΆ

  • Janos Gerzson (@grzs)

+
+

Hint

+

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.

-
-
+
+ + +
@@ -262,11 +232,47 @@

Python

Navigation

+ + +

Related Topics

@@ -296,8 +302,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_volume_info – Gather info about podman volumes — Python documentation + + + + containers.podman.podman_volume_info module – Gather info about podman volumes — Python documentation - - - + + + @@ -32,15 +33,19 @@
-
-

containers.podman.podman_volume_info – Gather info about podman volumesΒΆ

+
+

containers.podman.podman_volume_info module – Gather info about podman volumesΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_volume_info.

-
+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Gather info about podman volumes with podman inspect command.

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • Podman installed on host

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- name - -
- string -
- 		- -
Name of the volume
-
-
-
-

ExamplesΒΆ

-
- name: Gather info about all present volumes
-  podman_volume_info:
-
-- name: Gather info about specific volume
-  podman_volume_info:
-    name: specific_volume
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
name

+
string

+
Name of the volume

+

+

+

+
ExamplesΒΆ

+
- name: Gather info about all present volumes
+  podman_volume_info:
+
+- name: Gather info about specific volume
+  podman_volume_info:
+    name: specific_volume
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- volumes - -
- list - / elements=string
- 		always -
Facts from all or specified volumes
-
-
Sample:
-
[{'driver': 'local', 'labels': {}, 'mountPoint': '/home/ansible/.local/share/testvolume/_data', 'name': 'testvolume', 'options': {}, 'scope': 'local'}]
-
-

+ + + + + + + + + + + +

Key

Description

+

volumes

+

list / elements=string

+

Facts from all or specified volumes

+

Returned: always

+

Sample: [{"driver": "local", "labels": {}, "mountPoint": "/home/ansible/.local/share/testvolume/_data", "name": "testvolume", "options": {}, "scope": "local"}]

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -167,11 +159,47 @@

Python

Navigation

+ + +

Related Topics

@@ -201,8 +229,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | - - containers.podman.podman_volume – Manage Podman volumes — Python documentation + + + + containers.podman.podman_volume module – Manage Podman volumes — Python documentation - - - + + + @@ -32,18 +33,20 @@
-
-

containers.podman.podman_volume – Manage Podman volumesΒΆ

+
+

containers.podman.podman_volume module – Manage Podman volumesΒΆ

Note

-

This plugin is part of the containers.podman collection (version 1.10.1).

-

To install it use: ansible-galaxy collection install containers.podman.

+

This module is part of the containers.podman collection (version 1.11.0).

+

It is not included in ansible-core. +To check whether it is installed, run ansible-galaxy collection list.

+

To install it, use: ansible-galaxy collection install containers.podman. +You need further requirements to be able to use this module, +see Requirements for details.

To use it in a playbook, specify: containers.podman.podman_volume.

-
-

New in version 1.1.0: of containers.podman

-
-
+

New in containers.podman 1.1.0

+
-
-

SynopsisΒΆ

+ +
+

SynopsisΒΆ

  • Manage Podman volumes

-
-
+
+

RequirementsΒΆ

The below requirements are needed on the host that executes this module.

  • podman

-
-
-

ParametersΒΆ

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- debug - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Return additional information which can be helpful for investigations.
-
-
- driver - -
- string -
- 		- -
Specify volume driver name (default local).
-
-
- executable - -
- string -
- 		- Default:
"podman"
- 		-
Path to podman executable if it is not in the $PATH on the machine running podman
-
-
- label - -
- dictionary -
- 		- -
Add metadata to a pod volume (e.g., label com.example.key=value).
-
-
- name - -
- string - / required
- 		- -
Name of volume.
-
-
- options - -
- list - / elements=string
- 		- -
Set driver specific options. For example 'device=tpmfs', 'type=tmpfs'. UID and GID idempotency is not supported due to changes in podman.
-
-
- recreate - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Recreate volume even if exists.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of volume, default 'present'
-
-
-
-

ExamplesΒΆ

-
# What modules does for example
-- podman_volume:
-    state: present
-    name: volume1
-    label:
-      key: value
-      key2: value2
-    options:
-      - "device=/dev/loop1"
-      - "type=ext4"
+
+

+
ParametersΒΆ

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameter
Comments

+
debug

+
boolean

+
Return additional information which can be helpful for investigations.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
driver

+
string

+
Specify volume driver name (default local).

+

+
executable

+
string

+
Path to podman executable if it is not in the $PATH on the machine running podman

+
Default: "podman"

+

+
label

+
dictionary

+
Add metadata to a pod volume (e.g., label com.example.key=value).

+

+
name

+
string / required

+
Name of volume.

+

+
options

+
list / elements=string

+
Set driver specific options. For example β€˜device=tpmfs’, β€˜type=tmpfs’. UID and GID idempotency is not supported due to changes in podman.

+

+
recreate

+
boolean

+
Recreate volume even if exists.

+
Choices:

+
    
+
  • false ← (default)
    • 
+
  • true
    • 
+

+

+
state

+
string

+
State of volume, default β€˜present’

+
Choices:

+
    
+
  • "present" ← (default)
    • 
+
  • "absent"
    • 
+

+

+

+

+
ExamplesΒΆ

+
# What modules does for example
+- podman_volume:
+    state: present
+    name: volume1
+    label:
+      key: value
+      key2: value2
+    options:
+      - "device=/dev/loop1"
+      - "type=ext4"
 

 

-
-
-

Return ValuesΒΆ

+ +
+

Return ValuesΒΆ

Common return values are documented here, the following are the fields unique to this module:

- - - - - - - - - - - -
KeyReturnedDescription
-
- volume - -
- dictionary -
- 		always -
Volume inspection results if exists.
-
-
Sample:
-
{'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'}
-
-

+ + + + + + + + + + + +

Key

Description

+

volume

+

dictionary

+

Volume inspection results if exists.

+

Returned: always

+

Sample: {"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"}

+
+

AuthorsΒΆ

  • Sagi Shnaidman (@sshnaidm)

-
-
-
+ + + +
@@ -276,11 +221,47 @@

Python

Navigation

+ + +

Related Topics

@@ -310,8 +291,8 @@

Quick search

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13 | @@ -11,10 +10,8 @@ - - - + @@ -85,6 +82,40 @@

Python

Navigation

+ + +

Related Topics

@@ -109,8 +140,8 @@

Related Topics

©. | - Powered by Sphinx 5.0.2 - & Alabaster 0.7.12 + Powered by Sphinx 7.0.1 + & Alabaster 0.7.13
diff --git a/docs/searchindex.js b/docs/searchindex.js index eb793a8a..068d0166 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["buildah_connection", "index", "podman_connection", "podman_container_info_module", "podman_container_module", "podman_containers_module", "podman_export_module", "podman_generate_systemd_module", "podman_image_info_module", "podman_image_module", "podman_import_module", "podman_load_module", "podman_login_info_module", "podman_login_module", "podman_logout_module", "podman_network_info_module", "podman_network_module", "podman_play_module", "podman_pod_info_module", "podman_pod_module", "podman_save_module", "podman_secret_module", "podman_tag_module", "podman_unshare_become", "podman_volume_info_module", "podman_volume_module"], "filenames": ["buildah_connection.rst", "index.rst", "podman_connection.rst", "podman_container_info_module.rst", "podman_container_module.rst", "podman_containers_module.rst", "podman_export_module.rst", "podman_generate_systemd_module.rst", "podman_image_info_module.rst", "podman_image_module.rst", "podman_import_module.rst", "podman_load_module.rst", "podman_login_info_module.rst", "podman_login_module.rst", "podman_logout_module.rst", "podman_network_info_module.rst", "podman_network_module.rst", "podman_play_module.rst", "podman_pod_info_module.rst", "podman_pod_module.rst", "podman_save_module.rst", "podman_secret_module.rst", "podman_tag_module.rst", "podman_unshare_become.rst", "podman_volume_info_module.rst", "podman_volume_module.rst"], "titles": ["containers.podman.buildah \u2013 Interact with an existing buildah container", "Containers.Podman", "containers.podman.podman \u2013 Interact with an existing podman container", "containers.podman.podman_container_info \u2013 Gather facts about containers using podman", "containers.podman.podman_container \u2013 Manage podman containers", "containers.podman.podman_containers \u2013 Manage podman containers in a batch", "containers.podman.podman_export \u2013 Export a podman container", "containers.podman.podman_generate_systemd \u2013 Generate systemd unit from a pod or a container", "containers.podman.podman_image_info \u2013 Gather info about images using podman", "containers.podman.podman_image \u2013 Pull images for use by podman", "containers.podman.podman_import \u2013 Import Podman container from a tar file.", "containers.podman.podman_load \u2013 Load image from a tar file.", "containers.podman.podman_login_info \u2013 Return the logged-in user if any for a given registry", "containers.podman.podman_login \u2013 Login to a container registry using podman", "containers.podman.podman_logout \u2013 Log out of a container registry using podman", "containers.podman.podman_network_info \u2013 Gather info about podman networks", "containers.podman.podman_network \u2013 Manage podman networks", "containers.podman.podman_play \u2013 Play kubernetes YAML file using podman", "containers.podman.podman_pod_info \u2013 Gather info about podman pods", "containers.podman.podman_pod \u2013 Manage Podman pods", "containers.podman.podman_save \u2013 Saves podman image to tar file", "containers.podman.podman_secret \u2013 Manage podman secrets", "containers.podman.podman_tag \u2013 Add an additional name to a local image", "containers.podman.podman_unshare \u2013 Run tasks using podman unshare", "containers.podman.podman_volume_info \u2013 Gather info about podman volumes", "containers.podman.podman_volume \u2013 Manage Podman volumes"], "terms": {"thi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "plugin": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "part": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "collect": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "version": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "10": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "0": [3, 4, 5, 7, 8, 9, 11, 12, 15, 16, 18, 19, 21, 23, 25], "To": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "instal": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "us": [0, 1, 2, 4, 5, 6, 7, 10, 11, 12, 15, 16, 18, 19, 20, 21, 22, 24, 25], "ansibl": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "galaxi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "playbook": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "specifi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "run": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "command": [0, 2, 4, 5, 7, 12, 13, 14, 15, 16, 18, 19, 21, 23, 24], "put": [0, 2], "fetch": [0, 2], "file": [0, 1, 2, 3, 4, 6, 7, 9, 12, 13, 14, 19, 21, 23], "tool": [0, 2, 14], "choic": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "default": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "configur": [0, 2, 3, 4, 7, 17, 18, 19, 23], "comment": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "remote_addr": [0, 2], "string": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "inventory_hostnam": [0, 2], "var": [0, 2, 3, 4, 8, 9, 11, 17, 23], "ansible_host": [0, 2], "The": [0, 2, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "id": [0, 2, 3, 4, 7, 8, 9, 10, 11, 18, 19], "you": [0, 2, 4, 7, 12, 13, 14, 16, 17, 23], "want": [0, 2, 4, 7, 19], "access": [0, 2, 4, 16], "remote_us": [0, 2], "ini": [0, 2, 23], "entri": [0, 2, 23], "none": [0, 2, 3, 4, 10, 19, 23], "env": [0, 2, 3, 4, 7, 8, 9, 11, 23], "ansible_remote_us": [0, 2], "ansible_us": [0, 2], "user": [0, 1, 2, 3, 4, 7, 8, 9, 10, 11, 13, 14, 19, 23, 25], "via": [0, 2, 4, 19], "name": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25], "which": [0, 2, 4, 5, 7, 16, 17, 19, 21, 23, 25], "execut": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "insid": [0, 2, 4], "toma": [0, 2], "tomecek": [0, 2], "tomastomecek": [0, 2], "These": 1, "ar": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "podman_unshar": 1, "task": [1, 4], "unshar": 1, "buildah": 1, "interact": [1, 4], "an": [1, 4, 7, 9, 11, 13, 17, 19, 20, 21, 23], "exist": [1, 4, 6, 7, 9, 14, 16, 17, 19, 20, 21, 25], "podman_contain": [1, 7, 21, 23], "manag": [1, 3], "podman_container_info": 1, "gather": [1, 23], "fact": [1, 4, 15, 16, 18, 24], "about": 1, "batch": 1, "podman_export": 1, "export": [1, 4, 7, 12, 13, 14, 17], "podman_generate_systemd": 1, "gener": [1, 4, 11, 19], "systemd": [1, 3, 4, 19], "unit": [1, 4, 19], "from": [1, 3, 4, 8, 9, 13, 14, 15, 16, 17, 18, 19, 24], "pod": [1, 3, 4, 17, 25], "podman_imag": 1, "pull": [1, 4, 17], "imag": [1, 3, 4, 5, 7, 10, 17, 19, 21, 23], "podman_image_info": 1, "info": [1, 4, 9, 10, 11, 17], "podman_import": 1, "import": 1, "tar": [1, 6], "podman_load": 1, "load": [1, 4, 9, 10], "podman_login": 1, "login": [1, 12, 14, 17, 23], "registri": [1, 4, 9, 17], "podman_login_info": 1, "return": [1, 5], "log": [1, 3, 4, 17], "ani": [1, 4, 7, 9, 14], "given": [1, 3, 4, 7, 8, 19], "podman_logout": 1, "out": 1, "podman_network": 1, "network": [1, 4, 17, 19], "podman_network_info": 1, "podman_plai": 1, "plai": 1, "kubernet": [1, 3, 4], "yaml": 1, "podman_pod": 1, "podman_pod_info": 1, "podman_sav": 1, "save": [1, 6, 10, 11], "podman_secret": 1, "secret": [1, 4], "podman_tag": 1, "add": [1, 4, 7, 9, 10, 16, 19, 25], "addit": [1, 4, 5, 16, 19, 20, 25], "local": [1, 3, 4, 6, 8, 9, 11, 15, 16, 20, 24, 25], "podman_volum": 1, "volum": [1, 3, 4, 9, 19, 23], "podman_volume_info": 1, "list": [1, 3, 4, 5, 7, 8, 9, 10, 13, 15, 16, 17, 18, 19, 22, 24, 25], "doc": [1, 23], "host": [1, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "here": [1, 3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "podman_execut": 2, "ansible_podman_execut": 2, "podman_extra_arg": 2, "ansible_podman_extra_arg": 2, "extra": [2, 9], "argument": [2, 4, 9], "pass": [2, 4, 9, 16, 17, 19, 23], "line": [2, 4, 19], "ansible_podman_host": 2, "uid": [2, 4, 8, 19, 23, 25], "If": [2, 3, 4, 7, 8, 9, 13, 14, 17, 19, 21, 23], "must": [2, 4, 7, 16, 19], "set": [2, 4, 7, 9, 10, 12, 13, 14, 17, 19, 21, 23, 25], "ansible_remote_tmp": 2, "path": [2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "exit": [2, 4], "writabl": 2, "below": [3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "need": [3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "modul": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "machin": [3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 25], "element": [3, 4, 5, 7, 8, 9, 10, 15, 16, 17, 18, 19, 22, 24, 25], "all": [3, 4, 7, 8, 14, 15, 17, 18, 19, 24], "mai": [3, 4, 7, 8, 9], "elev": [3, 8], "privileg": [3, 4, 8], "order": [3, 4, 7, 8, 19], "properli": [3, 8], "specif": [3, 4, 7, 8, 9, 15, 18, 19, 21, 24, 25], "web1": 3, "sever": [3, 8, 19], "redi": [3, 4, 8, 9], "common": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "document": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 23, 24, 25], "follow": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "field": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "uniqu": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "kei": [3, 4, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19, 21, 24, 25], "descript": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "dictionari": [3, 4, 5, 7, 8, 9, 10, 11, 12, 16, 19, 21, 25], "alwai": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "sampl": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "x27": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 17, 18, 19, 20, 23, 24, 25], "apparmorprofil": [3, 4], "arg": [3, 4, 9], "singl": [3, 4], "child": 3, "kolla_start": 3, "boundingcap": [3, 4], "cap_chown": [3, 4], "cap_dac_overrid": 3, "cap_fsetid": 3, "cap_fown": 3, "cap_mknod": 3, "cap_net_raw": 3, "cap_setgid": 3, "cap_setuid": 3, "cap_setfcap": 3, "cap_setpcap": 3, "cap_net_bind_servic": 3, "cap_sys_chroot": 3, "cap_kil": 3, "cap_audit_writ": 3, "config": [3, 4, 7, 10, 14, 17, 18, 19], "annot": [3, 4, 8, 9, 10, 11], "io": [3, 4, 7, 8, 9, 11, 12, 13, 14, 19, 21, 22, 23], "cri": [3, 4], "o": [3, 4], "containertyp": [3, 4], "sandbox": [3, 4], "tty": [3, 4], "fals": [3, 4, 8, 9, 11, 13, 14, 16, 17, 19, 21], "autoremov": 3, "init": [3, 4, 19], "publish": [3, 4, 19], "attachstderr": [3, 4], "attachstdin": [3, 4], "attachstdout": [3, 4], "cmd": [3, 4, 8, 9, 10, 11], "domainnam": [3, 4], "entrypoint": [3, 4, 8, 9, 11], "dumb": 3, "usr": [3, 4, 8, 9, 11], "bin": [3, 4, 8, 9, 10, 11], "sbin": [3, 4, 8, 9, 11], "term": [3, 4], "xterm": [3, 4], "hostnam": [3, 4, 18, 19], "oci": [3, 9, 10, 11, 20], "kolla_install_metatyp": 3, "rdo": 3, "kolla_base_distro": 3, "cento": 3, "kolla_install_typ": 3, "binari": [3, 4], "kolla_distro_python_vers": 3, "2": [3, 4, 8, 9, 11, 19], "7": [3, 21], "kolla_base_arch": 3, "x86_64": 3, "c5c39e813703": 3, "docker": [3, 4, 7, 8, 9, 11, 12, 14, 17, 20, 21, 22], "tripleomast": 3, "haproxi": 3, "latest": [3, 4, 7, 8, 9, 11, 23], "label": [3, 4, 8, 9, 10, 11, 18, 19, 24, 25], "build": [3, 9], "date": 3, "20190919": 3, "kolla_vers": 3, "8": [3, 4], "org": [3, 25], "schema": 3, "20190801": 3, "licens": 3, "gplv2": 3, "base": [3, 4, 16], "vendor": 3, "onbuild": 3, "openstdin": [3, 4], "stdinonc": [3, 4], "stopsign": [3, 4], "15": [3, 4], "workingdir": [3, 4], "creat": [3, 4, 7, 8, 9, 10, 11, 13, 14, 16, 17, 18, 19, 20, 21, 23], "2019": [3, 4, 9], "01t12": 3, "51": 3, "00": [3, 4, 10, 18, 19, 25], "233106443z": 3, "depend": [3, 4, 7, 19], "driver": [3, 4, 16, 17, 21, 24, 25], "overlai": [3, 4, 8, 9, 10, 11], "effectivecap": [3, 4], "execid": [3, 4], "exitcommand": [3, 4], "root": [3, 4, 10, 23], "lib": [3, 8, 9, 11, 17], "storag": [3, 8, 9, 11, 25], "runroot": 3, "level": [3, 4, 17], "error": [3, 4, 17], "cgroup": [3, 4, 19], "tmpdir": 3, "libpod": 3, "runtim": [3, 4], "runc": 3, "event": 3, "backend": [3, 15, 16], "journald": [3, 4], "cleanup": 3, "c9e813703f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f": 3, "graphdriv": [3, 4, 8, 9, 10, 11], "hostconfig": [3, 4], "bind": [3, 4, 19], "blkiodevicereadbp": 3, "blkiodevicereadiop": 3, "blkiodevicewritebp": 3, "blkiodevicewriteiop": 3, "blkioweight": 3, "blkioweightdevic": 3, "capadd": 3, "capdrop": 3, "cgrouppar": [3, 18, 19], "consoles": 3, "containeridfil": 3, "cpucount": 3, "cpuperc": 3, "cpuperiod": 3, "cpuquota": 3, "cpurealtimeperiod": 3, "cpurealtimeruntim": 3, "cpushar": 3, "cpusetcpu": 3, "cpusetmem": 3, "devic": [3, 4, 16, 19, 25], "diskquota": 3, "dn": [3, 4, 16, 19], "dnsoption": 3, "dnssearch": 3, "extrahost": 3, "groupadd": 3, "iomaximumbandwidth": 3, "iomaximumiop": 3, "ipcmod": 3, "isol": 3, "kernelmemori": 3, "link": 3, "logconfig": 3, "type": [3, 4, 8, 9, 10, 11, 15, 16, 19, 20, 25], "k8": [3, 4, 19], "memori": [3, 4], "memoryreserv": 3, "memoryswap": 3, "memoryswappi": 3, "nanocpu": 3, "networkmod": 3, "oomkilldis": 3, "oomscoreadj": 3, "pidmod": 3, "pidslimit": 3, "portbind": 3, "publishallport": 3, "readonlyrootf": 3, "restartpolici": 3, "maximumretrycount": 3, "securityopt": 3, "shmsize": 3, "65536000": 3, "tmpf": [3, 4, 25], "utsmod": 3, "ulimit": [3, 4], "hard": 3, "1048576": 3, "rlimit_nofil": 3, "soft": [3, 4], "rlimit_nproc": 3, "usernsmod": 3, "volumedriv": 3, "volumesfrom": 3, "hostnamepath": [3, 4], "hostspath": [3, 4], "c5c39f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f": 3, "0e267acda67d0ebd643e900d820a91b961d859743039e620191ca1": 3, "imagenam": [3, 4], "isinfra": [3, 4], "mountlabel": [3, 4], "system_u": [3, 4], "object_r": [3, 4], "svirt_sandbox_file_t": 3, "s0": [3, 4], "c78": 3, "c866": 3, "mount": [3, 4, 9, 19, 23], "namespac": [3, 4, 19, 23], "networkset": [3, 4], "bridg": [3, 4, 15, 16, 19], "endpointid": 3, "gatewai": [3, 15, 16], "globalipv6address": 3, "globalipv6prefixlen": 3, "hairpinmod": 3, "ipaddress": 3, "ipprefixlen": 3, "ipv6gatewai": 3, "linklocalipv6address": 3, "linklocalipv6prefixlen": 3, "macaddress": 3, "port": [3, 4, 19], "sandboxid": 3, "sandboxkei": 3, "secondaryipaddress": 3, "secondaryipv6address": 3, "ociruntim": 3, "processlabel": [3, 4], "system_r": [3, 4], "svirt_lxc_net_t": 3, "c785": 3, "resolvconfpath": [3, 4], "restartcount": [3, 4], "rootf": [3, 4, 8, 9, 10, 11], "state": [3, 4, 7, 9, 16, 17, 18, 19, 21, 23, 25], "dead": [3, 4], "exitcod": [3, 4], "finishedat": [3, 4], "0001": 3, "01": 3, "01t00": 3, "00z": 3, "healthcheck": [3, 4], "failingstreak": [3, 4], "statu": [3, 4, 18, 19], "oomkil": [3, 4], "ocivers": [3, 4], "dev": [3, 4, 19, 25], "paus": [3, 4, 19], "pid": [3, 4, 19], "restart": [3, 4, 7, 19], "startedat": [3, 4], "sagi": [3, 4, 5, 6, 10, 11, 15, 16, 17, 18, 19, 20, 24, 25], "shnaidman": [3, 4, 5, 6, 10, 11, 15, 16, 17, 18, 19, 20, 24, 25], "sshnaidm": [3, 4, 5, 6, 10, 11, 15, 16, 17, 18, 19, 20, 24, 25], "emilien": 3, "macchi": 3, "emilienm": 3, "new": [4, 5, 7, 9, 12, 15, 16, 17, 18, 19, 21, 23, 25], "start": [4, 7, 8, 11, 17, 19], "stop": [4, 7, 19], "format": [4, 9, 16, 19, 20], "multipl": [4, 9, 17, 19], "time": [4, 7, 17, 19], "authfil": [4, 9, 12, 13, 14, 17], "authent": [4, 9, 12, 13, 14, 17], "xdg_runtime_dir": [4, 12, 13, 14, 17], "auth": [4, 9, 12, 13, 14, 17], "json": [4, 9, 10, 12, 13, 14, 17], "Not": [4, 12], "avail": [4, 12, 17], "remot": [4, 9, 12, 17, 23], "can": [4, 5, 7, 12, 13, 14, 16, 17, 19, 23, 25], "also": [4, 9, 12, 13, 14, 17], "overrid": [4, 7, 12, 13, 14, 17, 19, 21], "registry_auth_fil": [4, 12, 13, 14, 17], "environ": [4, 7, 12, 13, 14, 17, 19], "variabl": [4, 7, 12, 13, 14, 17, 19], "blkio_weight": 4, "integ": [4, 7, 16, 19], "block": 4, "weight": 4, "rel": [4, 19], "accept": 4, "between": [4, 7, 19], "1000": [4, 23], "blkio_weight_devic": 4, "device_nam": 4, "cap_add": 4, "capabl": [4, 15, 16], "alias": [4, 9, 11, 19, 20], "cap_drop": 4, "drop": 4, "cgroup_par": [4, 19], "under": [4, 13, 14, 19], "absolut": [4, 19], "consid": [4, 19], "process": [4, 19], "thei": [4, 14, 19], "do": [4, 7, 19], "alreadi": [4, 7, 9, 17, 19, 21], "cgroupn": 4, "determin": 4, "whether": [4, 9, 21], "valid": [4, 9], "enabl": [4, 7, 16, 17, 19], "disabl": [4, 16, 19], "being": 4, "option": [4, 7, 9, 14, 16, 17, 19, 21, 24, 25], "forc": [4, 6, 9, 19, 20, 21], "thu": 4, "conflict": [4, 19], "parent": [4, 8, 9, 10, 11], "cidfil": 4, "write": [4, 19, 20], "cmd_arg": 4, "other": [4, 14], "param": 4, "Be": 4, "awar": 4, "doesn": [4, 19], "t": [4, 19], "support": [4, 7, 16, 19, 20, 25], "idempot": [4, 9, 25], "raw": 4, "conmon_pidfil": 4, "conmon": [4, 19], "separ": [4, 7, 9, 19], "than": [4, 7, 19, 20], "so": 4, "necessari": [4, 9, 19], "when": [4, 9, 13, 17, 19, 20, 21, 23], "cpu_period": 4, "limit": [4, 19], "cpu": [4, 19], "real": 4, "period": 4, "microsecond": 4, "cpu_rt_period": 4, "s": [4, 7, 9, 19, 23], "usag": [4, 7], "flag": [4, 13, 14, 19], "tell": 4, "kernel": [4, 19], "restrict": [4, 16], "cpu_rt_runtim": 4, "amount": 4, "consum": 4, "cpu_shar": 4, "share": [4, 19, 24, 25], "number": [4, 19], "mean": [4, 19], "cpuset_cpu": [4, 19], "allow": [4, 19, 20, 23], "3": [4, 5, 7, 9, 19, 21], "cpuset_mem": 4, "node": 4, "mem": 4, "onli": [4, 7, 9, 14, 17, 19, 20], "effect": 4, "numa": 4, "system": [4, 7], "debug": [4, 5, 16, 17, 19, 21, 23, 25], "boolean": [4, 5, 6, 7, 9, 13, 14, 16, 17, 19, 20, 21, 25], "nbsp": [4, 5, 6, 7, 9, 16, 19, 20, 21, 25], "larr": [4, 5, 6, 7, 9, 16, 19, 20, 21, 25], "ye": [4, 5, 6, 7, 9, 13, 14, 16, 17, 19, 20, 21, 23, 25], "inform": [4, 5, 7, 16, 19, 25], "help": [4, 5, 16, 19, 25], "investig": [4, 5, 16, 19, 25], "detach": [4, 21], "mode": [4, 7, 19], "detach_kei": 4, "sequenc": 4, "charact": 4, "ctrl": 4, "lt": [4, 8, 9, 11], "gt": [4, 8, 9, 11], "permiss": [4, 19], "e": [4, 7, 14, 19, 25], "g": [4, 7, 9, 14, 19, 25], "sdc": 4, "xvdc": 4, "rwm": 4, "device_read_bp": [4, 19], "read": [4, 17, 19], "rate": [4, 19], "byte": [4, 19], "per": [4, 19], "second": [4, 7, 19], "bp": [4, 19], "sda": [4, 19], "1mb": [4, 19], "device_read_iop": 4, "iop": 4, "device_write_bp": 4, "device_write_iop": 4, "custom": [4, 19], "server": [4, 12, 13, 14, 19], "dns_server": 4, "dns_option": 4, "dns_opt": [4, 19], "dns_search": [4, 19], "search": [4, 13, 14, 19], "domain": [4, 19], "don": 4, "wish": 4, "dns_search_domain": 4, "overwrit": 4, "arbitrari": 4, "launch": 4, "env_fil": 4, "delimit": [4, 19], "chang": [4, 10, 14, 25], "them": [4, 7, 19], "recreat": [4, 16, 17, 19, 21, 25], "env_host": 4, "current": [4, 16, 21], "etc_host": 4, "dict": 4, "ip": [4, 16, 19], "map": [4, 19, 23], "where": [4, 9, 19], "each": 4, "ad": 4, "etc": [4, 7, 9, 13, 17, 19], "add_host": [4, 19], "expos": 4, "rang": [4, 15, 16, 19], "quot": [4, 16, 17, 19], "3300": 4, "3310": 4, "up": 4, "redirect": 4, "exposed_port": 4, "force_restart": 4, "generate_systemd": [4, 19], "after": [4, 7, 9, 17, 19], "servic": [4, 7, 19], "container_prefix": [4, 7, 19], "prefix": [4, 7, 19], "true": [4, 8, 9, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21], "instead": [4, 7, 19, 20], "expect": [4, 19], "refer": [4, 7, 19], "more": [4, 7, 9, 19, 20, 22], "no_head": [4, 7, 19], "header": [4, 7, 19], "includ": [4, 7, 11, 19], "meta": [4, 7, 19], "data": [4, 5, 7, 8, 9, 10, 11, 19, 21], "timestamp": [4, 7, 19], "directori": [4, 9, 13, 17, 19, 20], "pod_prefix": [4, 7, 19], "similar": [4, 7, 19], "declar": [4, 7, 19], "stronger": [4, 7, 19], "restart_polici": [4, 7, 19], "success": [4, 7, 9, 19], "failur": [4, 7, 19], "abnorm": [4, 7, 19], "watchdog": [4, 7, 19], "abort": [4, 7, 19], "polici": [4, 7, 19], "one": [4, 9, 17, 19, 20, 22], "dash": [4, 19], "timeout": [4, 7, 19], "weak": [4, 7, 19], "gidmap": [4, 19], "suppli": [4, 19], "group_add": 4, "group": [4, 5], "alter": 4, "healthcheck_interv": 4, "interv": 4, "result": [4, 9, 19, 25], "automat": 4, "timer": 4, "setup": 4, "30": 4, "healthcheck_retri": 4, "retri": 4, "befor": [4, 7], "unhealthi": 4, "healthcheck_start_period": 4, "initi": 4, "bootstrap": 4, "express": 4, "like": [4, 23], "2m3": 4, "0s": 4, "healthcheck_timeout": 4, "maximum": 4, "complet": 4, "fail": [4, 14], "1m22": 4, "http_proxi": 4, "By": [4, 23], "proxi": [4, 9], "https_proxi": 4, "ftp_proxi": 4, "no_proxi": 4, "upper": 4, "case": [4, 14], "those": 4, "repositori": 4, "tag": [4, 8, 9, 16, 20, 22], "found": [4, 14, 17], "assum": 4, "image_strict": 4, "compar": 4, "take": [4, 7], "account": 4, "full": [4, 7], "image_volum": 4, "ignor": [4, 9, 14], "how": 4, "handl": 4, "builtin": [4, 7, 23], "forward": 4, "signal": 4, "reap": 4, "init_path": 4, "keep": 4, "stdin": 4, "open": 4, "even": [4, 6, 9, 16, 20, 25], "attach": 4, "static": [4, 19], "address": [4, 19], "88": [4, 15, 16], "64": 4, "128": [4, 16], "cni": [4, 15, 16, 17, 19], "join": [4, 17, 19], "were": 4, "anoth": 4, "within": [4, 17], "pool": [4, 8, 9, 11], "16": [4, 9, 15, 16, 19], "ipc": [4, 19], "privat": [4, 19], "posix": 4, "sysv": 4, "ipc_mod": 4, "kernel_memori": 4, "b": 4, "k": 4, "m": [4, 19], "note": [4, 17], "metadata": [4, 19, 25], "label_fil": [4, 19], "log_driv": [4, 17], "For": [4, 25], "log_level": [4, 17], "warn": [4, 14, 17], "fatal": [4, 17], "panic": [4, 17], "messag": [4, 10, 17], "abov": [4, 7, 17], "log_opt": 4, "max_siz": 4, "max": 4, "size": [4, 8, 9, 10, 11, 16], "10mb": 4, "mycontain": 4, "mac_address": [4, 19], "mac": [4, 19], "92": 4, "d0": 4, "c6": 4, "0a": 4, "29": [4, 18], "33": 4, "forget": 4, "ethernet": 4, "10k": 4, "memory_reserv": 4, "100m": 4, "memory_swap": 4, "A": [4, 7, 19], "equal": 4, "plu": 4, "swap": 4, "should": [4, 9, 17], "larger": 4, "doubl": 4, "memory_swappi": 4, "tune": 4, "swappi": 4, "behavior": 4, "100": 4, "filesystem": [4, 6, 10], "sourc": [4, 9, 17, 20], "destin": [4, 7, 9, 20], "stack": [4, 16], "reus": 4, "connect": [4, 13, 16, 17, 19], "defin": [4, 7], "ns": 4, "slirp4netn": 4, "rootless": 4, "net": [4, 8, 9, 11, 19], "network_mod": 4, "network_alias": [4, 19], "scope": [4, 19, 24, 25], "alia": [4, 19], "have": 4, "first": [4, 13, 14, 19], "remov": [4, 7, 9, 14, 21], "later": 4, "releas": 4, "no_host": [4, 19], "oom_kill_dis": 4, "oom": 4, "killer": 4, "oom_score_adj": 4, "prefer": 4, "pid_mod": 4, "pids_limit": 4, "unlimit": 4, "make": 4, "give": 4, "extend": 4, "hostport": [4, 18], "containerport": [4, 18], "In": 4, "chosen": 4, "randomli": 4, "published_port": 4, "publish_al": 4, "random": [4, 19], "interfac": [4, 16], "read_onli": 4, "read_only_tmpf": 4, "tmp": 4, "present": [4, 9, 15, 16, 18, 19, 21, 24, 25], "re": [4, 19], "creation": [4, 19], "kill": [4, 19], "max_retri": 4, "non": 4, "code": 4, "indefinit": 4, "until": 4, "count": 4, "hit": 4, "regardless": 4, "rm": [4, 9, 23], "auto_remov": 4, "explod": 4, "sdnotifi": 4, "notify_socket": 4, "notifi": 4, "opt": [4, 8, 9, 11, 16, 23], "see": [4, 7, 10, 20, 23], "detail": 4, "security_opt": 4, "secur": 4, "seccomp": [4, 17], "unconfin": 4, "shm_size": 4, "shm": 4, "greater": 4, "kilobyt": 4, "megabyt": 4, "gigabyt": 4, "omit": 4, "entir": 4, "64m": 4, "sig_proxi": 4, "sent": 4, "sigchld": 4, "sigstop": 4, "sigkil": 4, "absent": [4, 9, 16, 17, 19, 21, 25], "match": 4, "assert": 4, "provid": [4, 17, 19], "doe": [4, 6, 7, 9, 10, 11, 19, 20, 22, 25], "updat": [4, 16], "cannot": [4, 14], "request": 4, "taken": 4, "move": 4, "leav": [4, 17], "stop_sign": 4, "sigterm": 4, "stop_timeout": [4, 7], "subgidnam": [4, 19], "subgid": [4, 19], "subuidnam": [4, 19], "subuid": [4, 19], "sysctl": 4, "timezon": 4, "area": 4, "gmt": 4, "well": 4, "zoneinfo": 4, "conf": [4, 13, 14, 17, 19], "rw": 4, "787448k": 4, "1777": 4, "alloc": [4, 16], "pseudo": 4, "uidmap": [4, 19], "usernam": [4, 9, 12, 13, 17], "groupnam": 4, "gid": [4, 19, 25], "usern": [4, 19], "It": [4, 9, 17, 19, 23], "podman_usern": [4, 19], "empti": [4, 19], "userns_mod": 4, "ut": [4, 19], "dir": [4, 9, 20], "volumes_from": 4, "workdir": [4, 8, 9, 10, 11], "work": [4, 8, 9, 10, 11, 19], "working_dir": 4, "quai": [4, 8, 9, 11, 12, 13, 14], "bitnami": [4, 8, 9, 11], "wildfli": [4, 8, 9, 11], "mydata": 4, "busybox": 4, "myredi": 4, "appendonli": 4, "6379": 4, "120": 4, "ainer": 4, "myapplic": 4, "127": [4, 19], "xvda": 4, "8080": [4, 8, 9, 11], "9000": 4, "8081": 4, "9001": 4, "udp": 4, "secret_kei": 4, "ssssh": 4, "boolean_kei": 4, "ubuntu": [4, 8, 11], "14": [4, 8, 11, 21], "04": [4, 9], "sleep": [4, 5, 7], "1d": [4, 5], "4": [4, 5, 7, 9, 15, 16], "balanc": [4, 9], "item": [4, 9], "someus": 4, "anotherappimag": 4, "with_sequ": 4, "ohno": 4, "output": [4, 17, 21, 23], "myservic": 4, "repres": 4, "inspect": [4, 9, 15, 18, 19, 24, 25], "regist": [4, 7, 21, 23], "sinc": [4, 14], "compat": 4, "reason": 4, "directli": 4, "12": [4, 18, 19], "sh": [4, 8, 9, 10, 11], "librari": [4, 7], "null": 4, "conmonpidfil": 4, "06": [4, 8, 11, 19, 25], "17t19": 4, "13": [4, 8, 9, 11], "09": [4, 8, 9, 10, 11], "873858307": 4, "03": [4, 9, 10, 18, 19, 25], "logpath": 4, "container_file_t": 4, "c282": 4, "c782": 4, "container_t": 4, "157518963": 4, "4083": 4, "152479729": 4, "staticdir": 4, "three": 5, "onc": [5, 7], "alpin": [5, 21, 23], "web": 5, "nginx": [5, 8, 9], "test": [5, 23, 25], "python": 5, "v": 5, "tarbal": [6, 9, 10, 20], "dest": [6, 7, 9, 20], "what": [6, 10, 11, 19, 20, 22, 25], "check": [7, 9, 14, 17, 23], "target": [7, 13, 17], "append": 7, "But": 7, "onlin": 7, "overridden": [7, 13, 14], "man": 7, "page": 7, "restart_sec": 7, "start_timeout": 7, "use_nam": 7, "influenc": 7, "store": [7, 11, 14, 22], "your": [7, 23], "wide": 7, "Or": 7, "indic": [7, 19], "its": [7, 23], "systemctl": 7, "daemon": [7, 9], "reload": 7, "my_contain": 7, "exempl": 7, "integr": 7, "postgr": 7, "postgres_loc": 7, "daemon_reload": 7, "writ": 7, "postgres_local_systemd_unit": 7, "postgres_us": 7, "my_app": 7, "postgres_password": 7, "podman_command": 7, "copi": 7, "my_webapp": 7, "systemd_unit": 7, "content": [7, 21], "servec": 7, "s\u00e9bastien": 7, "gendr": 7, "cyberfox001": 7, "requir": [8, 9], "architectur": [8, 9, 10, 11], "amd64": [8, 9, 10, 11], "love": [8, 9, 11], "containerconfig": [8, 9, 11], "nami": [8, 9, 11], "foreground": [8, 11], "app": [8, 9, 11], "java": [8, 9, 11], "image_o": [8, 9, 11], "debian": [8, 9, 11], "9": [8, 9, 11, 23], "nami_vers": [8, 9, 11], "gpg_key_servers_list": [8, 9, 11], "ha": [8, 9, 11], "sk": [8, 9, 11], "keyserv": [8, 9, 11], "hkp": [8, 11], "p80": [8, 11], "80": [8, 11, 19], "com": [8, 9, 11, 25], "pgp": [8, 11], "mit": [8, 11], "edu": [8, 11], "tini_vers": [8, 9, 11], "v0": [8, 9, 11], "tini_gpg_kei": [8, 9, 11], "595e85a6b1b4779ea4daaec70b588dff0527a9b7": [8, 9, 11], "gosu_vers": [8, 9, 11], "gosu_gpg_kei": [8, 9, 11], "b42f6819007f00f88e364fd4036a9c25bf357dd4": [8, 9, 11], "bitnami_image_vers": [8, 9, 11], "r12": [8, 11], "bitnami_app_nam": [8, 9, 11], "wildfly_java_hom": [8, 9, 11], "wildfly_java_opt": [8, 9, 11], "wildfly_management_http_port_numb": [8, 9, 11], "9990": [8, 9, 11], "wildfly_password": [8, 9, 11], "wildfly_public_consol": [8, 9, 11], "wildfly_server_ajp_port_numb": [8, 9, 11], "8009": [8, 9, 11], "wildfly_server_http_port_numb": [8, 9, 11], "wildfly_server_interfac": [8, 9, 11], "wildfly_usernam": [8, 9, 11], "wildfly_wildfly_hom": [8, 9, 11], "home": [8, 9, 10, 11, 14, 17, 24, 25], "wildfly_wildfly_opt": [8, 9, 11], "dwildfli": [8, 9, 11], "deploy": [8, 9, 11], "ondemand": [8, 9, 11], "exposedport": [8, 9, 11], "tcp": [8, 9, 11, 18], "maintain": [8, 9, 11], "2018": [8, 11], "25t04": [8, 11], "07": [8, 11, 18], "45": [8, 10, 11], "934395523z": [8, 11], "digest": [8, 9, 10, 11], "sha256": [8, 9, 10, 11], "5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b": [8, 11], "lowerdir": [8, 9, 11], "a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f": [8, 11], "diff": [8, 9, 10, 11], "67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090": [8, 11], "7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca": [8, 11], "f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b": [8, 11], "1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7": [8, 11], "4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33": [8, 11], "6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632": [8, 11], "a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8": [8, 11], "537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f": [8, 11], "27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6": [8, 11], "566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6": [8, 11], "mergeddir": [8, 9, 11], "72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca": [8, 11], "merg": [8, 9, 11], "upperdir": [8, 9, 10, 11], "bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0": [8, 11], "manifesttyp": [8, 9, 10, 11], "applic": [8, 9, 10, 11], "vnd": [8, 9, 10, 11], "distribut": [8, 9, 11], "manifest": [8, 9, 10, 11, 20], "v1": [8, 9, 10, 11], "prettyjw": [8, 9, 11], "os": [8, 9, 10, 11], "linux": [8, 9, 10, 11], "repodigest": [8, 9, 10, 11], "repotag": [8, 9, 10, 11], "layer": [8, 9, 10, 11, 20], "75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367": [8, 11], "7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731": [8, 11], "720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d": [8, 11], "6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47": [8, 11], "59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c": [8, 11], "310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db": [8, 11], "36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79": [8, 11], "569919342": [8, 11], "17": [8, 11], "ce": [8, 11], "virtuals": [8, 9, 10, 11], "sam": [8, 9], "doran": [8, 9], "samdoran": [8, 9], "push": [9, 20], "auth_fil": 9, "credenti": [9, 14], "control": 9, "build_arg": 9, "buildarg": 9, "pair": [9, 10], "cach": [9, 14], "extra_arg": 9, "containerfil": 9, "context": 9, "force_rm": 9, "intermedi": 9, "unsuccess": 9, "built": [9, 19], "ca_cert_dir": 9, "tl": [9, 13, 17], "certif": [9, 13, 17], "delet": [9, 14, 17], "password": [9, 13, 17, 23], "push_arg": 9, "compress": [9, 20], "transport": [9, 20], "url": 9, "v2s1": 9, "v2s2": [9, 20], "remove_signatur": 9, "discard": 9, "pre": 9, "signatur": 9, "sign_bi": 9, "sign": 9, "archiv": [9, 11, 20], "ostre": 9, "attempt": 9, "validate_cert": 9, "http": [9, 13, 17, 23], "dure": 9, "tlsverifi": [9, 13], "tls_verifi": [9, 17], "0e901e68141f": 9, "basic": 9, "advanc": 9, "function": 9, "my": [9, 21], "cool": 9, "acm": 9, "bug": 9, "vault_registry_password": 9, "loop": 9, "wa": 9, "r27": 9, "bitnami_pkg_chmod": 9, "r": [9, 19], "rwx": 9, "bitnami_pkg_extra_dir": 9, "nami_prefix": 9, "wildfly_hom": 9, "1001": 9, "10t05": 9, "48": 9, "553887623z": 9, "5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b": 9, "142c1beadf1bb09fbd929465ec98c9dca3256638220450efb4214727d0d0680": 9, "9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea": 9, "histori": [9, 10], "09t22": 9, "27": 9, "40": 9, "659377677z": 9, "38": [9, 10, 25], "53": 9, "86336555z": 9, "created_bi": [9, 10], "c": [9, 10], "nop": [9, 10], "empty_lay": 9, "54": 9, "022778765z": 9, "ace34da54e4af2145e1ad277005adb235a214e4dfe1114c2db9ab460b840f785": 9, "466180019": 9, "18": 9, "gz": 10, "tgz": 10, "bzip": 10, "xz": 10, "txz": 10, "commit_messag": 10, "commit": 10, "src": 10, "bash": 10, "2021": 10, "07t04": 10, "749977105": 10, "8730c75be86a718929a658db4663d487e562d66762": 10, "34": 10, "091": 10, "cbc6d73c4d232db6e8441df96af81855f62c74157b5db80a1d5": 10, "nameshistori": 10, "5882449": 10, "either": [11, 20], "input": 11, "hub": 12, "logged_in": 12, "clelang": [12, 13, 14], "clemen": [12, 13, 14], "lang": [12, 13, 14], "certdir": 13, "crt": [13, 17], "cert": [13, 17], "d": [13, 17], "verifi": [13, 17], "contact": [13, 17], "explicitli": [13, 14, 17], "verif": [13, 17], "unless": [13, 14, 17], "insecur": [13, 17], "p4ssw0rd": 13, "jason": 13, "hiatt": 13, "jthiatt": 13, "logout": 14, "howev": 14, "ignore_docker_credenti": 14, "correspond": 14, "kept": 14, "togeth": 14, "cnivers": [15, 16], "podman0": [15, 16], "ipmasq": [15, 16], "ipam": [15, 16], "subnet": [15, 16], "rout": [15, 16], "dst": [15, 16], "isgatewai": [15, 16], "portmap": [15, 16], "iptabl": [15, 16], "firewal": [15, 16], "disable_dn": 16, "ipv4": 16, "ipv6": 16, "intern": 16, "extern": 16, "ip_rang": 16, "dual": 16, "macvlan": 16, "vlan": 16, "mtu": 16, "vlan_filt": 16, "cidr": 16, "becom": [16, 23], "podman_intern": 16, "192": 16, "168": 16, "22": 16, "25": 16, "24": 16, "structur": 17, "describ": [17, 19], "cert_dir": 17, "client": 17, "configmap": 17, "valu": [17, 21], "kube_fil": 17, "call": 17, "quiet": 17, "hide": 17, "seccomp_profile_root": 17, "profil": 17, "kubelet": 17, "kube": 17, "special_pod": 18, "libpod_par": [18, 19], "2020": [18, 19, 25], "13t20": 18, "572282186": 18, "pod1host": 18, "d9cb6dbb0": 18, "infraconfig": [18, 19], "infraportbind": [18, 19], "7111": 18, "hostip": 18, "7777": 18, "protocol": 18, "makeinfracontain": [18, 19], "lockid": [18, 19], "682": 18, "pod1": [18, 19], "sharescgroup": [18, 19], "sharesipc": [18, 19], "sharesnet": [18, 19], "sharesut": [18, 19], "ad46737bf": 18, "cgrouppath": [18, 19], "infracontainerid": [18, 19], "he": 19, "total": 19, "deleg": 19, "000": 19, "comput": 19, "power": 19, "unlik": 19, "pars": 19, "combin": 19, "w": 19, "mknod": 19, "resolv": 19, "special": 19, "infra": 19, "associ": 19, "lightweight": 19, "coordin": 19, "infra_command": 19, "infra_conmon_pidfil": 19, "As": 19, "infra_imag": 19, "gcr": 19, "infra_nam": 19, "assign": 19, "network_alia": 19, "pod_id_fil": 19, "comma": 19, "choos": 19, "unpaus": 19, "wai": 19, "differ": [19, 23], "4444": 19, "5555": 19, "localhost": 19, "pod2": 19, "14t15": 19, "230818767": 19, "newpod": 19, "a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58": 19, "515": 19, "dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2": 19, "same": [20, 21], "uncompress": 20, "5": 20, "multi_image_arch": 20, "interpret": 20, "unencrypt": 21, "driver_opt": 21, "skip_exist": 21, "NOT": 21, "remain": 21, "mysecret": 21, "super": 21, "showmysecret": 21, "cat": 21, "msg": 21, "stdout": 21, "aliaksandr": 21, "mianzhynski": 21, "amenzhinski": 21, "target_nam": 22, "continuumio": 22, "miniconda3": 22, "miniconda": 22, "christian": 22, "bourqu": 22, "ocafebab": 22, "offici": 23, "en": 23, "markdown": 23, "html": 23, "become_ex": 23, "sudo": 23, "privilege_escal": 23, "sudo_become_plugin": 23, "ansible_become_ex": 23, "ansible_sudo_ex": 23, "become_pass": 23, "ansible_become_pass": 23, "ansible_sudo_pass": 23, "ansible_become_password": 23, "become_us": 23, "ansible_become_us": 23, "ansible_sudo_us": 23, "foo": 23, "stat": 23, "test_dir": 23, "show": 23, "own": 23, "ok": 23, "test_host": 23, "1003": 23, "unprivileg": 23, "modifi": 23, "owner": 23, "chmod_foo": 23, "z": 23, "chown": 23, "now": 23, "someth": 23, "completali": 23, "situat": 23, "unaccess": 23, "again": 23, "328679": 23, "become_method": 23, "podman_ushar": 23, "we": 23, "reset": 23, "ownership": 23, "our": 23, "jano": 23, "gerzson": 23, "grz": 23, "specific_volum": 24, "mountpoint": [24, 25], "testvolum": 24, "_data": [24, 25], "tpmf": 25, "due": 25, "volume1": 25, "key2": 25, "value2": 25, "loop1": 25, "ext4": 25, "createdat": 25, "05t16": 25, "55": 25, "277628769": 25}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"contain": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "podman": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "buildah": 0, "interact": [0, 2], "an": [0, 2, 22], "exist": [0, 2], "synopsi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "paramet": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "author": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "plugin": 1, "index": 1, "becom": 1, "connect": 1, "modul": 1, "podman_container_info": 3, "gather": [3, 8, 15, 18, 24], "fact": 3, "about": [3, 8, 15, 18, 24], "us": [3, 8, 9, 13, 14, 17, 23], "requir": [3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25], "note": [3, 7, 8], "exampl": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "return": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "valu": [3, 4, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 24, 25], "podman_contain": [4, 5], "manag": [4, 5, 16, 19, 21, 25], "batch": 5, "podman_export": 6, "export": 6, "podman_generate_systemd": 7, "gener": 7, "systemd": 7, "unit": 7, "from": [7, 10, 11], "pod": [7, 18, 19], "podman_image_info": 8, "info": [8, 15, 18, 24], "imag": [8, 9, 11, 20, 22], "podman_imag": 9, "pull": 9, "podman_import": 10, "import": 10, "tar": [10, 11, 20], "file": [10, 11, 17, 20], "podman_load": 11, "load": 11, "podman_login_info": 12, "log": [12, 14], "user": 12, "ani": 12, "given": 12, "registri": [12, 13, 14], "podman_login": 13, "login": 13, "podman_logout": 14, "out": 14, "podman_network_info": 15, "network": [15, 16], "podman_network": 16, "podman_plai": 17, "plai": 17, "kubernet": 17, "yaml": 17, "podman_pod_info": 18, "podman_pod": 19, "podman_sav": 20, "save": 20, "podman_secret": 21, "secret": 21, "podman_tag": 22, "add": 22, "addit": 22, "name": 22, "local": 22, "podman_unshar": 23, "run": 23, "task": 23, "unshar": 23, "podman_volume_info": 24, "volum": [24, 25], "podman_volum": 25}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["buildah_connection", "environment_variables", "index", "podman_connection", "podman_container_exec_module", "podman_container_info_module", "podman_container_module", "podman_containers_module", "podman_export_module", "podman_generate_systemd_module", "podman_image_info_module", "podman_image_module", "podman_import_module", "podman_load_module", "podman_login_info_module", "podman_login_module", "podman_logout_module", "podman_network_info_module", "podman_network_module", "podman_play_module", "podman_pod_info_module", "podman_pod_module", "podman_prune_module", "podman_runlabel_module", "podman_save_module", "podman_secret_module", "podman_tag_module", "podman_unshare_become", "podman_volume_info_module", "podman_volume_module"], "filenames": ["buildah_connection.rst", "environment_variables.rst", "index.rst", "podman_connection.rst", "podman_container_exec_module.rst", "podman_container_info_module.rst", "podman_container_module.rst", "podman_containers_module.rst", "podman_export_module.rst", "podman_generate_systemd_module.rst", "podman_image_info_module.rst", "podman_image_module.rst", "podman_import_module.rst", "podman_load_module.rst", "podman_login_info_module.rst", "podman_login_module.rst", "podman_logout_module.rst", "podman_network_info_module.rst", "podman_network_module.rst", "podman_play_module.rst", "podman_pod_info_module.rst", "podman_pod_module.rst", "podman_prune_module.rst", "podman_runlabel_module.rst", "podman_save_module.rst", "podman_secret_module.rst", "podman_tag_module.rst", "podman_unshare_become.rst", "podman_volume_info_module.rst", "podman_volume_module.rst"], "titles": ["containers.podman.buildah connection \u2013 Interact with an existing buildah container", "Index of all Collection Environment Variables", "Containers.Podman", "containers.podman.podman connection \u2013 Interact with an existing podman container", "containers.podman.podman_container_exec module \u2013 Executes a command in a running container.", "containers.podman.podman_container_info module \u2013 Gather facts about containers using podman", "containers.podman.podman_container module \u2013 Manage podman containers", "containers.podman.podman_containers module \u2013 Manage podman containers in a batch", "containers.podman.podman_export module \u2013 Export a podman container", "containers.podman.podman_generate_systemd module \u2013 Generate systemd unit from a pod or a container", "containers.podman.podman_image_info module \u2013 Gather info about images using podman", "containers.podman.podman_image module \u2013 Pull images for use by podman", "containers.podman.podman_import module \u2013 Import Podman container from a tar file.", "containers.podman.podman_load module \u2013 Load image from a tar file.", "containers.podman.podman_login_info module \u2013 Return the logged-in user if any for a given registry", "containers.podman.podman_login module \u2013 Login to a container registry using podman", "containers.podman.podman_logout module \u2013 Log out of a container registry using podman", "containers.podman.podman_network_info module \u2013 Gather info about podman networks", "containers.podman.podman_network module \u2013 Manage podman networks", "containers.podman.podman_play module \u2013 Play kubernetes YAML file using podman", "containers.podman.podman_pod_info module \u2013 Gather info about podman pods", "containers.podman.podman_pod module \u2013 Manage Podman pods", "containers.podman.podman_prune module \u2013 Allows to prune various podman objects", "containers.podman.podman_runlabel module \u2013 Run given label from given image", "containers.podman.podman_save module \u2013 Saves podman image to tar file", "containers.podman.podman_secret module \u2013 Manage podman secrets", "containers.podman.podman_tag module \u2013 Add an additional name to a local image", "containers.podman.podman_unshare become \u2013 Run tasks using podman unshare", "containers.podman.podman_volume_info module \u2013 Gather info about podman volumes", "containers.podman.podman_volume module \u2013 Manage Podman volumes"], "terms": {"thi": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "plugin": [0, 1, 3, 17, 18, 27], "i": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "part": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "version": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "1": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "10": [5, 6, 7, 10, 11, 13, 17, 18, 21, 22], "4": [6, 7, 9, 11, 17, 18], "It": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "includ": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "ansibl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "core": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "To": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "check": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "whether": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "instal": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "run": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 28, 29], "galaxi": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "list": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "us": [0, 1, 2, 3, 4, 6, 7, 8, 9, 12, 13, 14, 17, 18, 20, 21, 22, 23, 24, 25, 26, 28, 29], "playbook": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "specifi": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "command": [0, 1, 2, 3, 6, 7, 9, 14, 15, 16, 17, 18, 20, 21, 25, 27, 28], "put": [0, 3], "fetch": [0, 3], "file": [0, 2, 3, 5, 6, 8, 9, 11, 14, 15, 16, 21, 25, 27], "tool": [0, 3, 16], "comment": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "remote_addr": [0, 3], "string": [0, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "The": [0, 1, 3, 4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "id": [0, 3, 4, 5, 6, 9, 10, 11, 12, 13, 20, 21, 22], "you": [0, 1, 3, 4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "want": [0, 3, 6, 9, 21], "access": [0, 3, 6, 18], "default": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "inventory_hostnam": [0, 3], "configur": [0, 1, 3, 5, 6, 9, 19, 20, 21, 27], "variabl": [0, 3, 4, 6, 9, 14, 15, 16, 19, 21, 27], "ansible_host": [0, 3], "remote_us": [0, 3], "user": [0, 1, 2, 3, 4, 5, 6, 9, 10, 11, 12, 13, 15, 16, 19, 21, 27, 29], "via": [0, 3, 6, 21], "name": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 27, 28, 29], "which": [0, 3, 6, 7, 9, 18, 19, 21, 25, 27, 29], "execut": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "insid": [0, 3, 4, 6], "ini": [0, 3, 27], "entri": [0, 3, 27], "valu": [0, 1, 3, 19, 25, 27], "environ": [0, 3, 4, 6, 9, 14, 15, 16, 19, 21, 27], "ansible_remote_us": [0, 3], "ansible_us": [0, 3], "toma": [0, 3], "tomecek": [0, 3], "tomastomecek": [0, 3], "each": [0, 3, 6, 19, 27], "type": [0, 3, 5, 6, 10, 11, 12, 13, 17, 18, 21, 24, 27, 29], "have": [0, 3, 6, 18, 27], "low": [0, 3, 27], "high": [0, 3, 27], "prioriti": [0, 3, 27], "order": [0, 3, 5, 6, 9, 10, 21, 27], "For": [0, 3, 6, 22, 27, 29], "exampl": [0, 3], "lower": [0, 3, 27], "overrid": [0, 3, 6, 9, 14, 15, 16, 19, 21, 25, 27], "higher": [0, 3, 27], "up": [0, 3, 6, 27], "issu": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "tracker": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "repositori": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "sourc": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "follow": [1, 4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "document": [1, 4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 27, 28, 29], "declar": [1, 6, 9, 21], "ar": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "ansible_configuration_set": 1, "ansible_become_pass": [1, 27], "password": [1, 11, 15, 19, 27], "pass": [1, 3, 4, 6, 11, 18, 19, 21, 27], "sudo": [1, 27], "contain": 1, "podman": 1, "podman_unshar": [1, 2], "becom": [1, 18], "ansible_podman_execut": [1, 3], "connect": [1, 6, 15, 18, 19, 21], "ansible_podman_extra_arg": [1, 3], "extra": [1, 3, 11], "argument": [1, 3, 6, 11], "line": [1, 3, 6, 21], "ansible_sudo_ex": [1, 27], "ansible_sudo_pass": [1, 27], "ansible_sudo_us": [1, 27], "task": [1, 2, 6], "root": [1, 5, 6, 12, 27], "valid": [1, 6, 11, 27], "here": [1, 4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 27, 28, 29], "collect": 2, "author": 2, "sagi": [2, 5, 6, 7, 8, 12, 13, 17, 18, 19, 20, 21, 24, 28, 29], "shnaidman": [2, 5, 6, 7, 8, 12, 13, 17, 18, 19, 20, 21, 24, 28, 29], "sshnaidm": [2, 5, 6, 7, 8, 12, 13, 17, 18, 19, 20, 21, 24, 28, 29], "redhat": [2, 4], "com": [2, 10, 11, 13, 29], "team": 2, "support": [2, 6, 9, 18, 21, 24, 29], "2": [2, 5, 6, 10, 11, 13, 21], "8": [2, 5, 6], "newer": 2, "These": 2, "podman_contain": [2, 9, 25, 27], "manag": [2, 5], "podman_container_exec": 2, "podman_container_info": 2, "gather": [2, 27], "fact": [2, 6, 17, 18, 20, 28], "about": 2, "batch": 2, "podman_export": 2, "export": [2, 6, 9, 14, 15, 16, 19], "podman_generate_systemd": 2, "gener": [2, 6, 13, 21], "systemd": [2, 5, 6, 21], "unit": [2, 6, 21], "from": [2, 5, 6, 10, 11, 15, 16, 17, 18, 19, 20, 21, 28], "pod": [2, 5, 6, 19, 22, 29], "podman_imag": 2, "pull": [2, 6, 19], "imag": [2, 5, 6, 7, 9, 12, 19, 21, 22, 25, 27], "podman_image_info": 2, "info": [2, 6, 11, 12, 13, 19], "podman_import": 2, "import": 2, "tar": [2, 8], "podman_load": 2, "load": [2, 6, 11, 12], "podman_login": 2, "login": [2, 14, 16, 19, 27], "registri": [2, 6, 11, 19], "podman_login_info": 2, "return": [2, 7], "log": [2, 5, 6, 19], "ani": [2, 6, 9, 11, 16, 22], "given": [2, 5, 6, 9, 10, 21], "podman_logout": 2, "out": 2, "podman_network": 2, "network": [2, 6, 19, 21, 22], "podman_network_info": 2, "podman_plai": 2, "plai": 2, "kubernet": [2, 5, 6], "yaml": 2, "podman_pod": 2, "podman_pod_info": 2, "podman_prun": 2, "allow": [2, 6, 21, 24, 27], "prune": 2, "variou": 2, "object": 2, "podman_runlabel": 2, "label": [2, 5, 6, 10, 11, 12, 13, 20, 21, 28, 29], "podman_sav": 2, "save": [2, 8, 12, 13], "podman_secret": 2, "secret": [2, 6], "podman_tag": 2, "add": [2, 6, 9, 11, 12, 18, 21, 29], "an": [2, 6, 9, 11, 13, 15, 19, 21, 24, 25, 27], "addit": [2, 6, 7, 18, 21, 24, 29], "local": [2, 5, 6, 8, 10, 11, 13, 17, 18, 19, 24, 28, 29], "podman_volum": 2, "volum": [2, 5, 6, 8, 11, 12, 21, 22, 27], "podman_volume_info": 2, "unshar": 2, "buildah": 2, "interact": [2, 6], "exist": [2, 6, 8, 9, 11, 16, 18, 19, 21, 24, 25, 29], "podman_execut": 3, "podman_extra_arg": 3, "ansible_podman_host": 3, "uid": [3, 4, 6, 10, 21, 27, 29], "If": [3, 4, 5, 6, 9, 10, 11, 15, 16, 18, 19, 21, 25, 27], "must": [3, 6, 9, 18, 21], "set": [3, 4, 6, 9, 11, 12, 14, 15, 16, 18, 19, 21, 25, 27, 29], "ansible_remote_tmp": 3, "path": [3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 29], "exit": [3, 4, 6], "writabl": 3, "need": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "further": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "abl": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "see": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "detail": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "below": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "host": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "argv": 4, "element": [4, 5, 6, 7, 9, 10, 11, 12, 17, 18, 19, 20, 21, 22, 26, 28, 29], "rather": [4, 6], "than": [4, 6, 9, 21, 22, 24], "One": 4, "arg": [4, 5, 6, 11], "detach": [4, 6, 25], "boolean": [4, 6, 7, 8, 9, 11, 15, 16, 18, 19, 21, 22, 24, 25, 29], "true": [4, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 27, 29], "background": 4, "exec": 4, "session": 4, "automat": [4, 6], "remov": [4, 6, 9, 11, 16, 18, 25], "when": [4, 6, 9, 11, 15, 19, 21, 22, 24, 25, 27], "complet": [4, 6], "choic": [4, 6, 7, 8, 9, 11, 15, 16, 18, 19, 21, 22, 24, 25, 29], "fals": [4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 16, 18, 19, 21, 22, 24, 25, 27, 29], "env": [4, 5, 6, 9, 10, 11, 13], "dictionari": [4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 18, 21, 22, 25, 29], "where": [4, 6, 11, 21], "privileg": [4, 5, 6, 10], "give": [4, 6], "extend": [4, 6], "tty": [4, 5, 6], "alloc": [4, 6, 18], "pseudo": [4, 6], "usernam": [4, 6, 11, 14, 15, 19], "option": [4, 6, 9, 11, 16, 18, 19, 21, 25, 28, 29], "groupnam": [4, 6], "gid": [4, 6, 21, 29], "both": 4, "group": [4, 6, 7], "mai": [4, 5, 6, 9, 10, 11], "symbol": 4, "numer": 4, "workdir": [4, 6, 10, 11, 12, 13], "work": [4, 6, 9, 10, 11, 12, 13, 21], "directori": [4, 6, 11, 15, 19, 21, 24], "ubi8": 4, "cat": [4, 25], "releas": [4, 6], "etc": [4, 6, 9, 11, 15, 19, 21], "test_contain": 4, "bin": [4, 5, 6, 10, 11, 12, 13], "sh": [4, 6, 10, 11, 12, 13], "c": [4, 11, 12], "echo": [4, 6], "hello": 4, "bye": 4, "world": 4, "goodby": 4, "detach_contain": 4, "common": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "field": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "uniqu": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "kei": [4, 5, 6, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 25, 28, 29], "descript": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "exec_id": 4, "success": [4, 6, 9, 11, 21], "sampl": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47": 4, "rc": 4, "integ": [4, 6, 9, 18, 21], "code": [4, 6], "0": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "stderr": 4, "standard": 4, "output": [4, 6, 19, 25, 27], "stdout": [4, 25], "takuya": 4, "nishimura": 4, "nishipi": 4, "machin": [5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 23, 24, 25, 26, 28, 29], "all": [5, 6, 9, 10, 16, 17, 18, 19, 20, 21, 22, 28], "elev": [5, 10], "properli": [5, 10], "specif": [5, 6, 10, 11, 17, 20, 21, 25, 28, 29], "web1": 5, "sever": [5, 10, 21], "redi": [5, 6, 10, 11], "alwai": [5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 28, 29], "apparmorprofil": [5, 6], "singl": [5, 6], "child": 5, "kolla_start": 5, "boundingcap": [5, 6], "cap_chown": [5, 6], "cap_dac_overrid": 5, "cap_fsetid": 5, "cap_fown": 5, "cap_mknod": 5, "cap_net_raw": 5, "cap_setgid": 5, "cap_setuid": 5, "cap_setfcap": 5, "cap_setpcap": 5, "cap_net_bind_servic": 5, "cap_sys_chroot": 5, "cap_kil": 5, "cap_audit_writ": 5, "config": [5, 6, 9, 12, 16, 19, 20, 21], "annot": [5, 6, 10, 11, 12, 13], "io": [5, 6, 9, 10, 11, 13, 14, 15, 16, 21, 23, 25, 26, 27], "cri": [5, 6], "o": [5, 6, 10, 11, 12, 13], "containertyp": [5, 6], "sandbox": [5, 6], "autoremov": 5, "init": [5, 6, 21], "publish": [5, 6, 21], "attachstderr": [5, 6], "attachstdin": [5, 6], "attachstdout": [5, 6], "cmd": [5, 6, 10, 11, 12, 13], "domainnam": [5, 6], "entrypoint": [5, 6, 10, 11, 13], "dumb": 5, "usr": [5, 6, 10, 11, 13], "sbin": [5, 6, 10, 11, 13], "term": [5, 6], "xterm": [5, 6], "hostnam": [5, 6, 20, 21], "oci": [5, 6, 11, 12, 13, 24], "kolla_install_metatyp": 5, "rdo": 5, "kolla_base_distro": 5, "cento": 5, "kolla_install_typ": 5, "binari": [5, 6, 22], "kolla_distro_python_vers": 5, "7": [5, 25], "kolla_base_arch": 5, "x86_64": 5, "c5c39e813703": 5, "docker": [5, 6, 9, 10, 11, 13, 14, 16, 19, 23, 24, 25, 26], "tripleomast": 5, "haproxi": 5, "latest": [5, 6, 9, 10, 11, 13, 27], "build": [5, 11, 19], "date": 5, "20190919": 5, "kolla_vers": 5, "org": [5, 29], "schema": 5, "20190801": 5, "licens": 5, "gplv2": 5, "base": [5, 6, 18], "vendor": 5, "onbuild": 5, "null": [5, 6, 12, 21], "openstdin": [5, 6], "stdinonc": [5, 6], "stopsign": [5, 6], "15": [5, 6], "workingdir": [5, 6], "creat": [5, 6, 9, 10, 11, 12, 13, 15, 16, 18, 19, 20, 21, 22, 24, 25, 27], "2019": [5, 6, 11], "01t12": 5, "51": 5, "00": [5, 6, 12, 20, 21, 29], "233106443z": 5, "depend": [5, 6, 9, 21], "driver": [5, 6, 18, 19, 25, 28, 29], "overlai": [5, 6, 10, 11, 12, 13], "effectivecap": [5, 6], "execid": [5, 6], "exitcommand": [5, 6], "var": [5, 6, 10, 11, 13, 19, 27], "lib": [5, 6, 10, 11, 13, 19], "storag": [5, 10, 11, 13, 19, 29], "runroot": 5, "level": [5, 6, 19], "error": [5, 6, 19], "cgroup": [5, 6, 21], "tmpdir": 5, "libpod": 5, "runtim": [5, 6], "runc": 5, "event": 5, "backend": [5, 17, 18], "journald": [5, 6], "cleanup": 5, "c9e813703f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f": 5, "graphdriv": [5, 6, 10, 11, 12, 13], "hostconfig": [5, 6], "bind": [5, 6, 21], "blkiodevicereadbp": 5, "blkiodevicereadiop": 5, "blkiodevicewritebp": 5, "blkiodevicewriteiop": 5, "blkioweight": 5, "blkioweightdevic": 5, "capadd": 5, "capdrop": 5, "cgrouppar": [5, 20, 21], "consoles": 5, "containeridfil": 5, "cpucount": 5, "cpuperc": 5, "cpuperiod": 5, "cpuquota": 5, "cpurealtimeperiod": 5, "cpurealtimeruntim": 5, "cpushar": 5, "cpusetcpu": 5, "cpusetmem": 5, "devic": [5, 6, 18, 21, 29], "diskquota": 5, "dn": [5, 6, 18, 21], "dnsoption": 5, "dnssearch": 5, "extrahost": 5, "groupadd": 5, "iomaximumbandwidth": 5, "iomaximumiop": 5, "ipcmod": 5, "isol": [5, 18], "kernelmemori": 5, "logconfig": 5, "k8": [5, 6, 21], "memori": [5, 6, 21], "memoryreserv": 5, "memoryswap": 5, "memoryswappi": 5, "nanocpu": 5, "networkmod": 5, "oomkilldis": 5, "oomscoreadj": 5, "pidmod": 5, "pidslimit": 5, "portbind": 5, "publishallport": 5, "readonlyrootf": 5, "restartpolici": 5, "maximumretrycount": 5, "securityopt": 5, "shmsize": 5, "65536000": 5, "tmpf": [5, 6, 29], "utsmod": 5, "ulimit": [5, 6], "hard": 5, "1048576": 5, "rlimit_nofil": 5, "soft": [5, 6], "rlimit_nproc": 5, "usernsmod": 5, "volumedriv": 5, "volumesfrom": 5, "hostnamepath": [5, 6], "hostspath": [5, 6], "c5c39f9b80a6ea2ad665aa9946435934e478a0c5322da835f3883872f": 5, "0e267acda67d0ebd643e900d820a91b961d859743039e620191ca1": 5, "imagenam": [5, 6], "isinfra": [5, 6], "mountlabel": [5, 6], "system_u": [5, 6], "object_r": [5, 6], "svirt_sandbox_file_t": 5, "s0": [5, 6], "c78": 5, "c866": 5, "mount": [5, 6, 11, 21, 27], "namespac": [5, 6, 19, 21, 27], "networkset": [5, 6], "bridg": [5, 6, 17, 18, 21], "endpointid": 5, "gatewai": [5, 17, 18], "globalipv6address": 5, "globalipv6prefixlen": 5, "hairpinmod": 5, "ipaddress": 5, "ipprefixlen": 5, "ipv6gatewai": 5, "linklocalipv6address": 5, "linklocalipv6prefixlen": 5, "macaddress": 5, "port": [5, 6, 21], "sandboxid": 5, "sandboxkei": 5, "secondaryipaddress": 5, "secondaryipv6address": 5, "ociruntim": 5, "processlabel": [5, 6], "system_r": [5, 6], "svirt_lxc_net_t": 5, "c785": 5, "resolvconfpath": [5, 6], "restartcount": [5, 6], "rootf": [5, 6, 10, 11, 12, 13], "state": [5, 6, 9, 11, 18, 19, 20, 21, 25, 27, 29], "dead": [5, 6], "exitcod": [5, 6], "finishedat": [5, 6], "0001": 5, "01": 5, "01t00": 5, "00z": 5, "healthcheck": [5, 6], "failingstreak": [5, 6], "statu": [5, 6, 20, 21], "oomkil": [5, 6], "ocivers": [5, 6], "dev": [5, 6, 21, 29], "paus": [5, 6, 21], "pid": [5, 6, 21], "restart": [5, 6, 9, 21], "startedat": [5, 6], "emilien": 5, "macchi": 5, "emilienm": 5, "new": [6, 7, 9, 11, 14, 17, 18, 19, 20, 21, 22, 25, 27, 29], "start": [6, 9, 10, 13, 19, 21], "stop": [6, 9, 18, 21], "format": [6, 11, 18, 21, 24], "multipl": [6, 11, 19, 21], "time": [6, 9, 19, 21], "authfil": [6, 11, 14, 15, 16, 19], "authent": [6, 11, 14, 15, 16, 19], "xdg_runtime_dir": [6, 14, 15, 16, 19], "auth": [6, 11, 14, 15, 16, 19], "json": [6, 11, 12, 14, 15, 16, 19], "Not": [6, 14], "avail": [6, 14, 19], "remot": [6, 11, 14, 19, 27], "can": [6, 7, 9, 14, 15, 16, 18, 19, 21, 22, 27, 29], "also": [6, 11, 14, 15, 16, 19, 22], "registry_auth_fil": [6, 14, 15, 16, 19], "blkio_weight": [6, 21], "block": [6, 18, 21], "weight": [6, 21], "rel": [6, 21], "accept": 6, "between": [6, 9, 18, 21], "1000": [6, 21, 27], "blkio_weight_devic": [6, 21], "device_nam": 6, "cap_add": 6, "alias": [6, 11, 13, 21, 24], "capabl": [6, 17, 18], "cap_drop": 6, "drop": 6, "cgroup_par": [6, 21], "under": [6, 15, 16, 21], "absolut": [6, 21], "consid": [6, 21, 22], "process": [6, 21], "thei": [6, 16, 19, 21, 22], "do": [6, 9, 21], "alreadi": [6, 9, 11, 19, 21, 25], "cgroupn": 6, "determin": 6, "enabl": [6, 9, 18, 19, 21], "disabl": [6, 18, 19, 21], "being": 6, "forc": [6, 8, 9, 11, 18, 21, 24, 25], "thu": 6, "conflict": [6, 21], "parent": [6, 10, 11, 12, 13, 18], "cidfil": 6, "write": [6, 9, 21, 24], "cmd_arg": 6, "itself": 6, "debug": [6, 7, 18, 19, 21, 25, 27, 29], "syslog": 6, "NOT": [6, 25], "pleas": 6, "conmon_pidfil": 6, "conmon": [6, 21], "separ": [6, 9, 11, 21], "so": 6, "necessari": [6, 11, 21], "cpu_period": 6, "limit": [6, 21], "cpu": [6, 11, 21], "cf": 6, "fair": 6, "schedul": 6, "period": 6, "cpu_quota": 6, "quota": 6, "cpu_rt_period": 6, "real": 6, "microsecond": 6, "": [6, 9, 11, 21, 27], "usag": 6, "flag": [6, 15, 16, 21], "tell": 6, "kernel": [6, 21], "restrict": [6, 18], "cpu_rt_runtim": 6, "amount": 6, "consum": 6, "cpu_shar": [6, 21], "share": [6, 21, 28, 29], "number": [6, 21], "mean": [6, 19, 21], "cpuset_cpu": [6, 21], "3": [6, 7, 9, 11, 21, 25], "cpuset_mem": [6, 21], "node": [6, 21], "mem": 6, "onli": [6, 9, 11, 16, 18, 19, 21, 22, 24], "effect": [6, 21], "numa": [6, 21], "system": [6, 9, 21, 22], "inform": [6, 7, 9, 18, 21, 22, 29], "help": [6, 7, 18, 21, 29], "investig": [6, 7, 18, 21, 29], "mode": [6, 9, 18, 19, 21], "detach_kei": 6, "sequenc": 6, "charact": 6, "ctrl": 6, "permiss": [6, 21], "e": [6, 9, 16, 21, 29], "g": [6, 9, 11, 16, 21, 29], "sdc": 6, "xvdc": 6, "rwm": 6, "device_read_bp": [6, 21], "read": [6, 19, 21], "rate": [6, 21], "byte": [6, 21], "per": [6, 9, 21], "second": [6, 9, 21], "bp": [6, 21], "sda": [6, 21], "1mb": [6, 21], "device_read_iop": 6, "iop": 6, "device_write_bp": [6, 21], "device_write_iop": 6, "dns_server": 6, "custom": [6, 21], "server": [6, 14, 15, 16, 21], "dns_option": 6, "dns_opt": [6, 21], "dns_search": [6, 21], "dns_search_domain": 6, "search": [6, 15, 16, 21], "domain": [6, 21], "don": 6, "t": [6, 21], "wish": 6, "overwrit": 6, "arbitrari": 6, "launch": 6, "env_fil": 6, "delimit": [6, 21], "doesn": [6, 21], "idempot": [6, 9, 11, 29], "chang": [6, 12, 16, 29], "them": [6, 9, 21], "recreat": [6, 18, 19, 21, 25, 29], "present": [6, 11, 17, 18, 20, 21, 25, 28, 29], "actual": 6, "control": [6, 11], "copi": [6, 9], "slurp": 6, "env_host": 6, "current": [6, 18, 22, 25], "etc_host": 6, "add_host": [6, 21], "dict": 6, "ip": [6, 18, 21], "map": [6, 21, 27], "ad": 6, "expos": 6, "exposed_port": 6, "rang": [6, 17, 18, 21], "3300": 6, "3310": 6, "redirect": 6, "force_restart": 6, "generate_systemd": [6, 21], "after": [6, 9, 11, 19, 21], "servic": [6, 9, 21], "container_prefix": [6, 9, 21], "prefix": [6, 9, 21], "instead": [6, 9, 21, 24], "expect": [6, 21], "refer": [6, 9, 21], "more": [6, 9, 11, 21, 22, 24, 26], "no_head": [6, 9, 21], "header": [6, 9, 21], "meta": [6, 9, 21], "data": [6, 7, 9, 10, 11, 12, 13, 21, 22, 25], "timestamp": [6, 9, 21], "pod_prefix": [6, 9, 21], "similar": [6, 9, 21], "stronger": [6, 9, 21], "restart_polici": [6, 9, 21], "polici": [6, 9, 21], "one": [6, 11, 19, 21, 24, 26], "failur": [6, 9, 21], "abnorm": [6, 9, 21], "watchdog": [6, 9, 21], "abort": [6, 9, 21], "restart_sec": [6, 9, 21], "restartsec": [6, 21], "dash": [6, 21], "start_timeout": [6, 9, 21], "timeout": [6, 9, 21], "stop_timeout": [6, 9, 21], "weak": [6, 9, 21], "gidmap": [6, 21], "suppli": [6, 21], "group_add": 6, "alter": 6, "healthcheck_failure_act": 6, "action": 6, "taken": 6, "unhealthi": 6, "none": [6, 21], "kill": [6, 21], "healthcheck_interv": 6, "interv": 6, "result": [6, 11, 21, 29], "timer": 6, "setup": 6, "30": 6, "healthcheck_retri": 6, "retri": 6, "befor": [6, 9], "healthcheck_start_period": 6, "initi": 6, "bootstrap": 6, "express": 6, "like": [6, 27], "2m3": 6, "healthcheck_timeout": 6, "maximum": 6, "fail": [6, 16], "1m22": 6, "hooks_dir": 6, "hook": 6, "syntax": 6, "semant": 6, "inject": 6, "5": [6, 24], "http_proxi": 6, "By": [6, 27], "proxi": [6, 11], "https_proxi": 6, "ftp_proxi": 6, "no_proxi": 6, "upper": 6, "case": [6, 16], "those": [6, 18], "tag": [6, 10, 11, 18, 24, 26], "found": [6, 16, 19], "assum": 6, "image_strict": 6, "compar": 6, "take": [6, 9], "account": 6, "full": [6, 9], "image_volum": 6, "how": 6, "handl": 6, "builtin": [6, 9, 27], "ignor": [6, 11, 16], "forward": 6, "signal": 6, "reap": 6, "init_path": 6, "keep": 6, "stdin": 6, "open": 6, "even": [6, 8, 9, 11, 18, 19, 22, 24, 29], "attach": 6, "static": [6, 21], "address": [6, 21], "88": [6, 17, 18], "64": 6, "128": [6, 18], "cni": [6, 17, 18, 19, 21], "join": [6, 18, 19, 21], "were": 6, "anoth": 6, "within": [6, 19], "pool": [6, 10, 11, 13], "16": [6, 11, 17, 18, 21], "ipc": [6, 21], "ipc_mod": 6, "privat": [6, 21], "posix": 6, "sysv": 6, "kernel_memori": 6, "b": [6, 21], "k": [6, 21], "m": [6, 21], "note": [6, 19], "metadata": [6, 21, 29], "label_fil": [6, 21], "log_driv": [6, 19], "log_level": [6, 19], "messag": [6, 12, 19], "abov": [6, 9, 19], "warn": [6, 16, 19], "fatal": [6, 19], "panic": [6, 19], "log_opt": 6, "max_siz": 6, "max": 6, "size": [6, 10, 11, 12, 13, 18], "10mb": 6, "mycontain": 6, "mac_address": [6, 21], "mac": [6, 21], "92": 6, "d0": 6, "c6": 6, "0a": 6, "29": [6, 20], "33": 6, "forget": 6, "ethernet": 6, "10k": 6, "memory_reserv": 6, "100m": 6, "memory_swap": [6, 21], "A": [6, 9, 21, 22], "equal": [6, 21], "plu": [6, 21], "swap": [6, 21], "should": [6, 11, 18, 19], "larger": 6, "doubl": 6, "memory_swappi": 6, "tune": 6, "swappi": 6, "behavior": 6, "100": 6, "filesystem": [6, 8, 12], "destin": [6, 9, 11, 24], "net": [6, 10, 11, 13, 21], "network_mod": 6, "stack": [6, 18], "reus": 6, "defin": [6, 9], "n": 6, "slirp4netn": 6, "rootless": [6, 21], "network_alias": [6, 21], "scope": [6, 21, 28, 29], "alia": [6, 21], "first": [6, 15, 16, 21], "later": 6, "no_host": [6, 21], "oom_kill_dis": 6, "oom": 6, "killer": 6, "oom_score_adj": 6, "prefer": 6, "pid_mod": 6, "pids_limit": 6, "unlimit": 6, "make": 6, "published_port": 6, "hostport": [6, 20], "containerport": [6, 20], "In": 6, "chosen": 6, "randomli": 6, "publish_al": 6, "random": [6, 21], "interfac": [6, 18], "read_onli": 6, "read_only_tmpf": 6, "tmp": 6, "re": [6, 21], "creation": [6, 21], "max_retri": 6, "non": [6, 22], "indefinit": 6, "until": [6, 22], "count": 6, "hit": 6, "regardless": 6, "rm": [6, 9, 11, 27], "auto_remov": 6, "explod": 6, "sdnotifi": 6, "notify_socket": 6, "notifi": 6, "opt": [6, 10, 11, 13, 18, 27], "security_opt": 6, "secur": 6, "seccomp": [6, 19], "unconfin": 6, "shm_size": 6, "shm": 6, "greater": 6, "kilobyt": 6, "megabyt": 6, "gigabyt": 6, "omit": 6, "entir": 6, "64m": 6, "sig_proxi": 6, "sent": 6, "sigchld": 6, "sigstop": 6, "sigkil": 6, "absent": [6, 11, 18, 19, 21, 25, 29], "match": [6, 19], "assert": 6, "provid": [6, 19, 21], "doe": [6, 8, 9, 11, 12, 13, 21, 23, 24, 26, 29], "updat": [6, 18], "cannot": [6, 12, 16], "request": 6, "move": 6, "leav": [6, 19], "stop_sign": 6, "sigterm": 6, "subgidnam": [6, 21], "subgid": [6, 21], "subuidnam": [6, 21], "subuid": [6, 21], "sysctl": 6, "timezon": 6, "area": 6, "gmt": 6, "well": 6, "zoneinfo": 6, "conf": [6, 15, 16, 19, 21], "rw": 6, "787448k": 6, "1777": 6, "uidmap": [6, 21], "usern": [6, 19, 21], "userns_mod": 6, "podman_usern": [6, 19, 21], "empti": [6, 19, 21], "ut": [6, 21], "dir": [6, 11, 24], "volumes_from": 6, "working_dir": 6, "quai": [6, 10, 11, 13, 14, 15, 16], "bitnami": [6, 10, 11, 13], "wildfli": [6, 10, 11, 13], "mydata": 6, "busybox": 6, "myredi": 6, "appendonli": 6, "ye": 6, "6379": 6, "120": 6, "ainer": 6, "myapplic": 6, "other": [6, 16], "127": [6, 21], "xvda": 6, "8080": [6, 10, 11, 13], "9000": 6, "8081": 6, "9001": 6, "udp": 6, "secret_kei": 6, "ssssh": 6, "boolean_kei": 6, "ubuntu": [6, 10, 13], "14": [6, 10, 13, 25], "04": [6, 11], "sleep": [6, 7, 9], "1d": [6, 7], "balanc": [6, 11], "item": [6, 11], "someus": 6, "anotherappimag": 6, "with_sequ": 6, "ohno": 6, "myservic": 6, "complex": 6, "quot": 6, "certbot": 6, "renew": 6, "deploi": 6, "letsencrypt": 6, "repres": 6, "inspect": [6, 11, 17, 20, 21, 28, 29], "regist": [6, 9, 25, 27], "sinc": [6, 16], "compat": 6, "reason": 6, "directli": 6, "12": [6, 20, 21], "librari": [6, 9], "conmonpidfil": 6, "06": [6, 10, 13, 21, 29], "17t19": 6, "13": [6, 10, 11, 13], "09": [6, 10, 11, 12, 13], "873858307": 6, "03": [6, 11, 12, 20, 21, 29], "logpath": 6, "container_file_t": 6, "c282": 6, "c782": 6, "container_t": 6, "157518963": 6, "4083": 6, "152479729": 6, "staticdir": 6, "three": 7, "onc": [7, 9], "alpin": [7, 25, 27], "web": 7, "nginx": [7, 10, 11], "test": [7, 27, 29], "python": 7, "v": 7, "tarbal": [8, 11, 12, 24], "dest": [8, 9, 11, 24], "what": [8, 12, 13, 21, 23, 24, 26, 29], "target": [9, 11, 15, 19], "append": 9, "But": 9, "onlin": 9, "overridden": [9, 15, 16], "man": 9, "page": 9, "wide": 9, "instanc": 9, "replac": 9, "use_nam": 9, "influenc": 9, "indic": [9, 21], "its": [9, 27], "your": [9, 27], "systemctl": 9, "daemon": [9, 11], "reload": 9, "my_contain": 9, "postgr": 9, "ensur": 9, "daemon_reload": 9, "integr": 9, "postgres_loc": 9, "store": [9, 13, 16, 26], "postgres_local_systemd_unit": 9, "postgres_us": 9, "my_app": 9, "postgres_password": 9, "podman_command": 9, "my_webapp": 9, "systemd_unit": 9, "content": [9, 25], "servec": 9, "s\u00e9bastien": 9, "gendr": 9, "cyberfox001": 9, "requir": [10, 11], "architectur": [10, 11, 12, 13], "amd64": [10, 11, 12, 13], "love": [10, 11, 13], "containerconfig": [10, 11, 13], "nami": [10, 11, 13], "foreground": [10, 13], "app": [10, 11, 13], "java": [10, 11, 13], "image_o": [10, 11, 13], "debian": [10, 11, 13], "9": [10, 11, 13, 27], "nami_vers": [10, 11, 13], "gpg_key_servers_list": [10, 11, 13], "ha": [10, 11, 13], "sk": [10, 11, 13], "keyserv": [10, 11, 13], "hkp": [10, 13], "p80": [10, 13], "80": [10, 13, 21], "pgp": [10, 13], "mit": [10, 13], "edu": [10, 13], "tini_vers": [10, 11, 13], "v0": [10, 11, 13], "tini_gpg_kei": [10, 11, 13], "595e85a6b1b4779ea4daaec70b588dff0527a9b7": [10, 11, 13], "gosu_vers": [10, 11, 13], "gosu_gpg_kei": [10, 11, 13], "b42f6819007f00f88e364fd4036a9c25bf357dd4": [10, 11, 13], "bitnami_image_vers": [10, 11, 13], "r12": [10, 13], "bitnami_app_nam": [10, 11, 13], "wildfly_java_hom": [10, 11, 13], "wildfly_java_opt": [10, 11, 13], "wildfly_management_http_port_numb": [10, 11, 13], "9990": [10, 11, 13], "wildfly_password": [10, 11, 13], "wildfly_public_consol": [10, 11, 13], "wildfly_server_ajp_port_numb": [10, 11, 13], "8009": [10, 11, 13], "wildfly_server_http_port_numb": [10, 11, 13], "wildfly_server_interfac": [10, 11, 13], "wildfly_usernam": [10, 11, 13], "wildfly_wildfly_hom": [10, 11, 13], "home": [10, 11, 12, 13, 16, 19, 28, 29], "wildfly_wildfly_opt": [10, 11, 13], "dwildfli": [10, 11, 13], "deploy": [10, 11, 13], "ondemand": [10, 11, 13], "exposedport": [10, 11, 13], "tcp": [10, 11, 13, 20], "maintain": [10, 11, 13], "2018": [10, 13], "25t04": [10, 13], "07": [10, 13, 20], "45": [10, 12, 13], "934395523z": [10, 13], "digest": [10, 11, 12, 13], "sha256": [10, 11, 12, 13], "5c7d8e2dd66dcf4a152a4032a1d3c5a33458c67e1c1335edd8d18d738892356b": [10, 13], "lowerdir": [10, 11, 13], "a9dbf5616cc16919a8ac0dfc60aff87a72b5be52994c4649fcc91a089a12931f": [10, 13], "diff": [10, 11, 12, 13], "67129bd46022122a7d8b7acb490092af6c7ce244ce4fbd7d9e2d2b7f5979e090": [10, 13], "7c51242c4c5db5c74afda76d7fdbeab6965d8b21804bb3fc597dee09c770b0ca": [10, 13], "f97315dc58a9c002ba0cabccb9933d4b0d2113733d204188c88d72f75569b57b": [10, 13], "1dbde2dd497ddde2b467727125b900958a051a72561e58d29abe3d660dcaa9a7": [10, 13], "4aad9d80f30c3f0608f58173558b7554d84dee4dc4479672926eca29f75e6e33": [10, 13], "6751fc9b6868254870c062d75a511543fc8cfda2ce6262f4945f107449219632": [10, 13], "a27034d79081347421dd24d7e9e776c18271cd9a6e51053cb39af4d3d9c400e8": [10, 13], "537cf0045ed9cd7989f7944e7393019c81b16c1799a2198d8348cd182665397f": [10, 13], "27578615c5ae352af4e8449862d61aaf5c11b105a7d5905af55bd01b0c656d6": [10, 13], "566542742840fe3034b3596f7cb9e62a6274c95a69f368f9e713746f8712c0b6": [10, 13], "mergeddir": [10, 11, 13], "72bb96d6c53ad57a0b1e44cab226a6251598accbead40b23fac89c19ad8c25ca": [10, 13], "merg": [10, 11, 13], "upperdir": [10, 11, 12, 13], "bcacbdf7a119c0fa934661ca8af839e625ce6540d9ceb6827cdd389f823d49e0": [10, 13], "manifesttyp": [10, 11, 12, 13], "applic": [10, 11, 12, 13], "vnd": [10, 11, 12, 13], "distribut": [10, 11, 13], "manifest": [10, 11, 12, 13, 24], "v1": [10, 11, 12, 13, 21], "prettyjw": [10, 11, 13], "linux": [10, 11, 12, 13], "repodigest": [10, 11, 12, 13], "repotag": [10, 11, 12, 13], "layer": [10, 11, 12, 13, 24], "75391df2c87e076b0c2f72d20c95c57dc8be7ee684cc07273416cce622b43367": [10, 13], "7dd303f041039bfe8f0833092673ac35f93137d10e0fbc4302021ea65ad57731": [10, 13], "720d9edf0cd2a9bb56b88b80be9070dbfaad359514c70094c65066963fed485d": [10, 13], "6a567ecbf97725501a634fcb486271999aa4591b633b4ae9932a46b40f5aaf47": [10, 13], "59e9a6db8f178f3da868614564faabb2820cdfb69be32e63a4405d6f7772f68c": [10, 13], "310a82ccb092cd650215ab375da8943d235a263af9a029b8ac26a281446c04db": [10, 13], "36cb91cf4513543a8f0953fed785747ea18b675bc2677f3839889cfca0aac79": [10, 13], "569919342": [10, 13], "17": [10, 13], "ce": [10, 13], "virtuals": [10, 11, 12, 13], "sam": [10, 11], "doran": [10, 11], "samdoran": [10, 11], "push": [11, 24], "arch": 11, "auth_fil": 11, "credenti": [11, 16], "build_arg": 11, "buildarg": 11, "pair": [11, 12], "cach": [11, 16], "extra_arg": 11, "containerfil": 11, "context": [11, 19], "force_rm": 11, "intermedi": 11, "unsuccess": 11, "built": [11, 21], "stage": 11, "ca_cert_dir": 11, "tl": [11, 15, 19], "certif": [11, 15, 19], "delet": [11, 16, 19, 22], "push_arg": 11, "compress": [11, 24], "transport": [11, 24], "url": 11, "v2s1": 11, "v2s2": [11, 24], "remove_signatur": 11, "discard": 11, "pre": 11, "signatur": 11, "sign_bi": 11, "sign": 11, "attempt": 11, "archiv": [11, 13, 24], "ostre": 11, "validate_cert": 11, "tlsverifi": [11, 15], "tls_verifi": [11, 19], "http": [11, 15, 19, 27], "dure": 11, "0e901e68141f": 11, "basic": 11, "advanc": 11, "function": 11, "my": [11, 25], "cool": 11, "acm": 11, "bug": 11, "vault_registry_password": 11, "loop": 11, "wa": 11, "r27": 11, "bitnami_pkg_chmod": 11, "r": [11, 21], "rwx": 11, "bitnami_pkg_extra_dir": 11, "nami_prefix": 11, "wildfly_hom": 11, "1001": 11, "10t05": 11, "48": 11, "553887623z": 11, "5a8ab28e314c2222de3feaf6dac94a0436a37fc08979d2722c99d2bef2619a9b": 11, "142c1beadf1bb09fbd929465ec98c9dca3256638220450efb4214727d0d0680": 11, "9aa10191f5bddb59e28508e721fdeb43505e5b395845fa99723ed787878dbfea": 11, "histori": [11, 12], "09t22": 11, "27": 11, "40": 11, "659377677z": 11, "38": [11, 12, 29], "53": 11, "86336555z": 11, "created_bi": [11, 12], "nop": [11, 12], "empty_lay": 11, "54": 11, "022778765z": 11, "ace34da54e4af2145e1ad277005adb235a214e4dfe1114c2db9ab460b840f785": 11, "466180019": 11, "18": 11, "gz": 12, "tgz": 12, "bzip": 12, "xz": 12, "txz": 12, "commit_messag": 12, "commit": 12, "src": 12, "bash": 12, "myvolum": 12, "2021": 12, "07t04": 12, "749977105": 12, "8730c75be86a718929a658db4663d487e562d66762": 12, "34": 12, "091": 12, "cbc6d73c4d232db6e8441df96af81855f62c74157b5db80a1d5": 12, "nameshistori": 12, "5882449": 12, "either": [13, 24], "input": 13, "hub": 14, "logged_in": 14, "clelang": [14, 15, 16], "clemen": [14, 15, 16], "lang": [14, 15, 16], "certdir": 15, "crt": [15, 19], "cert": [15, 19], "d": [15, 19], "verifi": [15, 19], "contact": [15, 19], "explicitli": [15, 16, 19], "verif": [15, 19], "unless": [15, 16, 19], "insecur": [15, 19], "p4ssw0rd": 15, "jason": 15, "hiatt": 15, "jthiatt": 15, "michael": 15, "fox": 15, "spmfox": 15, "logout": 16, "howev": 16, "ignore_docker_credenti": 16, "correspond": 16, "kept": 16, "togeth": 16, "cnivers": [17, 18], "podman0": [17, 18], "ipmasq": [17, 18], "ipam": [17, 18], "subnet": [17, 18], "rout": [17, 18], "dst": [17, 18], "isgatewai": [17, 18], "portmap": [17, 18], "iptabl": [17, 18], "firewal": [17, 18], "disable_dn": 18, "ipv4": 18, "ipv6": 18, "intern": 18, "extern": [18, 22], "ip_rang": 18, "dual": 18, "macvlan": 18, "vlan": 18, "mtu": 18, "traffic": 18, "metric": 18, "everi": 18, "netavark": 18, "vlan_filt": 18, "cidr": 18, "podman_intern": 18, "192": 18, "168": 18, "22": 18, "25": 18, "24": [18, 22], "structur": 19, "describ": [19, 21], "subdirectori": 19, "cert_dir": 19, "client": 19, "configmap": 19, "context_dir": 19, "kube_fil": 19, "call": 19, "quiet": 19, "hide": 19, "seccomp_profile_root": 19, "profil": 19, "kubelet": 19, "kube": 19, "special_pod": 20, "libpod_par": [20, 21], "2020": [20, 21, 29], "13t20": 20, "572282186": 20, "pod1host": 20, "d9cb6dbb0": 20, "infraconfig": [20, 21], "infraportbind": [20, 21], "7111": 20, "hostip": 20, "7777": 20, "protocol": 20, "makeinfracontain": [20, 21], "lockid": [20, 21], "682": 20, "pod1": [20, 21], "sharescgroup": [20, 21], "sharesipc": [20, 21], "sharesnet": [20, 21], "sharesut": [20, 21], "ad46737bf": 20, "cgrouppath": [20, 21], "infracontainerid": [20, 21], "he": 21, "total": [21, 22], "deleg": 21, "000": 21, "comput": 21, "power": 21, "unlik": 21, "pars": 21, "combin": 21, "w": 21, "mknod": 21, "resolv": 21, "special": 21, "infra": 21, "associ": 21, "lightweight": 21, "coordin": 21, "infra_command": 21, "infra_conmon_pidfil": 21, "As": 21, "infra_imag": 21, "gcr": 21, "infra_nam": 21, "kibibyt": 21, "mebibyt": 21, "gibibyt": 21, "assign": 21, "network_alia": 21, "pod_id_fil": 21, "comma": 21, "choos": 21, "unpaus": 21, "wai": 21, "differ": [21, 27], "4444": 21, "5555": 21, "localhost": 21, "pod2": 21, "14t15": 21, "230818767": 21, "newpod": 21, "a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58": 21, "515": 21, "dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2": 21, "container_filt": 22, "filter": 22, "select": [22, 23], "24h": 22, "possibl": 22, "image_filt": 22, "dangling_onli": 22, "dangl": 22, "network_filt": 22, "unus": 22, "system_al": 22, "system_volum": 22, "volume_filt": 22, "older": 22, "containers_filt": 22, "hour": 22, "ago": 22, "everyth": 22, "reclaim": 22, "space": 22, "roberto": 22, "alfieri": 22, "rebtoor": 22, "runlabel": 23, "get": 23, "continuumio": [23, 26], "miniconda3": [23, 26], "pavel": 23, "dostal": 23, "pdostal": 23, "same": [24, 25], "uncompress": 24, "multi_image_arch": 24, "interpret": 24, "unencrypt": 25, "driver_opt": 25, "skip_exist": 25, "remain": 25, "mysecret": 25, "super": 25, "showmysecret": 25, "msg": 25, "aliaksandr": 25, "mianzhynski": 25, "amenzhinski": 25, "target_nam": 26, "miniconda": 26, "christian": 26, "bourqu": 26, "ocafebab": 26, "offici": 27, "doc": 27, "en": 27, "markdown": 27, "html": 27, "become_ex": 27, "privilege_escal": 27, "sudo_become_plugin": 27, "ansible_become_ex": 27, "become_pass": 27, "ansible_become_password": 27, "become_us": 27, "ansible_become_us": 27, "foo": 27, "stat": 27, "test_dir": 27, "show": 27, "own": 27, "ok": 27, "test_host": 27, "1003": 27, "unprivileg": 27, "modifi": 27, "owner": 27, "chmod_foo": 27, "z": 27, "chown": 27, "now": 27, "someth": 27, "completali": 27, "situat": 27, "unaccess": 27, "again": 27, "328679": 27, "become_method": 27, "podman_ushar": 27, "we": 27, "reset": 27, "ownership": 27, "our": 27, "jano": 27, "gerzson": 27, "grz": 27, "specific_volum": 28, "mountpoint": [28, 29], "testvolum": 28, "_data": [28, 29], "tpmf": 29, "due": 29, "volume1": 29, "key2": 29, "value2": 29, "loop1": 29, "ext4": 29, "createdat": 29, "05t16": 29, "55": 29, "277628769": 29, "11": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29]}, "objects": {"": [[1, 0, 1, "-", "ANSIBLE_BECOME_PASS"], [1, 0, 1, "-", "ANSIBLE_PODMAN_EXECUTABLE"], [1, 0, 1, "-", "ANSIBLE_PODMAN_EXTRA_ARGS"], [1, 0, 1, "-", "ANSIBLE_SUDO_EXE"], [1, 0, 1, "-", "ANSIBLE_SUDO_PASS"], [1, 0, 1, "-", "ANSIBLE_SUDO_USER"]]}, "objtypes": {"0": "std:envvar"}, "objnames": {"0": ["std", "envvar", "environment variable"]}, "titleterms": {"contain": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "podman": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "buildah": 0, "connect": [0, 2, 3], "interact": [0, 3], "an": [0, 3, 26], "exist": [0, 3], "synopsi": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "paramet": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "author": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "collect": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "link": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "index": [1, 2], "all": 1, "environ": 1, "variabl": 1, "descript": 2, "plugin": 2, "modul": [2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "becom": [2, 27], "podman_container_exec": 4, "execut": 4, "command": 4, "run": [4, 23, 27], "requir": [4, 5, 6, 7, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29], "note": [4, 5, 9, 10], "exampl": [4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "return": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "valu": [4, 5, 6, 9, 10, 11, 12, 13, 14, 17, 18, 20, 21, 22, 28, 29], "podman_container_info": 5, "gather": [5, 10, 17, 20, 28], "fact": 5, "about": [5, 10, 17, 20, 28], "us": [5, 10, 11, 15, 16, 19, 27], "podman_contain": [6, 7], "manag": [6, 7, 18, 21, 25, 29], "batch": 7, "podman_export": 8, "export": 8, "podman_generate_systemd": 9, "gener": 9, "systemd": 9, "unit": 9, "from": [9, 12, 13, 23], "pod": [9, 20, 21], "podman_image_info": 10, "info": [10, 17, 20, 28], "imag": [10, 11, 13, 23, 24, 26], "podman_imag": 11, "pull": 11, "podman_import": 12, "import": 12, "tar": [12, 13, 24], "file": [12, 13, 19, 24], "podman_load": 13, "load": 13, "podman_login_info": 14, "log": [14, 16], "user": 14, "ani": 14, "given": [14, 23], "registri": [14, 15, 16], "podman_login": 15, "login": 15, "podman_logout": 16, "out": 16, "podman_network_info": 17, "network": [17, 18], "podman_network": 18, "podman_plai": 19, "plai": 19, "kubernet": 19, "yaml": 19, "podman_pod_info": 20, "podman_pod": 21, "podman_prun": 22, "allow": 22, "prune": 22, "variou": 22, "object": 22, "podman_runlabel": 23, "label": 23, "podman_sav": 24, "save": 24, "podman_secret": 25, "secret": 25, "podman_tag": 26, "add": 26, "addit": 26, "name": 26, "local": 26, "podman_unshar": 27, "task": 27, "unshar": 27, "podman_volume_info": 28, "volum": [28, 29], "podman_volum": 29}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"containers.podman.buildah connection \u2013 Interact with an existing buildah container": [[0, "containers-podman-buildah-connection-interact-with-an-existing-buildah-container"]], "Synopsis": [[0, "synopsis"], [3, "synopsis"], [4, "synopsis"], [5, "synopsis"], [6, "synopsis"], [7, "synopsis"], [8, "synopsis"], [9, "synopsis"], [10, "synopsis"], [11, "synopsis"], [12, "synopsis"], [13, "synopsis"], [14, "synopsis"], [15, "synopsis"], [16, "synopsis"], [17, "synopsis"], [18, "synopsis"], [19, "synopsis"], [20, "synopsis"], [21, "synopsis"], [22, "synopsis"], [23, "synopsis"], [24, "synopsis"], [25, "synopsis"], [26, "synopsis"], [27, "synopsis"], [28, "synopsis"], [29, "synopsis"]], "Parameters": [[0, "parameters"], [3, "parameters"], [4, "parameters"], [5, "parameters"], [6, "parameters"], [7, "parameters"], [8, "parameters"], [9, "parameters"], [10, "parameters"], [11, "parameters"], [12, "parameters"], [13, "parameters"], [14, "parameters"], [15, "parameters"], [16, "parameters"], [17, "parameters"], [18, "parameters"], [19, "parameters"], [20, "parameters"], [21, "parameters"], [22, "parameters"], [23, "parameters"], [24, "parameters"], [25, "parameters"], [26, "parameters"], [27, "parameters"], [28, "parameters"], [29, "parameters"]], "Authors": [[0, "authors"], [3, "authors"], [4, "authors"], [5, "authors"], [6, "authors"], [7, "authors"], [8, "authors"], [9, "authors"], [10, "authors"], [11, "authors"], [12, "authors"], [13, "authors"], [14, "authors"], [15, "authors"], [16, "authors"], [17, "authors"], [18, "authors"], [19, "authors"], [20, "authors"], [21, "authors"], [22, "authors"], [23, "authors"], [24, "authors"], [25, "authors"], [26, "authors"], [27, "authors"], [28, "authors"], [29, "authors"]], "Collection links": [[0, "collection-links"], [3, "collection-links"], [4, "collection-links"], [5, "collection-links"], [6, "collection-links"], [7, "collection-links"], [8, "collection-links"], [9, "collection-links"], [10, "collection-links"], [11, "collection-links"], [12, "collection-links"], [13, "collection-links"], [14, "collection-links"], [15, "collection-links"], [16, "collection-links"], [17, "collection-links"], [18, "collection-links"], [19, "collection-links"], [20, "collection-links"], [21, "collection-links"], [22, "collection-links"], [23, "collection-links"], [24, "collection-links"], [25, "collection-links"], [26, "collection-links"], [27, "collection-links"], [28, "collection-links"], [29, "collection-links"]], "Index of all Collection Environment Variables": [[1, "index-of-all-collection-environment-variables"]], "Containers.Podman": [[2, "containers-podman"]], "Description": [[2, "description"]], "Plugin Index": [[2, "plugin-index"]], "Modules": [[2, "modules"]], "Become Plugins": [[2, "become-plugins"]], "Connection Plugins": [[2, "connection-plugins"]], "containers.podman.podman connection \u2013 Interact with an existing podman container": [[3, "containers-podman-podman-connection-interact-with-an-existing-podman-container"]], "containers.podman.podman_container_exec module \u2013 Executes a command in a running container.": [[4, "containers-podman-podman-container-exec-module-executes-a-command-in-a-running-container"]], "Requirements": [[4, "requirements"], [5, "requirements"], [6, "requirements"], [7, "requirements"], [8, "requirements"], [9, "requirements"], [12, "requirements"], [13, "requirements"], [14, "requirements"], [15, "requirements"], [16, "requirements"], [17, "requirements"], [18, "requirements"], [19, "requirements"], [20, "requirements"], [21, "requirements"], [22, "requirements"], [23, "requirements"], [24, "requirements"], [25, "requirements"], [26, "requirements"], [28, "requirements"], [29, "requirements"]], "Notes": [[4, "notes"], [5, "notes"], [9, "notes"], [10, "notes"]], "Examples": [[4, "examples"], [5, "examples"], [6, "examples"], [7, "examples"], [8, "examples"], [9, "examples"], [10, "examples"], [11, "examples"], [12, "examples"], [13, "examples"], [14, "examples"], [15, "examples"], [16, "examples"], [17, "examples"], [18, "examples"], [19, "examples"], [20, "examples"], [21, "examples"], [22, "examples"], [23, "examples"], [24, "examples"], [25, "examples"], [26, "examples"], [27, "examples"], [28, "examples"], [29, "examples"]], "Return Values": [[4, "return-values"], [5, "return-values"], [6, "return-values"], [9, "return-values"], [10, "return-values"], [11, "return-values"], [12, "return-values"], [13, "return-values"], [14, "return-values"], [17, "return-values"], [18, "return-values"], [20, "return-values"], [21, "return-values"], [22, "return-values"], [28, "return-values"], [29, "return-values"]], "containers.podman.podman_container_info module \u2013 Gather facts about containers using podman": [[5, "containers-podman-podman-container-info-module-gather-facts-about-containers-using-podman"]], "containers.podman.podman_container module \u2013 Manage podman containers": [[6, "containers-podman-podman-container-module-manage-podman-containers"]], "containers.podman.podman_containers module \u2013 Manage podman containers in a batch": [[7, "containers-podman-podman-containers-module-manage-podman-containers-in-a-batch"]], "containers.podman.podman_export module \u2013 Export a podman container": [[8, "containers-podman-podman-export-module-export-a-podman-container"]], "containers.podman.podman_generate_systemd module \u2013 Generate systemd unit from a pod or a container": [[9, "containers-podman-podman-generate-systemd-module-generate-systemd-unit-from-a-pod-or-a-container"]], "containers.podman.podman_image_info module \u2013 Gather info about images using podman": [[10, "containers-podman-podman-image-info-module-gather-info-about-images-using-podman"]], "containers.podman.podman_image module \u2013 Pull images for use by podman": [[11, "containers-podman-podman-image-module-pull-images-for-use-by-podman"]], "containers.podman.podman_import module \u2013 Import Podman container from a tar file.": [[12, "containers-podman-podman-import-module-import-podman-container-from-a-tar-file"]], "containers.podman.podman_load module \u2013 Load image from a tar file.": [[13, "containers-podman-podman-load-module-load-image-from-a-tar-file"]], "containers.podman.podman_login_info module \u2013 Return the logged-in user if any for a given registry": [[14, "containers-podman-podman-login-info-module-return-the-logged-in-user-if-any-for-a-given-registry"]], "containers.podman.podman_login module \u2013 Login to a container registry using podman": [[15, "containers-podman-podman-login-module-login-to-a-container-registry-using-podman"]], "containers.podman.podman_logout module \u2013 Log out of a container registry using podman": [[16, "containers-podman-podman-logout-module-log-out-of-a-container-registry-using-podman"]], "containers.podman.podman_network_info module \u2013 Gather info about podman networks": [[17, "containers-podman-podman-network-info-module-gather-info-about-podman-networks"]], "containers.podman.podman_network module \u2013 Manage podman networks": [[18, "containers-podman-podman-network-module-manage-podman-networks"]], "containers.podman.podman_play module \u2013 Play kubernetes YAML file using podman": [[19, "containers-podman-podman-play-module-play-kubernetes-yaml-file-using-podman"]], "containers.podman.podman_pod_info module \u2013 Gather info about podman pods": [[20, "containers-podman-podman-pod-info-module-gather-info-about-podman-pods"]], "containers.podman.podman_pod module \u2013 Manage Podman pods": [[21, "containers-podman-podman-pod-module-manage-podman-pods"]], "containers.podman.podman_prune module \u2013 Allows to prune various podman objects": [[22, "containers-podman-podman-prune-module-allows-to-prune-various-podman-objects"]], "containers.podman.podman_runlabel module \u2013 Run given label from given image": [[23, "containers-podman-podman-runlabel-module-run-given-label-from-given-image"]], "containers.podman.podman_save module \u2013 Saves podman image to tar file": [[24, "containers-podman-podman-save-module-saves-podman-image-to-tar-file"]], "containers.podman.podman_secret module \u2013 Manage podman secrets": [[25, "containers-podman-podman-secret-module-manage-podman-secrets"]], "containers.podman.podman_tag module \u2013 Add an additional name to a local image": [[26, "containers-podman-podman-tag-module-add-an-additional-name-to-a-local-image"]], "containers.podman.podman_unshare become \u2013 Run tasks using podman unshare": [[27, "containers-podman-podman-unshare-become-run-tasks-using-podman-unshare"]], "containers.podman.podman_volume_info module \u2013 Gather info about podman volumes": [[28, "containers-podman-podman-volume-info-module-gather-info-about-podman-volumes"]], "containers.podman.podman_volume module \u2013 Manage Podman volumes": [[29, "containers-podman-podman-volume-module-manage-podman-volumes"]]}, "indexentries": {"ansible_remote_user": [[0, "index-0"], [3, "index-2"]], "environment variable": [[0, "index-0"], [1, "envvar-ANSIBLE_BECOME_PASS"], [1, "envvar-ANSIBLE_PODMAN_EXECUTABLE"], [1, "envvar-ANSIBLE_PODMAN_EXTRA_ARGS"], [1, "envvar-ANSIBLE_SUDO_EXE"], [1, "envvar-ANSIBLE_SUDO_PASS"], [1, "envvar-ANSIBLE_SUDO_USER"], [3, "index-0"], [3, "index-1"], [3, "index-2"], [27, "index-0"], [27, "index-1"], [27, "index-2"], [27, "index-3"], [27, "index-4"], [27, "index-5"]], "ansible_become_pass": [[1, "envvar-ANSIBLE_BECOME_PASS"], [27, "index-2"]], "ansible_podman_executable": [[1, "envvar-ANSIBLE_PODMAN_EXECUTABLE"], [3, "index-0"]], "ansible_podman_extra_args": [[1, "envvar-ANSIBLE_PODMAN_EXTRA_ARGS"], [3, "index-1"]], "ansible_sudo_exe": [[1, "envvar-ANSIBLE_SUDO_EXE"], [27, "index-1"]], "ansible_sudo_pass": [[1, "envvar-ANSIBLE_SUDO_PASS"], [27, "index-3"]], "ansible_sudo_user": [[1, "envvar-ANSIBLE_SUDO_USER"], [27, "index-5"]], "ansible_become_exe": [[27, "index-0"]], "ansible_become_user": [[27, "index-4"]]}}) \ No newline at end of file diff --git a/galaxy.yml b/galaxy.yml index 79eb607c..feb817d2 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: containers name: podman -version: 1.10.3 +version: 1.11.0 readme: README.md authors: - Sagi Shnaidman