mirror of
https://github.com/containers/ansible-podman-collections.git
synced 2026-02-04 07:11:49 +00:00
Add inventory plugins for buildah and podman (#963)
Add inventory plugins for buildah and podman, unit tests and functional CI tests. --------- Signed-off-by: Sagi Shnaidman <sshnaidm@redhat.com>
This commit is contained in:
Sergey
GitHub
parent
fb76891c50
commit
6ee2f3891b
57 changed files with 3856 additions and 8899 deletions
358
.github/workflows/test-inventory-examples.yml
vendored
Normal file
358
.github/workflows/test-inventory-examples.yml
vendored
Normal file
|
|
@ -0,0 +1,358 @@
|
|||
name: Test inventory and example playbooks
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '.github/workflows/test-inventory-examples.yml'
|
||||
- 'plugins/inventory/podman_containers.py'
|
||||
- 'plugins/inventory/buildah_containers.py'
|
||||
- 'tests/unit/plugins/inventory/*.py'
|
||||
push:
|
||||
paths:
|
||||
- '.github/workflows/test-inventory-examples.yml'
|
||||
- 'plugins/inventory/podman_containers.py'
|
||||
- 'plugins/inventory/buildah_containers.py'
|
||||
- 'tests/unit/plugins/inventory/*.py'
|
||||
branches: [ main ]
|
||||
schedule:
|
||||
- cron: 4 0 * * * # Run daily at 0:03 UTC
|
||||
|
||||
jobs:
|
||||
inventory_test:
|
||||
name: Functional inventory tests
|
||||
runs-on: ubuntu-24.04
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install Ansible 2.18
|
||||
run: python3 -m pip install --user --force-reinstall --upgrade ansible-core==2.18
|
||||
|
||||
- name: Build and install the collection tarball
|
||||
run: |
|
||||
rm -rf /tmp/just_new_collection
|
||||
~/.local/bin/ansible-galaxy collection build --output-path /tmp/just_new_collection --force
|
||||
~/.local/bin/ansible-galaxy collection install -vvv --force /tmp/just_new_collection/*.tar.gz
|
||||
|
||||
- name: Install system deps (podman, buildah)
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y podman buildah jq
|
||||
podman --version
|
||||
buildah --version
|
||||
|
||||
- name: Configure rootless storage
|
||||
run: |
|
||||
mkdir -p ~/.config/containers
|
||||
printf '[storage]\ndriver = "overlay"\n' > ~/.config/containers/storage.conf
|
||||
printf '[engine]\ncgroup_manager = "cgroupfs"\nevents_logger = "file"\n' > ~/.config/containers/engine.conf
|
||||
|
||||
- name: Install Ansible
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install ansible-core
|
||||
ansible --version
|
||||
|
||||
- name: Build basic containers for discovery
|
||||
run: |
|
||||
podman pull alpine:latest
|
||||
podman run -d --name podman-inventory-test alpine:latest sleep 3600
|
||||
podman run -d --name podman-inventory-test2 --label role=api --label env=dev alpine:latest sleep 3600
|
||||
podman run -d --name podman-stopped-test alpine:latest sleep 3600 && podman stop podman-stopped-test
|
||||
buildah from --name hello-buildah alpine:latest
|
||||
echo 'Podman ps output:'
|
||||
podman ps -a --format json | jq '.'
|
||||
echo 'Buildah containers output:'
|
||||
buildah containers -a --json | jq '.'
|
||||
|
||||
- name: Write podman inventory source
|
||||
run: |
|
||||
mkdir -p ci/tmpinv
|
||||
cat > ci/tmpinv/podman.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: false
|
||||
connection_plugin: containers.podman.podman
|
||||
EOF
|
||||
|
||||
- name: Write buildah inventory source
|
||||
run: |
|
||||
cat > ci/tmpinv/buildah.yml <<'EOF'
|
||||
plugin: containers.podman.buildah_containers
|
||||
connection_plugin: containers.podman.buildah
|
||||
EOF
|
||||
|
||||
- name: Sanity check podman inventory
|
||||
run: |
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
echo "$out" | jq -e '. | to_entries | any(.value.hosts != null and (.value.hosts | length) > 0)'
|
||||
|
||||
- name: Test podman inventory - empty selection with name_patterns
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_empty.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
name_patterns: ['no-such-*']
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_empty.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Expect no groups with hosts
|
||||
test $(echo "$out" | jq '[ . | to_entries[] | select(.value.hosts != null and (.value.hosts | length) > 0) ] | length') -eq 0
|
||||
|
||||
- name: Test podman include_stopped false excludes stopped
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_running.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: false
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_running.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Stopped host must not be present in hostvars
|
||||
echo "$out" | jq -e '._meta.hostvars | has("podman-stopped-test") | not'
|
||||
|
||||
- name: Test podman include_stopped true includes stopped
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_all.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: true
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_all.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Stopped host must be present in hostvars
|
||||
echo "$out" | jq -e '._meta.hostvars | has("podman-stopped-test")'
|
||||
|
||||
- name: Test label_selectors and group_by_image/label
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_labels.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
label_selectors:
|
||||
role: api
|
||||
group_by_image: true
|
||||
group_by_label: ['env']
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_labels.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Only labeled host present
|
||||
echo "$out" | jq -e '._meta.hostvars | has("podman-inventory-test2")'
|
||||
echo "$out" | jq -e '._meta.hostvars | has("podman-inventory-test") | not'
|
||||
# Image group exists
|
||||
echo "$out" | jq -e '."image_docker.io_library_alpine_latest".hosts | index("podman-inventory-test2") != null'
|
||||
# Label group exists
|
||||
echo "$out" | jq -e '."label_env_dev".hosts | index("podman-inventory-test2") != null'
|
||||
|
||||
- name: Test verbose_output and filters include/exclude
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_filters.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: true
|
||||
verbose_output: true
|
||||
filters:
|
||||
exclude:
|
||||
status: 'Exited*'
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_filters.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Exited (stopped) should be excluded
|
||||
echo "$out" | jq -e '._meta.hostvars | has("podman-stopped-test") | not'
|
||||
# podman_ps should exist for a running host
|
||||
echo "$out" | jq -e '._meta.hostvars["podman-inventory-test"] | has("podman_ps")'
|
||||
|
||||
- name: Test keyed_groups with prefix/separator/default and parent_group
|
||||
run: |
|
||||
cat > ci/tmpinv/podman_keyed.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
keyed_groups:
|
||||
- key: labels.role
|
||||
prefix: k
|
||||
separator: '-'
|
||||
parent_group: keyed
|
||||
- key: labels.missing
|
||||
prefix: missing
|
||||
default_value: unknown
|
||||
leading_separator: false
|
||||
trailing_separator: false
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_keyed.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Group from labels.role
|
||||
echo "$out" | jq -e '."k_api".hosts | index("podman-inventory-test2") != null'
|
||||
# Parent group exists and contains subgroup
|
||||
echo "$out" | jq -e '((.keyed.children | type) == "array" and (.keyed.children | index("k_api") != null)) or ((.keyed.children | type) == "object" and (.keyed.children | has("k_api")))'
|
||||
# Default value group for missing key exists for at least one host
|
||||
test $(echo "$out" | jq 'to_entries | map(select(.key | startswith("missing"))) | length') -ge 1
|
||||
|
||||
- name: Verbose logs - podman inventory (-vvvv) name_patterns and label_selectors
|
||||
run: |
|
||||
# Create an inventory that will: match only podman-inventory-test (not test2) by name_patterns,
|
||||
# then filter it out by label_selectors; the unmatched one will be filtered by name_patterns.
|
||||
cat > ci/tmpinv/podman_verbose.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: true
|
||||
name_patterns: ['podman-inventory-test']
|
||||
label_selectors:
|
||||
role: api
|
||||
EOF
|
||||
set -o pipefail
|
||||
ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini \
|
||||
ansible-inventory -i ci/tmpinv/podman_verbose.yml --list -vvvv 1>/tmp/podman_verbose.out 2>/tmp/podman_verbose.err || true
|
||||
echo "podman_verbose.err:"
|
||||
cat /tmp/podman_verbose.err
|
||||
echo "podman_verbose.out:"
|
||||
cat /tmp/podman_verbose.out
|
||||
# Expect messages from plugin
|
||||
grep -q "Filtered out podman-inventory-test2 by name_patterns option" /tmp/podman_verbose.out
|
||||
grep -q "Filtered out podman-inventory-test by label_selectors option" /tmp/podman_verbose.out
|
||||
|
||||
- name: Verbose logs - podman inventory (-vvvv) filters include path
|
||||
run: |
|
||||
# Match only the labeled container and then filter it via filters.include
|
||||
cat > ci/tmpinv/podman_verbose_filters.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: true
|
||||
name_patterns: ['podman-inventory-test2']
|
||||
filters:
|
||||
include:
|
||||
status: 'Exited*'
|
||||
EOF
|
||||
set -o pipefail
|
||||
ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini \
|
||||
ansible-inventory -i ci/tmpinv/podman_verbose_filters.yml --list -vvvv 1>/tmp/podman_verbose2.out 2>/tmp/podman_verbose2.err || true
|
||||
echo "podman_verbose2.err:"
|
||||
cat /tmp/podman_verbose2.err
|
||||
echo "podman_verbose2.out:"
|
||||
cat /tmp/podman_verbose2.out
|
||||
grep -q "Filtered out podman-inventory-test2 by filters option" /tmp/podman_verbose2.out
|
||||
|
||||
- name: Test strict=true fails on missing keyed key
|
||||
run: |
|
||||
set +e
|
||||
cat > ci/tmpinv/podman_strict.yml <<'EOF'
|
||||
plugin: containers.podman.podman_containers
|
||||
strict: true
|
||||
keyed_groups:
|
||||
- key: labels.nonexistent
|
||||
EOF
|
||||
ANSIBLE_INVENTORY_ENABLED=containers.podman.podman_containers,yaml,ini ansible-inventory -i ci/tmpinv/podman_strict.yml --list >/tmp/out.json 2>/tmp/err.log
|
||||
rc=$?
|
||||
echo "RC=$rc"; cat /tmp/err.log || true
|
||||
# Some ansible-core versions still exit 0 after parser fallbacks; assert on error message instead
|
||||
grep -q "Missing keyed_groups key 'labels.nonexistent'" /tmp/err.log
|
||||
|
||||
- name: Sanity check buildah inventory
|
||||
run: |
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.buildah_containers,yaml,ini ansible-inventory -i ci/tmpinv/buildah.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
echo "$out" | jq -e '. | to_entries | any(.value.hosts != null and (.value.hosts | length) > 0)'
|
||||
|
||||
- name: Verbose logs - buildah inventory (-vvvv) name_patterns filter path
|
||||
run: |
|
||||
cat > ci/tmpinv/buildah_verbose.yml <<'EOF'
|
||||
plugin: containers.podman.buildah_containers
|
||||
name_patterns: ['no-such-*']
|
||||
EOF
|
||||
set -o pipefail
|
||||
ANSIBLE_INVENTORY_ENABLED=containers.podman.buildah_containers,yaml,ini \
|
||||
ansible-inventory -i ci/tmpinv/buildah_verbose.yml --list -vvvv 1>/tmp/buildah_verbose.out 2>/tmp/buildah_verbose.err || true
|
||||
echo "buildah_verbose.err:"
|
||||
cat /tmp/buildah_verbose.err
|
||||
echo "buildah_verbose.out:"
|
||||
cat /tmp/buildah_verbose.out
|
||||
grep -q "Filtered out hello-buildah by name_patterns option" /tmp/buildah_verbose.out
|
||||
|
||||
- name: Test buildah inventory - empty selection with name_patterns
|
||||
run: |
|
||||
cat > ci/tmpinv/buildah_empty.yml <<'EOF'
|
||||
plugin: containers.podman.buildah_containers
|
||||
name_patterns: ['no-such-*']
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.buildah_containers,yaml,ini ansible-inventory -i ci/tmpinv/buildah_empty.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Expect no groups with hosts
|
||||
test $(echo "$out" | jq '[ . | to_entries[] | select(.value.hosts != null and (.value.hosts | length) > 0) ] | length') -eq 0
|
||||
|
||||
- name: Test buildah inventory - match by name_patterns and host vars
|
||||
run: |
|
||||
cat > ci/tmpinv/buildah_match.yml <<'EOF'
|
||||
plugin: containers.podman.buildah_containers
|
||||
name_patterns: ['hello-buildah']
|
||||
connection_plugin: containers.podman.buildah
|
||||
EOF
|
||||
out=$(ANSIBLE_INVENTORY_ENABLED=containers.podman.buildah_containers,yaml,ini ansible-inventory -i ci/tmpinv/buildah_match.yml --list)
|
||||
echo "$out" | jq '.'
|
||||
# Host should be present in at least one group's hosts list
|
||||
echo "$out" | jq -e '. | to_entries | any(.value.hosts? and (.value.hosts | index("hello-buildah") != null))'
|
||||
# Hostvars should include connection and ids
|
||||
echo "$out" | jq -e '._meta.hostvars["hello-buildah"].ansible_connection == "containers.podman.buildah"'
|
||||
echo "$out" | jq -e '._meta.hostvars["hello-buildah"] | has("buildah_container_id")'
|
||||
echo "$out" | jq -e '._meta.hostvars["hello-buildah"] | has("buildah_container_name")'
|
||||
|
||||
unittests:
|
||||
name: Unit tests inventory
|
||||
runs-on: ${{ matrix.runner-os }}
|
||||
strategy:
|
||||
matrix:
|
||||
runner-os:
|
||||
- ubuntu-24.04
|
||||
# ansible-version:
|
||||
# - git+https://github.com/ansible/ansible.git@stable-2.15
|
||||
runner-python-version:
|
||||
- '3.11'
|
||||
steps:
|
||||
|
||||
- name: Check out ${{ github.repository }} on disk
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.runner-python-version }}
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.runner-python-version }}
|
||||
|
||||
- name: Set up pip cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-pip-${{ hashFiles('tests/sanity/requirements.txt') }}-${{ hashFiles('tests/unit/requirements.txt') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pip-
|
||||
${{ runner.os }}-
|
||||
|
||||
- name: Install requirements for tests
|
||||
run: >-
|
||||
python -m pip install --user -r test-requirements.txt
|
||||
|
||||
- name: Build a collection tarball
|
||||
run: >-
|
||||
~/.local/bin/ansible-galaxy collection build --output-path
|
||||
"${GITHUB_WORKSPACE}/.cache/collection-tarballs"
|
||||
|
||||
- name: Install the collection tarball
|
||||
run: >-
|
||||
~/.local/bin/ansible-galaxy collection install ${GITHUB_WORKSPACE}/.cache/collection-tarballs/*.tar.gz
|
||||
|
||||
- name: Run collection unit tests (with coverage)
|
||||
run: >-
|
||||
~/.local/bin/ansible-test units
|
||||
--python "${{ matrix.runner-python-version }}" --coverage -vvv
|
||||
tests/unit/plugins/inventory/
|
||||
working-directory: >-
|
||||
/home/runner/.ansible/collections/ansible_collections/containers/podman
|
||||
|
||||
- name: Generate coverage reports (xml, html)
|
||||
run: |
|
||||
~/.local/bin/ansible-test coverage xml
|
||||
~/.local/bin/ansible-test coverage html
|
||||
working-directory: >-
|
||||
/home/runner/.ansible/collections/ansible_collections/containers/podman
|
||||
|
||||
- name: Upload coverage artifact (ansible-test outputs)
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: inventory-coverage
|
||||
path: |
|
||||
/home/runner/.ansible/collections/ansible_collections/containers/podman/tests/output/coverage/**
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.buildah connection – Interact with an existing buildah container — Python documentation</title>
|
||||
<title>containers.podman.buildah connection — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman connection – Interact with an existing podman container" href="podman_connection.html" />
|
||||
<link rel="prev" title="containers.podman.podman_unshare become – Run tasks using podman unshare" href="podman_unshare_become.html" />
|
||||
<link rel="next" title="containers.podman.podman connection" href="podman_connection.html" />
|
||||
<link rel="prev" title="containers.podman.podman_unshare become" href="podman_unshare_become.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,88 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-buildah-connection"></span><section id="containers-podman-buildah-connection-interact-with-an-existing-buildah-container">
|
||||
<h1>containers.podman.buildah connection – Interact with an existing buildah container<a class="headerlink" href="#containers-podman-buildah-connection-interact-with-an-existing-buildah-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This connection plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.buildah</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Run commands or put/fetch files to an existing container using buildah tool.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-buildah-connection-parameter-remote-addr"><strong>remote_addr</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ID of the container you want to access.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"inventory_hostname"</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p>Variable: ansible_host</p></li>
|
||||
<li><p>Variable: inventory_hostname</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-buildah-connection-parameter-remote-user"><strong>remote_user</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>User specified via name or ID which is used to execute commands inside the container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<span class="target" id="ansible-collections-containers-podman-buildah-connection"></span><section id="containers-podman-buildah-connection">
|
||||
<h1>containers.podman.buildah connection<a class="headerlink" href="#containers-podman-buildah-connection" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the connection plugin, containers.podman.buildah, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><p>INI entry:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span>
|
||||
<span class="n">remote_user</span> <span class="o">=</span> <span class="n">VALUE</span>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">PluginDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_USER</span></code></p></li>
|
||||
<li><p>Variable: ansible_user</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Tomas Tomecek (@TomasTomecek)</p></li>
|
||||
</ul>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -135,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_unshare_become.html" title="previous chapter">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li>Next: <a href="podman_connection.html" title="next chapter">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li>Previous: <a href="podman_unshare_become.html" title="previous chapter">containers.podman.podman_unshare become</a></li>
|
||||
<li>Next: <a href="podman_connection.html" title="next chapter">containers.podman.podman connection</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
160
docs/buildah_containers_inventory.html
Normal file
160
docs/buildah_containers_inventory.html
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.buildah_containers inventory — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_containers inventory" href="podman_containers_inventory.html" />
|
||||
<link rel="prev" title="containers.podman.podman connection" href="podman_connection.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-buildah-containers-inventory"></span><section id="containers-podman-buildah-containers-inventory">
|
||||
<h1>containers.podman.buildah_containers inventory<a class="headerlink" href="#containers-podman-buildah-containers-inventory" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the inventory plugin, containers.podman.buildah_containers, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">PluginDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Python</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_connection.html" title="previous chapter">containers.podman.podman connection</a></li>
|
||||
<li>Next: <a href="podman_containers_inventory.html" title="next chapter">containers.podman.podman_containers inventory</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
||||
|
||||
|
|
||||
<a href="_sources/buildah_containers_inventory.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -35,54 +35,7 @@
|
|||
<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The following index documents all environment variables declared by plugins in collections.
|
||||
Environment variables used by the ansible-core configuration are documented in <span class="xref std std-ref">ansible_configuration_settings</span>.</p>
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_BECOME_PASS">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_BECOME_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_BECOME_PASS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Password to pass to sudo</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXECUTABLE">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXECUTABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Executable for podman command.</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXTRA_ARGS">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXTRA_ARGS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Extra arguments to pass to the podman command line.</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_EXE">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_EXE</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_EXE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sudo executable</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_PASS">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_PASS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Password to pass to sudo</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std envvar">
|
||||
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_USER">
|
||||
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_USER</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_USER" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>User you ‘become’ to execute the task (‘root’ is not a valid value here).</p>
|
||||
<p><em>Used by:</em>
|
||||
<a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<p>No environment variables have been defined.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -103,41 +56,48 @@ Environment variables used by the ansible-core configuration are documented in <
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
|
|
|
|||
|
|
@ -33,65 +33,8 @@
|
|||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#A"><strong>A</strong></a>
|
||||
| <a href="#E"><strong>E</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="podman_unshare_become.html#index-0">ANSIBLE_BECOME_EXE</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-2">ANSIBLE_BECOME_PASS</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-4">ANSIBLE_BECOME_USER</a>
|
||||
</li>
|
||||
<li><a href="podman_connection.html#index-0">ANSIBLE_PODMAN_EXECUTABLE</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="podman_connection.html#index-1">ANSIBLE_PODMAN_EXTRA_ARGS</a>
|
||||
</li>
|
||||
<li><a href="buildah_connection.html#index-0">ANSIBLE_REMOTE_USER</a>, <a href="podman_connection.html#index-2">[1]</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-1">ANSIBLE_SUDO_EXE</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-3">ANSIBLE_SUDO_PASS</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-5">ANSIBLE_SUDO_USER</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="E">E</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li>
|
||||
environment variable
|
||||
|
||||
<ul>
|
||||
<li><a href="podman_unshare_become.html#index-0">ANSIBLE_BECOME_EXE</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_BECOME_PASS">ANSIBLE_BECOME_PASS</a>, <a href="podman_unshare_become.html#index-2">[1]</a>
|
||||
</li>
|
||||
<li><a href="podman_unshare_become.html#index-4">ANSIBLE_BECOME_USER</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXECUTABLE">ANSIBLE_PODMAN_EXECUTABLE</a>, <a href="podman_connection.html#index-0">[1]</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXTRA_ARGS">ANSIBLE_PODMAN_EXTRA_ARGS</a>, <a href="podman_connection.html#index-1">[1]</a>
|
||||
</li>
|
||||
<li><a href="buildah_connection.html#index-0">ANSIBLE_REMOTE_USER</a>, <a href="podman_connection.html#index-2">[1]</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_EXE">ANSIBLE_SUDO_EXE</a>, <a href="podman_unshare_become.html#index-1">[1]</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_PASS">ANSIBLE_SUDO_PASS</a>, <a href="podman_unshare_become.html#index-3">[1]</a>
|
||||
</li>
|
||||
<li><a href="environment_variables.html#envvar-ANSIBLE_SUDO_USER">ANSIBLE_SUDO_USER</a>, <a href="podman_unshare_become.html#index-5">[1]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -111,41 +54,48 @@
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
|
|
|
|||
149
docs/index.html
149
docs/index.html
|
|
@ -15,7 +15,7 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_container module – Manage podman containers" href="podman_container_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_container module" href="podman_container_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -34,7 +34,7 @@
|
|||
|
||||
<section id="containers-podman">
|
||||
<span id="plugins-in-containers-podman"></span><h1>Containers.Podman<a class="headerlink" href="#containers-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<p>Collection version 1.16.2</p>
|
||||
<p>Collection version 1.18.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
|
||||
|
|
@ -66,34 +66,37 @@
|
|||
<section id="modules">
|
||||
<h3>Modules<a class="headerlink" href="#modules" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="podman_container_module.html#ansible-collections-containers-podman-podman-container-module"><span class="std std-ref">podman_container module</span></a> – Manage podman containers</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_copy_module.html#ansible-collections-containers-podman-podman-container-copy-module"><span class="std std-ref">podman_container_copy module</span></a> – Copy file to/from a container</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_exec_module.html#ansible-collections-containers-podman-podman-container-exec-module"><span class="std std-ref">podman_container_exec module</span></a> – Executes a command in a running container.</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_info_module.html#ansible-collections-containers-podman-podman-container-info-module"><span class="std std-ref">podman_container_info module</span></a> – Gather facts about containers using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_containers_module.html#ansible-collections-containers-podman-podman-containers-module"><span class="std std-ref">podman_containers module</span></a> – Manage podman containers in a batch</p></li>
|
||||
<li><p><a class="reference internal" href="podman_export_module.html#ansible-collections-containers-podman-podman-export-module"><span class="std std-ref">podman_export module</span></a> – Export a podman container</p></li>
|
||||
<li><p><a class="reference internal" href="podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module"><span class="std std-ref">podman_generate_systemd module</span></a> – Generate systemd unit from a pod or a container</p></li>
|
||||
<li><p><a class="reference internal" href="podman_image_module.html#ansible-collections-containers-podman-podman-image-module"><span class="std std-ref">podman_image module</span></a> – Pull images for use by podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_image_info_module.html#ansible-collections-containers-podman-podman-image-info-module"><span class="std std-ref">podman_image_info module</span></a> – Gather info about images using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_import_module.html#ansible-collections-containers-podman-podman-import-module"><span class="std std-ref">podman_import module</span></a> – Import Podman container from a tar file.</p></li>
|
||||
<li><p><a class="reference internal" href="podman_load_module.html#ansible-collections-containers-podman-podman-load-module"><span class="std std-ref">podman_load module</span></a> – Load image from a tar file.</p></li>
|
||||
<li><p><a class="reference internal" href="podman_login_module.html#ansible-collections-containers-podman-podman-login-module"><span class="std std-ref">podman_login module</span></a> – Login to a container registry using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_login_info_module.html#ansible-collections-containers-podman-podman-login-info-module"><span class="std std-ref">podman_login_info module</span></a> – Return the logged-in user if any for a given registry</p></li>
|
||||
<li><p><a class="reference internal" href="podman_logout_module.html#ansible-collections-containers-podman-podman-logout-module"><span class="std std-ref">podman_logout module</span></a> – Log out of a container registry using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_network_module.html#ansible-collections-containers-podman-podman-network-module"><span class="std std-ref">podman_network module</span></a> – Manage podman networks</p></li>
|
||||
<li><p><a class="reference internal" href="podman_network_info_module.html#ansible-collections-containers-podman-podman-network-info-module"><span class="std std-ref">podman_network_info module</span></a> – Gather info about podman networks</p></li>
|
||||
<li><p><a class="reference internal" href="podman_play_module.html#ansible-collections-containers-podman-podman-play-module"><span class="std std-ref">podman_play module</span></a> – Play kubernetes YAML file using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_pod_module.html#ansible-collections-containers-podman-podman-pod-module"><span class="std std-ref">podman_pod module</span></a> – Manage Podman pods</p></li>
|
||||
<li><p><a class="reference internal" href="podman_pod_info_module.html#ansible-collections-containers-podman-podman-pod-info-module"><span class="std std-ref">podman_pod_info module</span></a> – Gather info about podman pods</p></li>
|
||||
<li><p><a class="reference internal" href="podman_prune_module.html#ansible-collections-containers-podman-podman-prune-module"><span class="std std-ref">podman_prune module</span></a> – Allows to prune various podman objects</p></li>
|
||||
<li><p><a class="reference internal" href="podman_runlabel_module.html#ansible-collections-containers-podman-podman-runlabel-module"><span class="std std-ref">podman_runlabel module</span></a> – Run given label from given image</p></li>
|
||||
<li><p><a class="reference internal" href="podman_save_module.html#ansible-collections-containers-podman-podman-save-module"><span class="std std-ref">podman_save module</span></a> – Saves podman image to tar file</p></li>
|
||||
<li><p><a class="reference internal" href="podman_search_module.html#ansible-collections-containers-podman-podman-search-module"><span class="std std-ref">podman_search module</span></a> – Search for remote images using podman</p></li>
|
||||
<li><p><a class="reference internal" href="podman_secret_module.html#ansible-collections-containers-podman-podman-secret-module"><span class="std std-ref">podman_secret module</span></a> – Manage podman secrets</p></li>
|
||||
<li><p><a class="reference internal" href="podman_secret_info_module.html#ansible-collections-containers-podman-podman-secret-info-module"><span class="std std-ref">podman_secret_info module</span></a> – Gather info about podman secrets</p></li>
|
||||
<li><p><a class="reference internal" href="podman_tag_module.html#ansible-collections-containers-podman-podman-tag-module"><span class="std std-ref">podman_tag module</span></a> – Add an additional name to a local image</p></li>
|
||||
<li><p><a class="reference internal" href="podman_volume_module.html#ansible-collections-containers-podman-podman-volume-module"><span class="std std-ref">podman_volume module</span></a> – Manage Podman volumes</p></li>
|
||||
<li><p><a class="reference internal" href="podman_volume_info_module.html#ansible-collections-containers-podman-podman-volume-info-module"><span class="std std-ref">podman_volume_info module</span></a> – Gather info about podman volumes</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_module.html#ansible-collections-containers-podman-podman-container-module"><span class="std std-ref">podman_container module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_copy_module.html#ansible-collections-containers-podman-podman-container-copy-module"><span class="std std-ref">podman_container_copy module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_exec_module.html#ansible-collections-containers-podman-podman-container-exec-module"><span class="std std-ref">podman_container_exec module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_container_info_module.html#ansible-collections-containers-podman-podman-container-info-module"><span class="std std-ref">podman_container_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_containers_module.html#ansible-collections-containers-podman-podman-containers-module"><span class="std std-ref">podman_containers module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_export_module.html#ansible-collections-containers-podman-podman-export-module"><span class="std std-ref">podman_export module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module"><span class="std std-ref">podman_generate_systemd module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_image_module.html#ansible-collections-containers-podman-podman-image-module"><span class="std std-ref">podman_image module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_image_info_module.html#ansible-collections-containers-podman-podman-image-info-module"><span class="std std-ref">podman_image_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_import_module.html#ansible-collections-containers-podman-podman-import-module"><span class="std std-ref">podman_import module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_load_module.html#ansible-collections-containers-podman-podman-load-module"><span class="std std-ref">podman_load module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_login_module.html#ansible-collections-containers-podman-podman-login-module"><span class="std std-ref">podman_login module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_login_info_module.html#ansible-collections-containers-podman-podman-login-info-module"><span class="std std-ref">podman_login_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_logout_module.html#ansible-collections-containers-podman-podman-logout-module"><span class="std std-ref">podman_logout module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_network_module.html#ansible-collections-containers-podman-podman-network-module"><span class="std std-ref">podman_network module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_network_info_module.html#ansible-collections-containers-podman-podman-network-info-module"><span class="std std-ref">podman_network_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_play_module.html#ansible-collections-containers-podman-podman-play-module"><span class="std std-ref">podman_play module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_pod_module.html#ansible-collections-containers-podman-podman-pod-module"><span class="std std-ref">podman_pod module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_pod_info_module.html#ansible-collections-containers-podman-podman-pod-info-module"><span class="std std-ref">podman_pod_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_prune_module.html#ansible-collections-containers-podman-podman-prune-module"><span class="std std-ref">podman_prune module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_quadlet_module.html#ansible-collections-containers-podman-podman-quadlet-module"><span class="std std-ref">podman_quadlet module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_quadlet_info_module.html#ansible-collections-containers-podman-podman-quadlet-info-module"><span class="std std-ref">podman_quadlet_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_runlabel_module.html#ansible-collections-containers-podman-podman-runlabel-module"><span class="std std-ref">podman_runlabel module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_save_module.html#ansible-collections-containers-podman-podman-save-module"><span class="std std-ref">podman_save module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_search_module.html#ansible-collections-containers-podman-podman-search-module"><span class="std std-ref">podman_search module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_secret_module.html#ansible-collections-containers-podman-podman-secret-module"><span class="std std-ref">podman_secret module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_secret_info_module.html#ansible-collections-containers-podman-podman-secret-info-module"><span class="std std-ref">podman_secret_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_system_info_module.html#ansible-collections-containers-podman-podman-system-info-module"><span class="std std-ref">podman_system_info module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_tag_module.html#ansible-collections-containers-podman-podman-tag-module"><span class="std std-ref">podman_tag module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_volume_module.html#ansible-collections-containers-podman-podman-volume-module"><span class="std std-ref">podman_volume module</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_volume_info_module.html#ansible-collections-containers-podman-podman-volume-info-module"><span class="std std-ref">podman_volume_info module</span></a> –</p></li>
|
||||
</ul>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
|
|
@ -101,7 +104,7 @@
|
|||
<section id="become-plugins">
|
||||
<h3>Become Plugins<a class="headerlink" href="#become-plugins" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">podman_unshare become</span></a> – Run tasks using podman unshare</p></li>
|
||||
<li><p><a class="reference internal" href="podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">podman_unshare become</span></a> –</p></li>
|
||||
</ul>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
|
|
@ -109,8 +112,17 @@
|
|||
<section id="connection-plugins">
|
||||
<h3>Connection Plugins<a class="headerlink" href="#connection-plugins" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">buildah connection</span></a> – Interact with an existing buildah container</p></li>
|
||||
<li><p><a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">podman connection</span></a> – Interact with an existing podman container</p></li>
|
||||
<li><p><a class="reference internal" href="buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">buildah connection</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">podman connection</span></a> –</p></li>
|
||||
</ul>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</section>
|
||||
<section id="inventory-plugins">
|
||||
<h3>Inventory Plugins<a class="headerlink" href="#inventory-plugins" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="buildah_containers_inventory.html#ansible-collections-containers-podman-buildah-containers-inventory"><span class="std std-ref">buildah_containers inventory</span></a> –</p></li>
|
||||
<li><p><a class="reference internal" href="podman_containers_inventory.html#ansible-collections-containers-podman-podman-containers-inventory"><span class="std std-ref">podman_containers inventory</span></a> –</p></li>
|
||||
</ul>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
|
|
@ -136,48 +148,55 @@
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="#">Documentation overview</a><ul>
|
||||
<li>Next: <a href="podman_container_module.html" title="next chapter">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li>Next: <a href="podman_container_module.html" title="next chapter">containers.podman.podman_container module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman connection – Interact with an existing podman container — Python documentation</title>
|
||||
<title>containers.podman.podman connection — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,7 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="containers.podman.buildah connection – Interact with an existing buildah container" href="buildah_connection.html" />
|
||||
<link rel="next" title="containers.podman.buildah_containers inventory" href="buildah_containers_inventory.html" />
|
||||
<link rel="prev" title="containers.podman.buildah connection" href="buildah_connection.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -32,121 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-connection"></span><section id="containers-podman-podman-connection-interact-with-an-existing-podman-container">
|
||||
<h1>containers.podman.podman connection – Interact with an existing podman container<a class="headerlink" href="#containers-podman-podman-connection-interact-with-an-existing-podman-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This connection plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Run commands or put/fetch files to an existing container using podman tool.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-podman_executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-executable"><strong>podman_executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-podman_executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Executable for podman command.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p>Environment variable: <span class="target" id="index-0"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXECUTABLE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></code></a></p></li>
|
||||
<li><p>Variable: ansible_podman_executable</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-podman_extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-extra-args"><strong>podman_extra_args</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-podman_extra_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Extra arguments to pass to the podman command line.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-connection"></span><section id="containers-podman-podman-connection">
|
||||
<h1>containers.podman.podman connection<a class="headerlink" href="#containers-podman-podman-connection" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the connection plugin, containers.podman.podman, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><p>INI entry:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span>
|
||||
<span class="n">podman_extra_args</span> <span class="o">=</span> <span class="s2">""</span>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">PluginDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXTRA_ARGS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></code></a></p></li>
|
||||
<li><p>Variable: ansible_podman_extra_args</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-addr"><strong>remote_addr</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ID of the container you want to access.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"inventory_hostname"</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p>Variable: ansible_host</p></li>
|
||||
<li><p>Variable: inventory_hostname</p></li>
|
||||
<li><p>Variable: ansible_podman_host</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-user"><strong>remote_user</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set <code class="docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_TMP</span></code> to a path that exits inside the container and is writable by Ansible.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul>
|
||||
<li><p>INI entry:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span>
|
||||
<span class="n">remote_user</span> <span class="o">=</span> <span class="n">VALUE</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-2"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_USER</span></code></p></li>
|
||||
<li><p>Variable: ansible_user</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Tomas Tomecek (@TomasTomecek)</p></li>
|
||||
</ul>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -167,48 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="buildah_connection.html" title="previous chapter">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li>Previous: <a href="buildah_connection.html" title="previous chapter">containers.podman.buildah connection</a></li>
|
||||
<li>Next: <a href="buildah_containers_inventory.html" title="next chapter">containers.podman.buildah_containers inventory</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_container_copy module – Copy file to/from a container — Python documentation</title>
|
||||
<title>containers.podman.podman_container_copy module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_container_exec module – Executes a command in a running container." href="podman_container_exec_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container module – Manage podman containers" href="podman_container_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_container_exec module" href="podman_container_exec_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container module" href="podman_container_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,145 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-container-copy-module"></span><section id="containers-podman-podman-container-copy-module-copy-file-to-from-a-container">
|
||||
<h1>containers.podman.podman_container_copy module – Copy file to/from a container<a class="headerlink" href="#containers-podman-podman-container-copy-module-copy-file-to-from-a-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_container_copy</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id3">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Copy file or folder from the host to a container and vice-versa.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-archive"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-archive"><strong>archive</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-archive" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Chown copied files to the primary uid/gid of the destination container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-container"><strong>container</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-container" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name/ID of the container to copy from/to</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-dest"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-dest"><strong>dest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the destination file/folder to copy from/to the container</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-from_container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-from-container"><strong>from_container</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-from_container" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Specify whether or not the file must be copied from the container to the host</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-overwrite"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-overwrite"><strong>overwrite</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-overwrite" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allow to overwrite directories with non-directories and vice versa</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-src"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-copy-module-parameter-src"><strong>src</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-src" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the file/folder to copy from/to the container</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman may required elevated privileges in order to run properly.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Copy file "test.yml" on the host to the "apache" container's root folder</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_search</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test.yml</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/</span>
|
||||
<span class="w"> </span><span class="nt">container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apache</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Copy file "test.yml" in the "apache" container's root folder to the playbook's folder</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_search</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/test.yml</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./</span>
|
||||
<span class="w"> </span><span class="nt">container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apache</span>
|
||||
<span class="w"> </span><span class="nt">from_container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-container-copy-module"></span><section id="containers-podman-podman-container-copy-module">
|
||||
<h1>containers.podman.podman_container_copy module<a class="headerlink" href="#containers-podman-podman-container-copy-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_container_copy, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Alessandro Rossi (@kubealex)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -192,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_container_module.html" title="previous chapter">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li>Next: <a href="podman_container_exec_module.html" title="next chapter">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li>Previous: <a href="podman_container_module.html" title="previous chapter">containers.podman.podman_container module</a></li>
|
||||
<li>Next: <a href="podman_container_exec_module.html" title="next chapter">containers.podman.podman_container_exec module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_container_exec module – Executes a command in a running container. — Python documentation</title>
|
||||
<title>containers.podman.podman_container_exec module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_container_info module – Gather facts about containers using podman" href="podman_container_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container_copy module – Copy file to/from a container" href="podman_container_copy_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_container_info module" href="podman_container_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container_copy module" href="podman_container_copy_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,239 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-container-exec-module"></span><section id="containers-podman-podman-container-exec-module-executes-a-command-in-a-running-container">
|
||||
<h1>containers.podman.podman_container_exec module – Executes a command in a running container.<a class="headerlink" href="#containers-podman-podman-container-exec-module-executes-a-command-in-a-running-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-container-exec-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_container_exec</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Executes a command in a running container.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-container-exec-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>podman</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-argv"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-argv"><strong>argv</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-argv" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Passes the command as a list rather than a string.</p>
|
||||
<p>One of the <em>command</em> or <em>args</em> is required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-command"><strong>command</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-command" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The command to run in the container.</p>
|
||||
<p>One of the <em>command</em> or <em>args</em> is required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-detach"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-detach"><strong>detach</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-detach" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If true, the command runs in the background.</p>
|
||||
<p>The exec session is automatically removed when it completes.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-env"><strong>env</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set environment variables.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The path to the podman executable.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the container where the command is executed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-privileged"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-privileged"><strong>privileged</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-privileged" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Give extended privileges to the container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tty"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-tty"><strong>tty</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tty" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allocate a pseudo-TTY.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-user"><strong>user</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The username or UID used and, optionally, the groupname or GID for the specified command.</p>
|
||||
<p>Both user and group may be symbolic or numeric.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-workdir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-parameter-workdir"><strong>workdir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-workdir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Working directory inside the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-exec.1.html">the Podman documentation</a> for details of podman-exec(1).</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Execute a command with workdir</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubi8</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"cat</span><span class="nv"> </span><span class="s">redhat-release"</span>
|
||||
<span class="w"> </span><span class="nt">workdir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Execute a command with a list of args and environment variables</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test_container</span>
|
||||
<span class="w"> </span><span class="nt">argv</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/bin/sh</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-c</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">echo $HELLO $BYE</span>
|
||||
<span class="w"> </span><span class="nt">env</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">HELLO</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hello world</span>
|
||||
<span class="w"> </span><span class="nt">BYE</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">goodbye world</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Execute command in background by using detach</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container_exec</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">detach_container</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="s">"cat</span><span class="nv"> </span><span class="s">redhat-release"</span>
|
||||
<span class="w"> </span><span class="nt">detach</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-container-exec-module"></span><section id="containers-podman-podman-container-exec-module">
|
||||
<h1>containers.podman.podman_container_exec module<a class="headerlink" href="#containers-podman-podman-container-exec-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_container_exec, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-exec_id"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-exec-id"><strong>exec_id</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-exec_id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ID of the exec session.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success and <em>detach=true</em></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-rc"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-rc"><strong>rc</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-rc" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The exit code of the command executed in the container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-stderr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-stderr"><strong>stderr</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-stderr" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The standard output of the command executed in the container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-stdout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-container-exec-module-return-stdout"><strong>stdout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-stdout" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The standard output of the command executed in the container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Takuya Nishimura (@nishipy)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -286,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_container_copy_module.html" title="previous chapter">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li>Next: <a href="podman_container_info_module.html" title="next chapter">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li>Previous: <a href="podman_container_copy_module.html" title="previous chapter">containers.podman.podman_container_copy module</a></li>
|
||||
<li>Next: <a href="podman_container_info_module.html" title="next chapter">containers.podman.podman_container_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
158
docs/podman_containers_inventory.html
Normal file
158
docs/podman_containers_inventory.html
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_containers inventory — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="containers.podman.buildah_containers inventory" href="buildah_containers_inventory.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-containers-inventory"></span><section id="containers-podman-podman-containers-inventory">
|
||||
<h1>containers.podman.podman_containers inventory<a class="headerlink" href="#containers-podman-podman-containers-inventory" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the inventory plugin, containers.podman.podman_containers, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">PluginDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">Python</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="buildah_containers_inventory.html" title="previous chapter">containers.podman.buildah_containers inventory</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
||||
|
||||
|
|
||||
<a href="_sources/podman_containers_inventory.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_containers module – Manage podman containers in a batch — Python documentation</title>
|
||||
<title>containers.podman.podman_containers module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_export module – Export a podman container" href="podman_export_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container_info module – Gather facts about containers using podman" href="podman_container_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_export module" href="podman_export_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_container_info module" href="podman_container_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,100 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-containers-module"></span><section id="containers-podman-podman-containers-module-manage-podman-containers-in-a-batch">
|
||||
<h1>containers.podman.podman_containers module – Manage podman containers in a batch<a class="headerlink" href="#containers-podman-podman-containers-module-manage-podman-containers-in-a-batch" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-containers-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_containers</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.4.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Manage groups of podman containers</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-containers-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>podman</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-containers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-containers-module-parameter-containers"><strong>containers</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-containers" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of dictionaries with data for running containers for podman_container module.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-containers-module-parameter-debug"><strong>debug</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Return additional information which can be helpful for investigations.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run three containers at once</span>
|
||||
<span class="w"> </span><span class="nt">podman_containers</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">containers</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sleep 1d</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3.10-alpine</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python -V</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-containers-module"></span><section id="containers-podman-podman-containers-module">
|
||||
<h1>containers.podman.podman_containers module<a class="headerlink" href="#containers-podman-podman-containers-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_containers, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -147,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_container_info_module.html" title="previous chapter">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li>Next: <a href="podman_export_module.html" title="next chapter">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li>Previous: <a href="podman_container_info_module.html" title="previous chapter">containers.podman.podman_container_info module</a></li>
|
||||
<li>Next: <a href="podman_export_module.html" title="next chapter">containers.podman.podman_export module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_export module – Export a podman container — Python documentation</title>
|
||||
<title>containers.podman.podman_export module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container" href="podman_generate_systemd_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_containers module – Manage podman containers in a batch" href="podman_containers_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_generate_systemd module" href="podman_generate_systemd_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_containers module" href="podman_containers_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,117 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-export-module"></span><section id="containers-podman-podman-export-module-export-a-podman-container">
|
||||
<h1>containers.podman.podman_export module – Export a podman container<a class="headerlink" href="#containers-podman-podman-export-module-export-a-podman-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-export-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_export</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>podman export exports the filesystem of a container and saves it as a tarball on the local machine</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-export-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-container"><strong>container</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-container" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Container to export.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-dest"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-dest"><strong>dest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to export container to.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Force saving to file even if it exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-export-module-parameter-volume"><strong>volume</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Volume to export.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_export</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span>
|
||||
<span class="w"> </span><span class="nt">container</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container-name</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_export</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span>
|
||||
<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">volume-name</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-export-module"></span><section id="containers-podman-podman-export-module">
|
||||
<h1>containers.podman.podman_export module<a class="headerlink" href="#containers-podman-podman-export-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_export, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -164,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_containers_module.html" title="previous chapter">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li>Next: <a href="podman_generate_systemd_module.html" title="next chapter">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li>Previous: <a href="podman_containers_module.html" title="previous chapter">containers.podman.podman_containers module</a></li>
|
||||
<li>Next: <a href="podman_generate_systemd_module.html" title="next chapter">containers.podman.podman_generate_systemd module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container — Python documentation</title>
|
||||
<title>containers.podman.podman_generate_systemd module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_image module – Pull images for use by podman" href="podman_image_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_export module – Export a podman container" href="podman_export_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_image module" href="podman_image_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_export module" href="podman_export_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,359 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-generate-systemd-module"></span><section id="containers-podman-podman-generate-systemd-module-generate-systemd-unit-from-a-pod-or-a-container">
|
||||
<h1>containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container<a class="headerlink" href="#containers-podman-podman-generate-systemd-module-generate-systemd-unit-from-a-pod-or-a-container" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-generate-systemd-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_generate_systemd</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Generate systemd .service unit file(s) from a pod or a container</p></li>
|
||||
<li><p>Support Ansible check mode</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-generate-systemd-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on target host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-after"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-after"><strong>after</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-after" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Add the systemd unit after (<code class="docutils literal notranslate"><span class="pre">After=</span></code>) option, that ordering dependencies between the list of dependencies and this service.</p>
|
||||
<p>This option may be specified more than once.</p>
|
||||
<p>User-defined dependencies will be appended to the generated unit file</p>
|
||||
<p>But any existing options such as needed or defined by default (e.g. <code class="docutils literal notranslate"><span class="pre">online.target</span></code>) will not be removed or overridden.</p>
|
||||
<p>Only with Podman 4.0.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-container_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-container-prefix"><strong>container_prefix</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-container_prefix" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the systemd unit name prefix for containers.</p>
|
||||
<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">container</span></code>.</p>
|
||||
<p>Refer to podman-generate-systemd(1) man page for more information.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-dest"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-dest"><strong>dest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Destination of the generated systemd unit file(s).</p>
|
||||
<p>Use <code class="docutils literal notranslate"><span class="pre">/etc/systemd/system</span></code> for the system-wide systemd instance.</p>
|
||||
<p>Use <code class="docutils literal notranslate"><span class="pre">/etc/systemd/user</span></code> or <code class="docutils literal notranslate"><span class="pre">~/.config/systemd/user</span></code> for use with per-user instances of systemd.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-env"><strong>env</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set environment variables to the systemd unit files.</p>
|
||||
<p>Keys are the environment variable names, and values are the environment variable values</p>
|
||||
<p>Only with Podman 4.3.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p><code class="docutils literal notranslate"><span class="pre">Podman</span></code> executable name or full path</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Replace the systemd unit file(s) even if it already exists.</p>
|
||||
<p>This works with dest option.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the pod or container to export</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-new"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-new"><strong>new</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-new" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Generate unit files that create containers and pods, not only start them.</p>
|
||||
<p>Refer to podman-generate-systemd(1) man page for more information.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-no_header"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-no-header"><strong>no_header</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-no_header" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Do not generate the header including meta data such as the Podman version and the timestamp.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pod_prefix"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-pod-prefix"><strong>pod_prefix</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pod_prefix" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the systemd unit name prefix for pods.</p>
|
||||
<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">pod</span></code>.</p>
|
||||
<p>Refer to podman-generate-systemd(1) man page for more information.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-requires"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-requires"><strong>requires</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-requires" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the systemd unit requires (Requires=) option.</p>
|
||||
<p>Similar to wants, but declares a stronger requirement dependency.</p>
|
||||
<p>Only with Podman 4.0.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-restart_policy"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-restart-policy"><strong>restart_policy</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-restart_policy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Restart policy of the service</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"no-restart"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-success"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-failure"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abnormal"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-watchdog"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"on-abort"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"always"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-restart_sec"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-restart-sec"><strong>restart_sec</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-restart_sec" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Configures the time to sleep before restarting a service (as configured with restart-policy).</p>
|
||||
<p>Takes a value in seconds.</p>
|
||||
<p>Only with Podman 4.0.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-separator"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-separator"><strong>separator</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-separator" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Systemd unit name separator between the name/id of a container/pod and the prefix.</p>
|
||||
<p>If not set, use the default defined by podman, <code class="docutils literal notranslate"><span class="pre">-</span></code>.</p>
|
||||
<p>Refer to podman-generate-systemd(1) man page for more information.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-start_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-start-timeout"><strong>start_timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-start_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Override the default start timeout for the container with the given value in seconds.</p>
|
||||
<p>Only with Podman 4.0.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-stop-timeout"><strong>stop_timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Override the default stop timeout for the container with the given value in seconds.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-use-names"><strong>use_names</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-use_names" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use name of the containers for the start, stop, and description in the unit file.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wants"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-parameter-wants"><strong>wants</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-wants" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Add the systemd unit wants (<code class="docutils literal notranslate"><span class="pre">Wants=</span></code>) option, that this service is (weak) dependent on.</p>
|
||||
<p>This option may be specified more than once.</p>
|
||||
<p>This option does not influence the order in which services are started or stopped.</p>
|
||||
<p>User-defined dependencies will be appended to the generated unit file</p>
|
||||
<p>But any existing options such as needed or defined by default (e.g. <code class="docutils literal notranslate"><span class="pre">online.target</span></code>) will not be removed or overridden.</p>
|
||||
<p>Only with Podman 4.0.0 and above</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>If you indicate a pod, the systemd units for it and all its containers will be generated</p></li>
|
||||
<li><p>Create all your pods, containers and their dependencies before generating the systemd files</p></li>
|
||||
<li><p>If a container or pod is already started before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon-reload</span></code>, systemd will not see the container or pod as started</p></li>
|
||||
<li><p>Stop your container or pod before you do a <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">daemon-reload</span></code>, then you can start them with <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">start</span> <span class="pre">my_container.service</span></code></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example of creating a container and systemd unit file.</span>
|
||||
<span class="c1"># When using podman_generate_systemd with new:true then</span>
|
||||
<span class="c1"># the container needs rm:true for idempotence.</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create postgres container</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/postgres:latest</span>
|
||||
<span class="w"> </span><span class="nt">rm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">created</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Generate systemd unit file for postgres container</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres</span>
|
||||
<span class="w"> </span><span class="nt">new</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">no_header</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/systemd/system</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ensure postgres container is started and enabled</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container-postgres</span>
|
||||
<span class="w"> </span><span class="nt">daemon_reload</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
|
||||
<span class="c1"># Example of creating a container and integrate it into systemd</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">A postgres container must exist, stopped</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/postgres:latest</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">stopped</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Systemd unit files for postgres container must exist</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.config/systemd/user/</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Postgres container must be started and enabled on systemd</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container-postgres_local</span>
|
||||
<span class="w"> </span><span class="nt">scope</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||||
<span class="w"> </span><span class="nt">daemon_reload</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
|
||||
<span class="c1"># Generate the unit files, but store them on an Ansible variable</span>
|
||||
<span class="c1"># instead of writing them on target host</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Systemd unit files for postgres container must be generated</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local</span>
|
||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span>
|
||||
|
||||
<span class="c1"># Generate the unit files with environment variables sets</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Systemd unit files for postgres container must be generated</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_generate_systemd</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local</span>
|
||||
<span class="w"> </span><span class="nt">env</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">POSTGRES_USER</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_app</span>
|
||||
<span class="w"> </span><span class="nt">POSTGRES_PASSWORD</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
|
||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgres_local_systemd_unit</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-generate-systemd-module"></span><section id="containers-podman-podman-generate-systemd-module">
|
||||
<h1>containers.podman.podman_generate_systemd module<a class="headerlink" href="#containers-podman-podman-generate-systemd-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_generate_systemd, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-podman_command"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-return-podman-command"><strong>podman_command</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-podman_command" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A copy of the podman command used to generate the systemd unit(s)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"podman</span> <span class="pre">generate</span> <span class="pre">systemd</span> <span class="pre">my_webapp"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-systemd_units"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-generate-systemd-module-return-systemd-units"><strong>systemd_units</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-systemd_units" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A copy of the generated systemd .service unit(s)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"container-postgres_local":</span> <span class="pre">"</span> <span class="pre">#Content</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">systemd</span> <span class="pre">.servec</span> <span class="pre">unit</span> <span class="pre">for</span> <span class="pre">postgres_local</span> <span class="pre">container",</span> <span class="pre">"pod-my_webapp":</span> <span class="pre">"</span> <span class="pre">#Content</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">systemd</span> <span class="pre">.servec</span> <span class="pre">unit</span> <span class="pre">for</span> <span class="pre">my_webapp</span> <span class="pre">pod"}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sébastien Gendre (@CyberFox001)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -406,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_export_module.html" title="previous chapter">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li>Next: <a href="podman_image_module.html" title="next chapter">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li>Previous: <a href="podman_export_module.html" title="previous chapter">containers.podman.podman_export module</a></li>
|
||||
<li>Next: <a href="podman_image_module.html" title="next chapter">containers.podman.podman_image module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_image_info module – Gather info about images using podman — Python documentation</title>
|
||||
<title>containers.podman.podman_image_info module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_import module – Import Podman container from a tar file." href="podman_import_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_image module – Pull images for use by podman" href="podman_image_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_import module" href="podman_import_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_image module" href="podman_image_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,119 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-image-info-module"></span><section id="containers-podman-podman-image-info-module-gather-info-about-images-using-podman">
|
||||
<h1>containers.podman.podman_image_info module – Gather info about images using podman<a class="headerlink" href="#containers-podman-podman-image-info-module-gather-info-about-images-using-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_image_info</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id3">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Gather info about images using <code class="docutils literal notranslate"><span class="pre">podman</span></code></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-info-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-info-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of tags or UID to gather info about. If no name is given return info about all images.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman may required elevated privileges in order to run properly.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info for all images</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info on a specific image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info on several images</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-image-info-module"></span><section id="containers-podman-podman-image-info-module">
|
||||
<h1>containers.podman.podman_image_info module<a class="headerlink" href="#containers-podman-podman-image-info-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_image_info, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-images"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-info-module-return-images"><strong>images</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-images" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>info from all or specified images</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"",</span> <span class="pre">"Config":</span> <span class="pre">{"Cmd":</span> <span class="pre">["/bin/sh"],</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"]},</span> <span class="pre">"Created":</span> <span class="pre">"2023-06-14T20:42:13.993588153Z",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:3362f865019db5f14ac5154cb0db2c3741ad1cce0416045be422ad4de441b081",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"UpperDir":</span> <span class="pre">"/home/podman/.local/share/containers/storage/overlay/579b.../diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/home/podman/.local/share/containers/storage/overlay/579b.../work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"History":</span> <span class="pre">[{"created":</span> <span class="pre">"2023-06-14T20:42:13.893052319Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span> <span class="pre">ADD</span> <span class="pre">file:234234234</span> <span class="pre">in</span> <span class="pre">/</span> <span class="pre">"},</span> <span class="pre">{"created":</span> <span class="pre">"2023-06-14T20:42:13.993588153Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span>  <span class="pre">CMD</span> <span class="pre">[\"/bin/sh\"]",</span> <span class="pre">"empty_layer":</span> <span class="pre">true}],</span> <span class="pre">"Id":</span> <span class="pre">"029bed813f07be84fae0344cbf8076ced5ea3c929d5f064ba617ac7d8c610a4b",</span> <span class="pre">"Labels":</span> <span class="pre">null,</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.docker.distribution.manifest.v2+json",</span> <span class="pre">"NamesHistory":</span> <span class="pre">["quay.io/podman/alpine:3.15",</span> <span class="pre">"quay.io/podman/alpine:3.15",</span> <span class="pre">"docker.io/library/alpine:3.15"],</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">["docker.io/library/alpine@sha256:3362f865019db5f14ac5154cb0db2c3741ad1cce0416045be422ad4de441b081",</span> <span class="pre">"docker.io/library/alpine@sha256:c58a2fce65cb3487f965d2fb08eec4843384dbe29264f427b665421db1aabef2",</span> <span class="pre">"quay.io/podman/alpine@sha256:3362f865019db5f14ac5154cb0db2c3741ad1cce0416045be422ad4de441b081",</span> <span class="pre">"quay.io/podman/alpine@sha256:c58a2fce65cb3487f965d2fb08eec4843384dbe29264f427b665421db1aabef2",</span> <span class="pre">"quay.io/podman/alpine@sha256:3362f865019db5f14ac5154cb0db2c3741ad1cce0416045be422ad4de441b081",</span> <span class="pre">"quay.io/podman/alpine@sha256:c58a2fce65cb3487f965d2fb08eec4843384dbe29264f427b665421db1aabef2"],</span> <span class="pre">"RepoTags":</span> <span class="pre">["docker.io/library/alpine:3.15",</span> <span class="pre">"quay.io/podman/alpine:3.15",</span> <span class="pre">"quay.io/podman/alpine:3.15"],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:579b..."],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">11745350,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"20.10.23",</span> <span class="pre">"VirtualSize":</span> <span class="pre">11745350}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sam Doran (@samdoran)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -166,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_image_module.html" title="previous chapter">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li>Next: <a href="podman_import_module.html" title="next chapter">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li>Previous: <a href="podman_image_module.html" title="previous chapter">containers.podman.podman_image module</a></li>
|
||||
<li>Next: <a href="podman_import_module.html" title="next chapter">containers.podman.podman_import module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_image module – Pull images for use by podman — Python documentation</title>
|
||||
<title>containers.podman.podman_image module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_image_info module – Gather info about images using podman" href="podman_image_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container" href="podman_generate_systemd_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_image_info module" href="podman_image_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_generate_systemd module" href="podman_generate_systemd_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,583 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-image-module"></span><section id="containers-podman-podman-image-module-pull-images-for-use-by-podman">
|
||||
<h1>containers.podman.podman_image module – Pull images for use by podman<a class="headerlink" href="#containers-podman-podman-image-module-pull-images-for-use-by-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_image</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Build, pull, or push images using Podman.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-arch"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-arch"><strong>arch</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-arch" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>CPU architecture for the container image</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-auth_file"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-authfile"><span id="ansible-collections-containers-podman-podman-image-module-parameter-auth-file"></span><strong>auth_file</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-auth_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: authfile</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to file containing authorization credentials to the remote registry.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build"></span><strong>build</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: build_args, buildargs</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Arguments that control image build.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/annotation"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/annotation"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/annotation"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-annotation"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-annotation"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-annotation"></span><strong>annotation</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/annotation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Dictionary of key=value pairs to add to the image. Only works with OCI images. Ignored for Docker containers.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/cache"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/cache"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/cache"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-cache"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-cache"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-cache"></span><strong>cache</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/cache" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether or not to use cached layers when building an image</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/container_file"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/container_file"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/container_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-container-file"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-container-file"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-container-file"></span><strong>container_file</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/container_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Content of the Containerfile to use for building the image. Mutually exclusive with the <code class="docutils literal notranslate"><span class="pre">file</span></code> option which is path to the existing Containerfile.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/extra_args"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/extra_args"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-extra-args"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-extra-args"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-extra-args"></span><strong>extra_args</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/extra_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Extra args to pass to build, if executed. Does not idempotently check for new build args.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/file"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/file"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-file"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-file"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-file"></span><strong>file</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Path to the Containerfile if it is not in the build context directory. Mutually exclusive with the <code class="docutils literal notranslate"><span class="pre">container_file</span></code> option.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/force_rm"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/force_rm"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/force_rm"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-force-rm"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-force-rm"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-force-rm"></span><strong>force_rm</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/force_rm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Always remove intermediate containers after a build, even if the build is unsuccessful.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/format"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/format"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-format"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-format"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-format"></span><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Format of the built image.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"oci"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/rm"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/rm"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/rm"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-rm"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-rm"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-rm"></span><strong>rm</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/rm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Remove intermediate containers after a successful build</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/target"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/target"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/target"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-target"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-target"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-target"></span><strong>target</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/target" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify the target build stage to build.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build/volume"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-build_args/volume"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-buildargs/volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-buildargs-volume"><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-args-volume"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-build-volume"></span><strong>volume</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build/volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify multiple volume / mount options to mount one or more mounts to a container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ca_cert_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-ca-cert-dir"><strong>ca_cert_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ca_cert_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to directory containing TLS certificates and keys to use.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code>.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether or not to force push or pull an image.</p>
|
||||
<p>When building, force the build even if the image already exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the image to pull, push, or delete. It may contain a tag using the format <code class="docutils literal notranslate"><span class="pre">image:tag</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-password"><strong>password</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Password to use when authenticating to remote registries.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-path"><strong>path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the build context directory.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pull"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-pull"><strong>pull</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pull" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether or not to pull the image.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pull_extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-pull-extra-args"><strong>pull_extra_args</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pull_extra_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Extra arguments to pass to the pull command.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push"><strong>push</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether or not to push an image.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args"><strong>push_args</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Arguments that control pushing images.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/compress"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-compress"><strong>compress</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/compress" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Compress tarball image layers when pushing to a directory using the ‘dir’ transport.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/dest"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/destination"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-destination"><span id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-dest"></span><strong>dest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: destination</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Path or URL where image will be pushed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-extra-args"><strong>extra_args</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/extra_args" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Extra args to pass to push, if executed. Does not idempotently check for new push args.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-format"><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Manifest type to use when pushing an image using the ‘dir’ transport (default is manifest type of source)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"v2s1"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"v2s2"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/remove_signatures"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-remove-signatures"><strong>remove_signatures</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/remove_signatures" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Discard any pre-existing signatures in the image</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/sign_by"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-sign-by"><strong>sign_by</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/sign_by" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Path to a key file to use to sign the image.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-push_args/transport"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-push-args-transport"><strong>transport</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-push_args/transport" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Transport to use when pushing in image. If no transport is set, will attempt to push to a remote registry</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dir"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-archive"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-daemon"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-archive"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ostree"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-quadlet-dir"><strong>quadlet_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the directory to write quadlet file in. By default, it will be set as <code class="docutils literal notranslate"><span class="pre">/etc/containers/systemd/</span></code> for root user, <code class="docutils literal notranslate"><span class="pre">~/.config/containers/systemd/</span></code> for non-root users.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_file_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-quadlet-file-mode"><strong>quadlet_file_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_file_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The permissions of the quadlet file.</p>
|
||||
<p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-image-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> can be specied as octal numbers or as a symbolic mode (for example, <code class="ansible-value docutils literal notranslate"><span class="pre">u+rwx</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">u=rw,g=r,o=r</span></code>). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like <code class="ansible-value docutils literal notranslate"><span class="pre">0644</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">01777</span></code>) or quote it (like <code class="ansible-value docutils literal notranslate"><span class="pre">'644'</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">'1777'</span></code>) so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-image-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does not</strong> exist, the default <code class="ansible-value docutils literal notranslate"><span class="pre">'0640'</span></code> mask will be used when setting the mode for the newly created file.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-image-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does</strong> exist, the mode of the existing file will be used.</p>
|
||||
<p>Specifying <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-image-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is the best way to ensure files are created with the correct permissions.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_filename"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-quadlet-filename"><strong>quadlet_filename</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_filename" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of quadlet file to write. By default it takes image name without prefixes and tags.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-quadlet-options"><strong>quadlet_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Options for the quadlet file. Provide missing in usual network args options as a list of lines to add.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether an image should be present, absent, or built.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"build"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"quadlet"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tag"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-tag"><strong>tag</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tag" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Tag of the image to pull, push, or delete.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"latest"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-username"><strong>username</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>username to use when authenticating to remote registries.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-tlsverify"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-parameter-validate-certs"><span id="ansible-collections-containers-podman-podman-image-module-parameter-tlsverify"></span><span id="ansible-collections-containers-podman-podman-image-module-parameter-tls-verify"></span><strong>validate_certs</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: tlsverify, tls_verify</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Require HTTPS and validate certificates when pulling or pushing. Also used during build if a pull or push is necessary.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Pull an image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Remove an image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Remove an image with image id</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0e901e68141f</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Pull a specific version of an image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redis</span>
|
||||
<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build a basic OCI image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build a basic OCI image with advanced parameters</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
<span class="w"> </span><span class="nt">build</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">cache</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">no</span>
|
||||
<span class="w"> </span><span class="nt">force_rm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci</span>
|
||||
<span class="w"> </span><span class="nt">annotation</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">function</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">proxy</span>
|
||||
<span class="w"> </span><span class="nt">info</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Load balancer for my cool app</span>
|
||||
<span class="w"> </span><span class="nt">extra_args</span><span class="p">:</span><span class="w"> </span><span class="s">"--build-arg</span><span class="nv"> </span><span class="s">KEY=value"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build a Docker formatted image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
<span class="w"> </span><span class="nt">build</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and push an image using existing credentials</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and push an image using an auth file</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span>
|
||||
<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and push an image using username and password</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bugs</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">vault_registry_password</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and push an image to multiple registries</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span>
|
||||
<span class="w"> </span><span class="nt">loop</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/acme/nginx</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme/nginx</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build and push an image to multiple registries with separate parameters</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.name</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.tag</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/build/dir</span>
|
||||
<span class="w"> </span><span class="nt">push</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">auth_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/auth.json</span>
|
||||
<span class="w"> </span><span class="nt">push_args</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">item.dest</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">loop</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</span>
|
||||
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/acme</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Pull an image for a specific CPU architecture</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">arch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">amd64</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Build a container from file inline</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mycustom_image</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">build</span>
|
||||
<span class="w"> </span><span class="nt">build</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">container_file</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|-</span>
|
||||
<span class="w"> </span><span class="no">FROM alpine:latest</span>
|
||||
<span class="w"> </span><span class="no">CMD echo "Hello, World!"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a quadlet file for an image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/library/alpine:latest</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quadlet</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/containers/systemd</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine-latest</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_file_mode</span><span class="p">:</span><span class="w"> </span><span class="s">'0640'</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Variant=arm/v7</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">|</span>
|
||||
<span class="w"> </span><span class="no">[Install]</span>
|
||||
<span class="w"> </span><span class="no">WantedBy=default.target</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-image-module"></span><section id="containers-podman-podman-image-module">
|
||||
<h1>containers.podman.podman_image module<a class="headerlink" href="#containers-podman-podman-image-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_image, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-image-module-return-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-image" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Image inspection results for the image that was pulled, pushed, or built.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"",</span> <span class="pre">"Config":</span> <span class="pre">{"ArgsEscaped":</span> <span class="pre">true,</span> <span class="pre">"Cmd":</span> <span class="pre">["/bin/sh"],</span> <span class="pre">"Env":</span> <span class="pre">["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"]},</span> <span class="pre">"Created":</span> <span class="pre">"2019-03-07T22:19:53.447205048Z",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:8421d9a84432575381bfabd248f1eb56f3aa21d9d7cd2511583c68c9b7511d10",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"UpperDir":</span> <span class="pre">"/home/user/.local/share/containers/storage/overlay/3fc6.../diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/home/user/.local/share/containers/storage/overlay/3fc6.../work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"History":</span> <span class="pre">[{"created":</span> <span class="pre">"2019-03-07T22:19:53.313789681Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span> <span class="pre">ADD</span> <span class="pre">file:aa17928...</span> <span class="pre">in</span> <span class="pre">/</span> <span class="pre">"},</span> <span class="pre">{"created":</span> <span class="pre">"2019-03-07T22:19:53.447205048Z",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span>  <span class="pre">CMD</span> <span class="pre">[\"/bin/sh\"]",</span> <span class="pre">"empty_layer":</span> <span class="pre">true}],</span> <span class="pre">"Id":</span> <span class="pre">"6d1ef012b5674ad8a127ecfa9b5e6f5178d171b90ee462846974177fd9bdd39f",</span> <span class="pre">"Labels":</span> <span class="pre">null,</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.docker.distribution.manifest.v2+json",</span> <span class="pre">"NamesHistory":</span> <span class="pre">["docker.io/library/alpine:3.7"],</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">["docker.io/library/alpine@sha256:8421...",</span> <span class="pre">"docker.io/library/alpine@sha256:9225..."],</span> <span class="pre">"RepoTags":</span> <span class="pre">["docker.io/library/alpine:3.7"],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:3fc6..."],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">4467084,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"18.06.1-ce",</span> <span class="pre">"VirtualSize":</span> <span class="pre">4467084}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sam Doran (@samdoran)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -630,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_generate_systemd_module.html" title="previous chapter">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li>Next: <a href="podman_image_info_module.html" title="next chapter">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li>Previous: <a href="podman_generate_systemd_module.html" title="previous chapter">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li>Next: <a href="podman_image_info_module.html" title="next chapter">containers.podman.podman_image_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_import module – Import Podman container from a tar file. — Python documentation</title>
|
||||
<title>containers.podman.podman_import module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_load module – Load image from a tar file." href="podman_load_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_image_info module – Gather info about images using podman" href="podman_image_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_load module" href="podman_load_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_image_info module" href="podman_image_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,138 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-import-module"></span><section id="containers-podman-podman-import-module-import-podman-container-from-a-tar-file">
|
||||
<h1>containers.podman.podman_import module – Import Podman container from a tar file.<a class="headerlink" href="#containers-podman-podman-import-module-import-podman-container-from-a-tar-file" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-import-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_import</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>podman import imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) and saves it as a filesystem image.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-import-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-change"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-change"><strong>change</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-change" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set changes as list of key-value pairs, see example.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-commit_message"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-commit-message"><strong>commit_message</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-commit_message" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set commit message for imported image</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-src"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-src"><strong>src</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-src" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to image file to load.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-parameter-volume"><strong>volume</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Volume to import, cannot be used with change and commit_message</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_import</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span>
|
||||
<span class="w"> </span><span class="nt">change</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"CMD"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/bin/bash</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"User"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">root</span>
|
||||
<span class="w"> </span><span class="nt">commit_message</span><span class="p">:</span><span class="w"> </span><span class="s">"Importing</span><span class="nv"> </span><span class="s">image"</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_import</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/tar/file</span>
|
||||
<span class="w"> </span><span class="nt">volume</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myvolume</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-import-module"></span><section id="containers-podman-podman-import-module">
|
||||
<h1>containers.podman.podman_import module<a class="headerlink" href="#containers-podman-podman-import-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_import, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-import-module-return-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-image" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>info from loaded image</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"Annotations":</span> <span class="pre">{},</span> <span class="pre">"Architecture":</span> <span class="pre">"amd64",</span> <span class="pre">"Author":</span> <span class="pre">"",</span> <span class="pre">"Comment":</span> <span class="pre">"imported</span> <span class="pre">from</span> <span class="pre">tarball",</span> <span class="pre">"Config":</span> <span class="pre">{},</span> <span class="pre">"Created":</span> <span class="pre">"2021-09-07T04:45:38.749977105+03:00",</span> <span class="pre">"Digest":</span> <span class="pre">"sha256:8730c75be86a718929a658db4663d487e562d66762....",</span> <span class="pre">"GraphDriver":</span> <span class="pre">{"Data":</span> <span class="pre">{"UpperDir":</span> <span class="pre">"/home/...34/diff",</span> <span class="pre">"WorkDir":</span> <span class="pre">"/home/.../work"},</span> <span class="pre">"Name":</span> <span class="pre">"overlay"},</span> <span class="pre">"History":</span> <span class="pre">[{"comment":</span> <span class="pre">"imported</span> <span class="pre">from</span> <span class="pre">tarball",</span> <span class="pre">"created":</span> <span class="pre">"2021-09-07T04:45:38.749977105+03:00",</span> <span class="pre">"created_by":</span> <span class="pre">"/bin/sh</span> <span class="pre">-c</span> <span class="pre">#(nop)</span> <span class="pre">ADD</span> <span class="pre">file:091...</span> <span class="pre">in</span> <span class="pre">/"}],</span> <span class="pre">"Id":</span> <span class="pre">"cbc6d73c4d232db6e8441df96af81855f62c74157b5db80a1d5...",</span> <span class="pre">"Labels":</span> <span class="pre">null,</span> <span class="pre">"ManifestType":</span> <span class="pre">"application/vnd.oci.image.manifest.v1+json",</span> <span class="pre">"NamesHistory":</span> <span class="pre">null,</span> <span class="pre">"Os":</span> <span class="pre">"linux",</span> <span class="pre">"Parent":</span> <span class="pre">"",</span> <span class="pre">"RepoDigests":</span> <span class="pre">[],</span> <span class="pre">"RepoTags":</span> <span class="pre">[],</span> <span class="pre">"RootFS":</span> <span class="pre">{"Layers":</span> <span class="pre">["sha256:...."],</span> <span class="pre">"Type":</span> <span class="pre">"layers"},</span> <span class="pre">"Size":</span> <span class="pre">5882449,</span> <span class="pre">"User":</span> <span class="pre">"",</span> <span class="pre">"Version":</span> <span class="pre">"",</span> <span class="pre">"VirtualSize":</span> <span class="pre">5882449}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -185,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_image_info_module.html" title="previous chapter">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li>Next: <a href="podman_load_module.html" title="next chapter">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li>Previous: <a href="podman_image_info_module.html" title="previous chapter">containers.podman.podman_image_info module</a></li>
|
||||
<li>Next: <a href="podman_load_module.html" title="next chapter">containers.podman.podman_load module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_login_info module – Return the logged-in user if any for a given registry — Python documentation</title>
|
||||
<title>containers.podman.podman_login_info module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_logout module – Log out of a container registry using podman" href="podman_logout_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_login module – Login to a container registry using podman" href="podman_login_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_logout module" href="podman_logout_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_login module" href="podman_login_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,122 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-login-info-module"></span><section id="containers-podman-podman-login-info-module-return-the-logged-in-user-if-any-for-a-given-registry">
|
||||
<h1>containers.podman.podman_login_info module – Return the logged-in user if any for a given registry<a class="headerlink" href="#containers-podman-podman-login-info-module-return-the-logged-in-user-if-any-for-a-given-registry" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-login-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_login_info</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.0.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Return the logged-in user if any for a given registry.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-login-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-authfile"><strong>authfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-parameter-registry"><strong>registry</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Registry server.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Return the logged-in user for docker hub registry</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Return the logged-in user for quay.io registry</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_login_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-login-info-module"></span><section id="containers-podman-podman-login-info-module">
|
||||
<h1>containers.podman.podman_login_info module<a class="headerlink" href="#containers-podman-podman-login-info-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_login_info, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-login"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-info-module-return-login"><strong>login</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-login" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Logged in user for a registry</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"logged_in":</span> <span class="pre">true,</span> <span class="pre">"registry":</span> <span class="pre">"docker.io",</span> <span class="pre">"username":</span> <span class="pre">"clelange"}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Clemens Lange (@clelange)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -169,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_login_module.html" title="previous chapter">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li>Next: <a href="podman_logout_module.html" title="next chapter">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li>Previous: <a href="podman_login_module.html" title="previous chapter">containers.podman.podman_login module</a></li>
|
||||
<li>Next: <a href="podman_logout_module.html" title="next chapter">containers.podman.podman_logout module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_login module – Login to a container registry using podman — Python documentation</title>
|
||||
<title>containers.podman.podman_login module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_login_info module – Return the logged-in user if any for a given registry" href="podman_login_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_load module – Load image from a tar file." href="podman_load_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_login_info module" href="podman_login_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_load module" href="podman_load_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,149 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-login-module"></span><section id="containers-podman-podman-login-module-login-to-a-container-registry-using-podman">
|
||||
<h1>containers.podman.podman_login module – Login to a container registry using podman<a class="headerlink" href="#containers-podman-podman-login-module-login-to-a-container-registry-using-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-login-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_login</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Login to a container registry server using the podman login command If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-login-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-authfile"><strong>authfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-certdir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-certdir"><strong>certdir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-certdir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-password"><strong>password</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Password for the registry server.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-registry"><strong>registry</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-secret"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-secret"><strong>secret</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-secret" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of an existing <code class="docutils literal notranslate"><span class="pre">podman</span></code> secret to use for authentication to target registry</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tlsverify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-tlsverify"><strong>tlsverify</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tlsverify" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Require HTTPS and verify certificates when contacting registries. If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-login-module-parameter-username"><strong>username</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Username for the registry server.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Login to quay.io and create ${XDG_RUNTIME_DIR}/containers/auth.json</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">'p4ssw0rd'</span>
|
||||
<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Login to quay.io using existing secret called password</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_login</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">user</span>
|
||||
<span class="w"> </span><span class="nt">secret</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-login-module"></span><section id="containers-podman-podman-login-module">
|
||||
<h1>containers.podman.podman_login module<a class="headerlink" href="#containers-podman-podman-login-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_login, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Jason Hiatt (@jthiatt)</p></li>
|
||||
<li><p>Clemens Lange (@clelange)</p></li>
|
||||
<li><p>Michael Fox (@spmfox)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -196,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_load_module.html" title="previous chapter">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li>Next: <a href="podman_login_info_module.html" title="next chapter">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li>Previous: <a href="podman_load_module.html" title="previous chapter">containers.podman.podman_load module</a></li>
|
||||
<li>Next: <a href="podman_login_info_module.html" title="next chapter">containers.podman.podman_login_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_logout module – Log out of a container registry using podman — Python documentation</title>
|
||||
<title>containers.podman.podman_logout module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_network module – Manage podman networks" href="podman_network_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_login_info module – Return the logged-in user if any for a given registry" href="podman_login_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_network module" href="podman_network_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_login_info module" href="podman_login_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,130 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-logout-module"></span><section id="containers-podman-podman-logout-module-log-out-of-a-container-registry-using-podman">
|
||||
<h1>containers.podman.podman_logout module – Log out of a container registry using podman<a class="headerlink" href="#containers-podman-podman-logout-module-log-out-of-a-container-registry-using-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-logout-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_logout</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Log out of a container registry server using the podman logout command by deleting the cached credentials stored in the `auth.json` file. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`. All the cached credentials can be removed by setting the `all` flag. Warning - podman will use credentials in `${HOME}/.docker/config.json` to authenticate in case they are not found in the default `authfile`. However, the logout command will only removed credentials in the `authfile` specified.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-logout-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-all"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-all"><strong>all</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-all" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Remove the cached credentials for all registries in the auth file.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-authfile"><strong>authfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ignore_docker_credentials"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-ignore-docker-credentials"><strong>ignore_docker_credentials</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ignore_docker_credentials" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Credentials created using other tools such as `docker login` are not removed unless the corresponding `authfile` is explicitly specified. Since podman also uses existing credentials in these files by default (for docker e.g. `${HOME}/.docker/config.json`), module execution will fail if a docker login exists for the registry specified in any `authfile` is used by podman. This can be ignored by setting `ignore_docker_credentials` to `true` - the credentials will be kept and `changed` will be false. This option cannot be used together with `all` since in this case podman will not check for existing `authfiles` created by other tools.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-registry"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-logout-module-parameter-registry"><strong>registry</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-registry" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Log out of default registry</span>
|
||||
<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Log out of quay.io</span>
|
||||
<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">registry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Log out of all registries in auth file</span>
|
||||
<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Log out of all registries in specified auth file</span>
|
||||
<span class="w"> </span><span class="nt">podman_logout</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">authfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$HOME/.docker/config.json</span>
|
||||
<span class="w"> </span><span class="nt">all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-logout-module"></span><section id="containers-podman-podman-logout-module">
|
||||
<h1>containers.podman.podman_logout module<a class="headerlink" href="#containers-podman-podman-logout-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_logout, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Clemens Lange (@clelange)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -177,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_login_info_module.html" title="previous chapter">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li>Next: <a href="podman_network_module.html" title="next chapter">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li>Previous: <a href="podman_login_info_module.html" title="previous chapter">containers.podman.podman_login_info module</a></li>
|
||||
<li>Next: <a href="podman_network_module.html" title="next chapter">containers.podman.podman_network module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_network_info module – Gather info about podman networks — Python documentation</title>
|
||||
<title>containers.podman.podman_network_info module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_play module – Play kubernetes YAML file using podman" href="podman_play_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_network module – Manage podman networks" href="podman_network_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_play module" href="podman_play_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_network module" href="podman_network_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,114 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-network-info-module"></span><section id="containers-podman-podman-network-info-module-gather-info-about-podman-networks">
|
||||
<h1>containers.podman.podman_network_info module – Gather info about podman networks<a class="headerlink" href="#containers-podman-podman-network-info-module-gather-info-about-podman-networks" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-network-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_network_info</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.0.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Gather info about podman networks with podman inspect command.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-network-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-info-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-info-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the network</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about all present networks</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_network_info</span><span class="p">:</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about specific network</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_network_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">podman</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-network-info-module"></span><section id="containers-podman-podman-network-info-module">
|
||||
<h1>containers.podman.podman_network_info module<a class="headerlink" href="#containers-podman-podman-network-info-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_network_info, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-networks"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-info-module-return-networks"><strong>networks</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-networks" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Facts from all or specified networks</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"created":</span> <span class="pre">"2024-05-27T21:09:03.486699659+03:00",</span> <span class="pre">"dns_enabled":</span> <span class="pre">false,</span> <span class="pre">"driver":</span> <span class="pre">"macvlan",</span> <span class="pre">"id":</span> <span class="pre">"3227f9785ae4657c022c8da7b0e04d2d124199e66da10a9130437e3c3f0e0e42",</span> <span class="pre">"internal":</span> <span class="pre">false,</span> <span class="pre">"ipam_options":</span> <span class="pre">{"driver":</span> <span class="pre">"host-local"},</span> <span class="pre">"ipv6_enabled":</span> <span class="pre">true,</span> <span class="pre">"name":</span> <span class="pre">"dmz",</span> <span class="pre">"options":</span> <span class="pre">{"no_default_route":</span> <span class="pre">"true"},</span> <span class="pre">"subnets":</span> <span class="pre">[{"gateway":</span> <span class="pre">"10.10.0.1",</span> <span class="pre">"lease_range":</span> <span class="pre">{"end_ip":</span> <span class="pre">"10.10.0.255",</span> <span class="pre">"start_ip":</span> <span class="pre">"10.10.0.249"},</span> <span class="pre">"subnet":</span> <span class="pre">"10.10.0.0/24"},</span> <span class="pre">{"gateway":</span> <span class="pre">"2001:db8:abcd:10::1",</span> <span class="pre">"subnet":</span> <span class="pre">"2001:db8:abcd:10::/64"}]}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -161,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_network_module.html" title="previous chapter">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li>Next: <a href="podman_play_module.html" title="next chapter">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li>Previous: <a href="podman_network_module.html" title="previous chapter">containers.podman.podman_network module</a></li>
|
||||
<li>Next: <a href="podman_play_module.html" title="next chapter">containers.podman.podman_play module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_network module – Manage podman networks — Python documentation</title>
|
||||
<title>containers.podman.podman_network module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_network_info module – Gather info about podman networks" href="podman_network_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_logout module – Log out of a container registry using podman" href="podman_logout_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_network_info module" href="podman_network_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_logout module" href="podman_logout_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,432 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-network-module"></span><section id="containers-podman-podman-network-module-manage-podman-networks">
|
||||
<h1>containers.podman.podman_network module – Manage podman networks<a class="headerlink" href="#containers-podman-podman-network-module-manage-podman-networks" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_network</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.0.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Manage podman networks with podman network command.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-network-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>podman</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-debug"><strong>debug</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Return additional information which can be helpful for investigations.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-disable_dns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-disable-dns"><strong>disable_dns</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-disable_dns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>disable dns plugin (default “false”)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-dns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-dns"><strong>dns</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set network-scoped DNS resolver/nameserver for containers in this network. If not set, the host servers from /etc/resolv.conf is used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-driver"><strong>driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Driver to manage the network (default “bridge”)</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Remove all containers that use the network. If the container is running, it is stopped and removed.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-gateway"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-gateway"><strong>gateway</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-gateway" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>IPv4 or IPv6 gateway for the subnet</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-interface_name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-interface-name"><strong>interface_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>For bridge, it uses the bridge interface name. For macvlan, it is the parent device on the host (it is the same as ‘opt.parent’)</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-internal"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-internal"><strong>internal</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-internal" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Restrict external access from this network (default “false”)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ip_range"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-ip-range"><strong>ip_range</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ip_range" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allocate container IP from range</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ipam_driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-ipam-driver"><strong>ipam_driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ipam_driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the ipam driver (IP Address Management Driver) for the network. When unset podman chooses an ipam driver automatically based on the network driver</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"host-local"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dhcp"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"none"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ipv6"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-ipv6"><strong>ipv6</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ipv6" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Enable IPv6 (Dual Stack) networking. You must pass a IPv6 subnet. The subnet option must be used with the ipv6 option. Idempotency is not supported because it generates subnets randomly.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-macvlan"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-macvlan"><strong>macvlan</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-macvlan" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Create a Macvlan connection based on this device</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the network</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-net_config"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-net-config"><strong>net_config</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-net_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of dictionaries with network configuration. Each dictionary should contain ‘subnet’ and ‘gateway’ keys. ‘ip_range’ is optional.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-net_config/gateway"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-net-config-gateway"><strong>gateway</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-net_config/gateway" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Gateway for the subnet</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-net_config/ip_range"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-net-config-ip-range"><strong>ip_range</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-net_config/ip_range" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Allocate container IP from range</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-net_config/subnet"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-net-config-subnet"><strong>subnet</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-net_config/subnet" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Subnet in CIDR format</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt"><strong>opt</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Add network options. Currently ‘vlan’ and ‘mtu’ are supported.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/bclim"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-bclim"><strong>bclim</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/bclim" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Set the threshold for broadcast queueing. Must be a 32 bit integer. Setting this value to -1 disables broadcast queueing altogether.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/bridge_name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-bridge-name"><strong>bridge_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/bridge_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This option assigns the given name to the created Linux Bridge. Sets ‘com.docker.network.bridge.name’ option.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/driver_mtu"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-driver-mtu"><strong>driver_mtu</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/driver_mtu" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Sets the Maximum Transmission Unit (MTU) and takes an integer value. Sets ‘com.docker.network.driver.mtu’ option.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/isolate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-isolate"><strong>isolate</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/isolate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This option isolates networks by blocking traffic between those that have this option enabled.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/metric"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-metric"><strong>metric</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/metric" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Sets the Route Metric for the default route created in every container joined to this network. Can only be used with the Netavark network backend.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-mode"><strong>mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This option sets the specified ip/macvlan mode on the interface.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/mtu"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-mtu"><strong>mtu</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/mtu" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>MTU size for bridge network interface.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/no_default_route"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-no-default-route"><strong>no_default_route</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/no_default_route" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>If set to 1, Podman will NOT automatically add a default route to subnets.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/parent"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-parent"><strong>parent</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/parent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The host device which should be used for the macvlan interface (it is the same as ‘interface’ in that case). Defaults to the default route interface.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/vlan"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-vlan"><strong>vlan</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/vlan" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>VLAN tag for bridge which enables vlan_filtering.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-opt/vrf"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-opt-vrf"><strong>vrf</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-opt/vrf" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>This option assigns a VRF to the bridge interface. It accepts the name of the VRF and defaults to none. Can only be used with the Netavark network backend.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-quadlet-dir"><strong>quadlet_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the directory to write quadlet file in. By default, it will be set as <code class="docutils literal notranslate"><span class="pre">/etc/containers/systemd/</span></code> for root user, <code class="docutils literal notranslate"><span class="pre">~/.config/containers/systemd/</span></code> for non-root users.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_file_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-quadlet-file-mode"><strong>quadlet_file_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_file_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The permissions of the quadlet file.</p>
|
||||
<p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> can be specied as octal numbers or as a symbolic mode (for example, <code class="ansible-value docutils literal notranslate"><span class="pre">u+rwx</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">u=rw,g=r,o=r</span></code>). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like <code class="ansible-value docutils literal notranslate"><span class="pre">0644</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">01777</span></code>) or quote it (like <code class="ansible-value docutils literal notranslate"><span class="pre">'644'</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">'1777'</span></code>) so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does not</strong> exist, the default <code class="ansible-value docutils literal notranslate"><span class="pre">'0640'</span></code> mask will be used when setting the mode for the newly created file.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does</strong> exist, the mode of the existing file will be used.</p>
|
||||
<p>Specifying <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-network-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is the best way to ensure files are created with the correct permissions.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_filename"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-quadlet-filename"><strong>quadlet_filename</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_filename" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of quadlet file to write. By default it takes <em>name</em> value.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-quadlet-options"><strong>quadlet_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Options for the quadlet file. Provide missing in usual network args options as a list of lines to add.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-recreate"><strong>recreate</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Recreate network even if exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-route"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-route"><strong>route</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-route" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A static route in the format <destination in CIDR notation>,<gateway>,<route metric (optional)>. This route will be added to every container in this network.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>State of network, default ‘present’</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"quadlet"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-subnet"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-parameter-subnet"><strong>subnet</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-subnet" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Subnet in CIDR format</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a podman network</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_network</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">podman_network</span>
|
||||
<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create internal podman network</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_network</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">podman_internal</span>
|
||||
<span class="w"> </span><span class="nt">internal</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">ip_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.128/25</span>
|
||||
<span class="w"> </span><span class="nt">subnet</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.0/24</span>
|
||||
<span class="w"> </span><span class="nt">gateway</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.22.1</span>
|
||||
<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create Quadlet file for podman network</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_network</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">podman_network</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quadlet</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">IPv6=true</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Label="ipv6 network"</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-network-module"></span><section id="containers-podman-podman-network-module">
|
||||
<h1>containers.podman.podman_network module<a class="headerlink" href="#containers-podman-podman-network-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_network, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-network-module-return-network"><strong>network</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-network" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Facts from created or updated networks</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"created":</span> <span class="pre">"2024-07-13T15:43:36.548472483+03:00",</span> <span class="pre">"dns_enabled":</span> <span class="pre">true,</span> <span class="pre">"driver":</span> <span class="pre">"bridge",</span> <span class="pre">"id":</span> <span class="pre">"3f46dc2626fe082b1ec703bc74d048765c1110c9eab7d61e33344e212279402c",</span> <span class="pre">"internal":</span> <span class="pre">false,</span> <span class="pre">"ipam_options":</span> <span class="pre">{"driver":</span> <span class="pre">"host-local"},</span> <span class="pre">"ipv6_enabled":</span> <span class="pre">false,</span> <span class="pre">"name":</span> <span class="pre">"virtuals",</span> <span class="pre">"network_interface":</span> <span class="pre">"podman2",</span> <span class="pre">"subnets":</span> <span class="pre">[{"gateway":</span> <span class="pre">"10.99.99.1",</span> <span class="pre">"subnet":</span> <span class="pre">"10.99.99.0/24"}]}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -479,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_logout_module.html" title="previous chapter">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li>Next: <a href="podman_network_info_module.html" title="next chapter">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li>Previous: <a href="podman_logout_module.html" title="previous chapter">containers.podman.podman_logout module</a></li>
|
||||
<li>Next: <a href="podman_network_info_module.html" title="next chapter">containers.podman.podman_network_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_play module – Play kubernetes YAML file using podman — Python documentation</title>
|
||||
<title>containers.podman.podman_play module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_pod module – Manage Podman pods" href="podman_pod_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_network_info module – Gather info about podman networks" href="podman_network_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_pod module" href="podman_pod_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_network_info module" href="podman_network_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,357 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-play-module"></span><section id="containers-podman-podman-play-module-play-kubernetes-yaml-file-using-podman">
|
||||
<h1>containers.podman.podman_play module – Play kubernetes YAML file using podman<a class="headerlink" href="#containers-podman-podman-play-module-play-kubernetes-yaml-file-using-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_play</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>The module reads in a structured file of Kubernetes YAML. It will then recreate the pod and containers described in the YAML.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-play-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-annotation"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-annotations"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-annotations"><span id="ansible-collections-containers-podman-podman-play-module-parameter-annotation"></span><strong>annotation</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-annotation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: annotations</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Add an annotation to the container or pod.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-authfile"><strong>authfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json, which is set using podman login. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using docker login. Note - You can also override the default path of the authentication file by setting the REGISTRY_AUTH_FILE environment variable. export REGISTRY_AUTH_FILE=path</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-build"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-build"><strong>build</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-build" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Build images even if they are found in the local storage.</p>
|
||||
<p>It is required to exist subdirectories matching the image names to be build.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-cert_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-cert-dir"><strong>cert_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-cert_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d. (This option is not available with the remote Podman client)</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-configmap"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-configmap"><strong>configmap</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-configmap" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. Note - The configmap option can be used multiple times to pass multiple Kubernetes configmap YAMLs</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-context_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-context-dir"><strong>context_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-context_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use path as the build context directory for each image. Requires build option be true.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-debug"><strong>debug</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Enable debug for the module.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of executable to run, by default ‘podman’</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kube_file"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-kube-file"><strong>kube_file</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-kube_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to file with YAML configuration for a Pod.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kube_file_content"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-kube-file-content"><strong>kube_file_content</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-kube_file_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the kube file.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-driver"><strong>log_driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set logging driver for all created containers.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_level"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-level"><strong>log_level</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set logging level for podman calls. Log messages above specified level (“debug”|”info”|”warn”|”error”|”fatal”|”panic”) (default “error”)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"debug"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"info"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"warn"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"error"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"fatal"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"panic"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_opt"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt"></span><strong>log_opt</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_opt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: log_options</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Logging driver specific options. Set custom logging configuration.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_opt/max_size"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_options/max_size"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-max-size"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-max-size"></span><strong>max_size</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_opt/max_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a max size of the log file (e.g 10mb).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_opt/path"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_options/path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-path"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-path"></span><strong>path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_opt/path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>specify a path to the log file (e.g. /var/log/container/mycontainer.json).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_opt/tag"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_options/tag"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-log-options-tag"><span id="ansible-collections-containers-podman-podman-play-module-parameter-log-opt-tag"></span><strong>tag</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_opt/tag" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify a custom log tag for the container. This option is currently supported only by the journald log driver in Podman.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-network"><strong>network</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of the names of CNI networks the pod should join.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-password"><strong>password</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The username and password to use to authenticate with the registry if required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quadlet-dir"><strong>quadlet_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the directory to write quadlet file in. By default, it will be set as <code class="docutils literal notranslate"><span class="pre">/etc/containers/systemd/</span></code> for root user, <code class="docutils literal notranslate"><span class="pre">~/.config/containers/systemd/</span></code> for non-root users.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_file_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quadlet-file-mode"><strong>quadlet_file_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_file_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The permissions of the quadlet file.</p>
|
||||
<p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> can be specied as octal numbers or as a symbolic mode (for example, <code class="ansible-value docutils literal notranslate"><span class="pre">u+rwx</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">u=rw,g=r,o=r</span></code>). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like <code class="ansible-value docutils literal notranslate"><span class="pre">0644</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">01777</span></code>) or quote it (like <code class="ansible-value docutils literal notranslate"><span class="pre">'644'</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">'1777'</span></code>) so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does not</strong> exist, the default <code class="ansible-value docutils literal notranslate"><span class="pre">'0640'</span></code> mask will be used when setting the mode for the newly created file.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does</strong> exist, the mode of the existing file will be used.</p>
|
||||
<p>Specifying <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-play-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is the best way to ensure files are created with the correct permissions.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_filename"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quadlet-filename"><strong>quadlet_filename</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_filename" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of quadlet file to write. Must be specified if state is quadlet.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quadlet-options"><strong>quadlet_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Options for the quadlet file. Provide missing in usual network args options as a list of lines to add.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quiet"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-quiet"><strong>quiet</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quiet" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Hide image pulls logs from output.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-recreate"><strong>recreate</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If pod already exists, delete it and run the new one.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-seccomp_profile_root"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-seccomp-profile-root"><strong>seccomp_profile_root</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-seccomp_profile_root" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Directory path for seccomp profiles (default is “/var/lib/kubelet/seccomp”). This option is not available with the remote Podman client</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Start the pod after creating it, or to leave it created only.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"created"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"started"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"quadlet"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-tls-verify"><strong>tls_verify</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tls_verify" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Require HTTPS and verify certificates when contacting registries (default is true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-username"><strong>username</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The username and password to use to authenticate with the registry if required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-userns"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-play-module-parameter-userns"><strong>userns</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-userns" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the user namespace mode for all the containers in a pod. It defaults to the PODMAN_USERNS environment variable. An empty value (“”) means user namespaces are disabled.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Play kube file</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Recreate pod from a kube file with options</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">recreate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">greeting</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hello</span>
|
||||
<span class="w"> </span><span class="nt">greet_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">world</span>
|
||||
<span class="w"> </span><span class="nt">userns</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">host</span>
|
||||
<span class="w"> </span><span class="nt">log_opt</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/my-container.log</span>
|
||||
<span class="w"> </span><span class="nt">max_size</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10mb</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Quadlet file</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_play</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">kube_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/kube.yaml</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quadlet</span>
|
||||
<span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">greeting</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hello</span>
|
||||
<span class="w"> </span><span class="nt">greet_to</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">world</span>
|
||||
<span class="w"> </span><span class="nt">userns</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">host</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kube-pod</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_file_mode</span><span class="p">:</span><span class="w"> </span><span class="s">'0640'</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"SetWorkingDirectory=yaml"</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"ExitCodePropagation=any"</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-play-module"></span><section id="containers-podman-podman-play-module">
|
||||
<h1>containers.podman.podman_play module<a class="headerlink" href="#containers-podman-podman-play-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_play, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -404,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_network_info_module.html" title="previous chapter">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li>Next: <a href="podman_pod_module.html" title="next chapter">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li>Previous: <a href="podman_network_info_module.html" title="previous chapter">containers.podman.podman_network_info module</a></li>
|
||||
<li>Next: <a href="podman_pod_module.html" title="next chapter">containers.podman.podman_pod module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_prune module – Allows to prune various podman objects — Python documentation</title>
|
||||
<title>containers.podman.podman_prune module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_runlabel module – Run given label from given image" href="podman_runlabel_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_pod_info module – Gather info about podman pods" href="podman_pod_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_quadlet module" href="podman_quadlet_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_pod_info module" href="podman_pod_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,271 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-prune-module"></span><section id="containers-podman-podman-prune-module-allows-to-prune-various-podman-objects">
|
||||
<h1>containers.podman.podman_prune module – Allows to prune various podman objects<a class="headerlink" href="#containers-podman-podman-prune-module-allows-to-prune-various-podman-objects" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-prune-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_prune</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.10.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Allows to run <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">container</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">image</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">network</span> <span class="pre">prune</span></code>, <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">volume</span> <span class="pre">prune</span></code> and <code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">system</span> <span class="pre">prune</span></code></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-prune-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-container"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-container"><strong>container</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-container" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune containers.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-container_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-container-filters"><strong>container_filters</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-container_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting containers to delete.</p>
|
||||
<p>For example, <code class="docutils literal notranslate"><span class="pre">until:</span> <span class="pre">24h</span></code>.</p>
|
||||
<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-container-prune.1.html#filter-filters">the podman documentation</a> for more information on possible filters.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Podman binary.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune images.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-image-filters"><strong>image_filters</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting images to delete.</p>
|
||||
<p>You can also use <code class="docutils literal notranslate"><span class="pre">dangling_only:</span> <span class="pre">false</span></code> to delete dangling and non-dangling images or <code class="docutils literal notranslate"><span class="pre">external:</span> <span class="pre">true</span></code> to delete images even when they are used by external containers.</p>
|
||||
<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-image-prune.1.html#filter-filters">the podman documentation</a> for more information on possible filters.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-network"><strong>network</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune networks.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-network-filters"><strong>network_filters</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-network_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting networks to delete.</p>
|
||||
<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-network-prune.1.html#filter">the podman documentation</a> for more information on possible filters.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-system"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system"><strong>system</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-system" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune unused pods, containers, image, networks and volume data</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-system_all"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system-all"><strong>system_all</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-system_all" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune all unused images, not only dangling images.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-system_volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-system-volumes"><strong>system_volumes</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-system_volumes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune volumes currently unused by any container.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-volume"><strong>volume</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to prune volumes.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volume_filters"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-parameter-volume-filters"><strong>volume_filters</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volume_filters" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A dictionary of filter values used for selecting volumes to delete.</p>
|
||||
<p>See <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-volume-prune.1.html#filter">the podman documentation</a> for more information on possible filters.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Prune containers older than 24h</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">containers_filters</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># only consider containers created more than 24 hours ago</span>
|
||||
<span class="w"> </span><span class="nt">until</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">24h</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Prune everything</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">system</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Prune everything (including non-dangling images)</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_prune</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">system</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">system_all</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">system_volumes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-prune-module"></span><section id="containers-podman-podman-prune-module">
|
||||
<h1>containers.podman.podman_prune module<a class="headerlink" href="#containers-podman-podman-prune-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_prune, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-containers"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-containers"><strong>containers</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-containers" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of IDs of deleted containers.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>containers</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-images"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-images"><strong>images</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-images" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of IDs of deleted images.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>images</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-networks"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-networks"><strong>networks</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-networks" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of IDs of deleted networks.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>networks</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-system"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-system"><strong>system</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-system" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of ID of deleted containers, volumes, images, network and total reclaimed space</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>system</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-prune-module-return-volumes"><strong>volumes</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-volumes" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of IDs of deleted volumes.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> <em>volumes</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Roberto Alfieri (@rebtoor)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -318,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_pod_info_module.html" title="previous chapter">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li>Next: <a href="podman_runlabel_module.html" title="next chapter">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li>Previous: <a href="podman_pod_info_module.html" title="previous chapter">containers.podman.podman_pod_info module</a></li>
|
||||
<li>Next: <a href="podman_quadlet_module.html" title="next chapter">containers.podman.podman_quadlet module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_runlabel module – Run given label from given image — Python documentation</title>
|
||||
<title>containers.podman.podman_runlabel module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_save module – Saves podman image to tar file" href="podman_save_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_prune module – Allows to prune various podman objects" href="podman_prune_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_save module" href="podman_save_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_quadlet_info module" href="podman_quadlet_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,95 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-runlabel-module"></span><section id="containers-podman-podman-runlabel-module-run-given-label-from-given-image">
|
||||
<h1>containers.podman.podman_runlabel module – Run given label from given image<a class="headerlink" href="#containers-podman-podman-runlabel-module-run-given-label-from-given-image" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-runlabel-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_runlabel</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>podman container runlabel runs selected label from given image</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-runlabel-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Image to get the label from.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-label"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-runlabel-module-parameter-label"><strong>label</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Label to run.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_runlabel</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/continuumio/miniconda3</span>
|
||||
<span class="w"> </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INSTALL</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-runlabel-module"></span><section id="containers-podman-podman-runlabel-module">
|
||||
<h1>containers.podman.podman_runlabel module<a class="headerlink" href="#containers-podman-podman-runlabel-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_runlabel, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Pavel Dostal (@pdostal)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -142,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_prune_module.html" title="previous chapter">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li>Next: <a href="podman_save_module.html" title="next chapter">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li>Previous: <a href="podman_quadlet_info_module.html" title="previous chapter">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li>Next: <a href="podman_save_module.html" title="next chapter">containers.podman.podman_save module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_save module – Saves podman image to tar file — Python documentation</title>
|
||||
<title>containers.podman.podman_save module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_search module – Search for remote images using podman" href="podman_search_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_runlabel module – Run given label from given image" href="podman_runlabel_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_search module" href="podman_search_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_runlabel module" href="podman_runlabel_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,153 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-save-module"></span><section id="containers-podman-podman-save-module-saves-podman-image-to-tar-file">
|
||||
<h1>containers.podman.podman_save module – Saves podman image to tar file<a class="headerlink" href="#containers-podman-podman-save-module-saves-podman-image-to-tar-file" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-save-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_save</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>podman save saves an image to either docker-archive, oci-archive, oci-dir (directory with oci manifest type), or docker-dir (directory with v2s2 manifest type) on the local machine, default is docker-archive.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-save-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-compress"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-compress"><strong>compress</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-compress" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Compress tarball image layers when pushing to a directory using the ‘dir’ transport. (default is same compression type, compressed or uncompressed, as source)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-dest"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-path"><span id="ansible-collections-containers-podman-podman-save-module-parameter-dest"></span><strong>dest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dest" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: path</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Destination file to write image to.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Force saving to file even if it exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-format"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-format"><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Save image to docker-archive, oci-archive (see containers-transports(5)), oci-dir (oci transport), or docker-dir (dir transport with v2s2 manifest type).</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-archive"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-archive"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"oci-dir"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"docker-dir"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Image to save.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-multi_image_archive"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-save-module-parameter-multi-image-archive"><strong>multi_image_archive</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-multi_image_archive" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for docker-archive.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_save</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/file123.tar</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_save</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fedora</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/tmp/file456.tar</span>
|
||||
<span class="w"> </span><span class="nt">multi_image_archive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-save-module"></span><section id="containers-podman-podman-save-module">
|
||||
<h1>containers.podman.podman_save module<a class="headerlink" href="#containers-podman-podman-save-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_save, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -200,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_runlabel_module.html" title="previous chapter">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li>Next: <a href="podman_search_module.html" title="next chapter">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li>Previous: <a href="podman_runlabel_module.html" title="previous chapter">containers.podman.podman_runlabel module</a></li>
|
||||
<li>Next: <a href="podman_search_module.html" title="next chapter">containers.podman.podman_search module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_search module – Search for remote images using podman — Python documentation</title>
|
||||
<title>containers.podman.podman_search module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_secret module – Manage podman secrets" href="podman_secret_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_save module – Saves podman image to tar file" href="podman_save_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_secret module" href="podman_secret_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_save module" href="podman_save_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,140 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-search-module"></span><section id="containers-podman-podman-search-module-search-for-remote-images-using-podman">
|
||||
<h1>containers.podman.podman_search module – Search for remote images using podman<a class="headerlink" href="#containers-podman-podman-search-module-search-for-remote-images-using-podman" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_search</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id3">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Search for remote images using <code class="docutils literal notranslate"><span class="pre">podman</span></code></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-search-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-limit"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-search-module-parameter-limit"><strong>limit</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-limit" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Limit the number of image results returned from the search (per image registry)</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">25</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-list_tags"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-search-module-parameter-list-tags"><strong>list_tags</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-list_tags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether or not to return the list of tags associated with each image</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-term"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-search-module-parameter-term"><strong>term</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-term" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The search term to look for. Will search all default registries unless a registry is defined in the search term.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman may required elevated privileges in order to run properly.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Search for any rhel images</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_search</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">term</span><span class="p">:</span><span class="w"> </span><span class="s">"rhel"</span>
|
||||
<span class="w"> </span><span class="nt">limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info on a specific remote image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_search</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">term</span><span class="p">:</span><span class="w"> </span><span class="s">"myimageregistry.com/ansible-automation-platform/ee-minimal-rhel8"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather tag info on a known remote image</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_search</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">term</span><span class="p">:</span><span class="w"> </span><span class="s">"myimageregistry.com/ansible-automation-platform/ee-minimal-rhel8"</span>
|
||||
<span class="w"> </span><span class="nt">list_tags</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-search-module"></span><section id="containers-podman-podman-search-module">
|
||||
<h1>containers.podman.podman_search module<a class="headerlink" href="#containers-podman-podman-search-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_search, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-images"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-search-module-return-images"><strong>images</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-images" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>info from all or specified images</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"Automated":</span> <span class="pre">"",</span> <span class="pre">"Description":</span> <span class="pre">"Red</span> <span class="pre">Hat</span> <span class="pre">Enterprise</span> <span class="pre">Linux</span> <span class="pre">Atomic</span> <span class="pre">Image</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">minimal,</span> <span class="pre">fully</span> <span class="pre">supported</span> <span class="pre">base</span> <span class="pre">image.",</span> <span class="pre">"Index":</span> <span class="pre">"registry.access.redhat.com",</span> <span class="pre">"Name":</span> <span class="pre">"registry.access.redhat.com/rhel7-atomic",</span> <span class="pre">"Official":</span> <span class="pre">"",</span> <span class="pre">"Stars":</span> <span class="pre">0,</span> <span class="pre">"Tags":</span> <span class="pre">["1.0",</span> <span class="pre">"1.1",</span> <span class="pre">"1.1.1-devel"]}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Derek Waters (@derekwaters)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -187,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_save_module.html" title="previous chapter">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li>Next: <a href="podman_secret_module.html" title="next chapter">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li>Previous: <a href="podman_save_module.html" title="previous chapter">containers.podman.podman_save module</a></li>
|
||||
<li>Next: <a href="podman_secret_module.html" title="next chapter">containers.podman.podman_secret module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_secret_info module – Gather info about podman secrets — Python documentation</title>
|
||||
<title>containers.podman.podman_secret_info module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_tag module – Add an additional name to a local image" href="podman_tag_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_secret module – Manage podman secrets" href="podman_secret_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_system_info module" href="podman_system_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_secret module" href="podman_secret_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,125 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-secret-info-module"></span><section id="containers-podman-podman-secret-info-module-gather-info-about-podman-secrets">
|
||||
<h1>containers.podman.podman_secret_info module – Gather info about podman secrets<a class="headerlink" href="#containers-podman-podman-secret-info-module-gather-info-about-podman-secrets" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-secret-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_secret_info</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Gather info about podman secrets with podman inspect command.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-secret-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the secret</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-showsecret"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-parameter-showsecret"><strong>showsecret</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-showsecret" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Show secret data value</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about all present secrets</span>
|
||||
<span class="w"> </span><span class="nt">podman_secret_info</span><span class="p">:</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about specific secret</span>
|
||||
<span class="w"> </span><span class="nt">podman_secret_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">specific_secret</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-secret-info-module"></span><section id="containers-podman-podman-secret-info-module">
|
||||
<h1>containers.podman.podman_secret_info module<a class="headerlink" href="#containers-podman-podman-secret-info-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_secret_info, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-secrets"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-info-module-return-secrets"><strong>secrets</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-secrets" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Facts from all or specified secrets</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"CreatedAt":</span> <span class="pre">"2024-01-28T20:32:08.31857841+02:00",</span> <span class="pre">"ID":</span> <span class="pre">"06068c676e9a7f1c7dc0da8dd",</span> <span class="pre">"Spec":</span> <span class="pre">{"Driver":</span> <span class="pre">{"Name":</span> <span class="pre">"file",</span> <span class="pre">"Options":</span> <span class="pre">{"path":</span> <span class="pre">"/home/user/.local/share/containers/storage/secrets/filedriver"}},</span> <span class="pre">"Labels":</span> <span class="pre">{},</span> <span class="pre">"Name":</span> <span class="pre">"secret_name"},</span> <span class="pre">"UpdatedAt":</span> <span class="pre">"2024-01-28T20:32:08.31857841+02:00"}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -172,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_secret_module.html" title="previous chapter">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li>Next: <a href="podman_tag_module.html" title="next chapter">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li>Previous: <a href="podman_secret_module.html" title="previous chapter">containers.podman.podman_secret module</a></li>
|
||||
<li>Next: <a href="podman_system_info_module.html" title="next chapter">containers.podman.podman_system_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_secret module – Manage podman secrets — Python documentation</title>
|
||||
<title>containers.podman.podman_secret module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_secret_info module – Gather info about podman secrets" href="podman_secret_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_search module – Search for remote images using podman" href="podman_search_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_secret_info module" href="podman_secret_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_search module" href="podman_search_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,199 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-secret-module"></span><section id="containers-podman-podman-secret-module-manage-podman-secrets">
|
||||
<h1>containers.podman.podman_secret module – Manage podman secrets<a class="headerlink" href="#containers-podman-podman-secret-module-manage-podman-secrets" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-secret-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_secret</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.7.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Manage podman secrets</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-secret-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>podman</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-data"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-data"><strong>data</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-data" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The value of the secret. Required when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code>. Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">env</span></code> and <code class="docutils literal notranslate"><span class="pre">path</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-debug"><strong>debug</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Enable debug mode for module. It prints secrets diff.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-driver"><strong>driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Override default secrets driver, currently podman uses <code class="docutils literal notranslate"><span class="pre">file</span></code> which is unencrypted.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-driver_opts"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-driver-opts"><strong>driver_opts</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-driver_opts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Driver-specific key-value options.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-env"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-env"><strong>env</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The name of the environment variable that contains the secret. Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">data</span></code> and <code class="docutils literal notranslate"><span class="pre">path</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use it when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code> to remove and recreate an existing secret.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-labels"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-labels"><strong>labels</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-labels" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Labels to set on the secret.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The name of the secret.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-path"><strong>path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the file that contains the secret. Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">data</span></code> and <code class="docutils literal notranslate"><span class="pre">env</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-skip_existing"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-skip-existing"><strong>skip_existing</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-skip_existing" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use it when <code class="docutils literal notranslate"><span class="pre">state</span></code> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and secret with the same name already exists. If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the secret will NOT be recreated and remains as is.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-secret-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to create or remove the named secret.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create secret</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span>
|
||||
<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"> </span><span class="s">"my</span><span class="nv"> </span><span class="s">super</span><span class="nv"> </span><span class="s">secret</span><span class="nv"> </span><span class="s">content"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create container that uses the secret</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">showmysecret</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/alpine:3.14</span>
|
||||
<span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span>
|
||||
<span class="w"> </span><span class="nt">detach</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cat /run/secrets/mysecret</span>
|
||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">container</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Output secret data</span>
|
||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="cp">{{</span> <span class="nv">container.stdout</span> <span class="cp">}}</span><span class="s">'</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Remove secret</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysecret</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-secret-module"></span><section id="containers-podman-podman-secret-module">
|
||||
<h1>containers.podman.podman_secret module<a class="headerlink" href="#containers-podman-podman-secret-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_secret, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Aliaksandr Mianzhynski (@amenzhinsky)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -246,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_search_module.html" title="previous chapter">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li>Next: <a href="podman_secret_info_module.html" title="next chapter">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li>Previous: <a href="podman_search_module.html" title="previous chapter">containers.podman.podman_search module</a></li>
|
||||
<li>Next: <a href="podman_secret_info_module.html" title="next chapter">containers.podman.podman_secret_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_tag module – Add an additional name to a local image — Python documentation</title>
|
||||
<title>containers.podman.podman_tag module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_volume module – Manage Podman volumes" href="podman_volume_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_secret_info module – Gather info about podman secrets" href="podman_secret_info_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_volume module" href="podman_volume_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_system_info module" href="podman_system_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,97 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-tag-module"></span><section id="containers-podman-podman-tag-module-add-an-additional-name-to-a-local-image">
|
||||
<h1>containers.podman.podman_tag module – Add an additional name to a local image<a class="headerlink" href="#containers-podman-podman-tag-module-add-an-additional-name-to-a-local-image" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-tag-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_tag</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>podman tag adds one or more additional names to locally-stored image.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-tag-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Image to tag.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-target_names"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-tag-module-parameter-target-names"><strong>target_names</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-target_names" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Additional names.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">containers.podman.podman_tag</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker.io/continuumio/miniconda3</span>
|
||||
<span class="w"> </span><span class="nt">target_names</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda3</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">miniconda</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-tag-module"></span><section id="containers-podman-podman-tag-module">
|
||||
<h1>containers.podman.podman_tag module<a class="headerlink" href="#containers-podman-podman-tag-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_tag, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Christian Bourque (@ocafebabe)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -144,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_secret_info_module.html" title="previous chapter">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li>Next: <a href="podman_volume_module.html" title="next chapter">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li>Previous: <a href="podman_system_info_module.html" title="previous chapter">containers.podman.podman_system_info module</a></li>
|
||||
<li>Next: <a href="podman_volume_module.html" title="next chapter">containers.podman.podman_volume module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_unshare become – Run tasks using podman unshare — Python documentation</title>
|
||||
<title>containers.podman.podman_unshare become — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.buildah connection – Interact with an existing buildah container" href="buildah_connection.html" />
|
||||
<link rel="prev" title="containers.podman.podman_volume_info module – Gather info about podman volumes" href="podman_volume_info_module.html" />
|
||||
<link rel="next" title="containers.podman.buildah connection" href="buildah_connection.html" />
|
||||
<link rel="prev" title="containers.podman.podman_volume_info module" href="podman_volume_info_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,186 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-unshare-become"></span><section id="containers-podman-podman-unshare-become-run-tasks-using-podman-unshare">
|
||||
<h1>containers.podman.podman_unshare become – Run tasks using podman unshare<a class="headerlink" href="#containers-podman-podman-unshare-become-run-tasks-using-podman-unshare" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This become plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_unshare</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.9.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>This become plugins allows your remote/login user to execute commands in its container user namespace. Official documentation: <a class="reference external" href="https://docs.podman.io/en/latest/markdown/podman-unshare.1.html">https://docs.podman.io/en/latest/markdown/podman-unshare.1.html</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-become_exe"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-exe"><strong>become_exe</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-become_exe" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Sudo executable</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sudo"</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-unshare-become"></span><section id="containers-podman-podman-unshare-become">
|
||||
<h1>containers.podman.podman_unshare become<a class="headerlink" href="#containers-podman-podman-unshare-become" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the become plugin, containers.podman.podman_unshare, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><p>INI entries:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">privilege_escalation</span><span class="p">]</span>
|
||||
<span class="n">become_exe</span> <span class="o">=</span> <span class="n">sudo</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span>
|
||||
<span class="n">executable</span> <span class="o">=</span> <span class="n">sudo</span>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">PluginDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_EXE</span></code></p></li>
|
||||
<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_EXE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_EXE</span></code></a></p></li>
|
||||
<li><p>Variable: ansible_become_exe</p></li>
|
||||
<li><p>Variable: ansible_sudo_exe</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-become_pass"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-pass"><strong>become_pass</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-become_pass" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Password to pass to sudo</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul>
|
||||
<li><p>INI entry:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span>
|
||||
<span class="n">password</span> <span class="o">=</span> <span class="n">VALUE</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-2"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_BECOME_PASS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_PASS</span></code></a></p></li>
|
||||
<li><p>Environment variable: <span class="target" id="index-3"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_PASS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_PASS</span></code></a></p></li>
|
||||
<li><p>Variable: ansible_become_password</p></li>
|
||||
<li><p>Variable: ansible_become_pass</p></li>
|
||||
<li><p>Variable: ansible_sudo_pass</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-become_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-unshare-become-parameter-become-user"><strong>become_user</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-become_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>User you ‘become’ to execute the task (‘root’ is not a valid value here).</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
|
||||
<ul>
|
||||
<li><p>INI entries:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">privilege_escalation</span><span class="p">]</span>
|
||||
<span class="n">become_user</span> <span class="o">=</span> <span class="n">VALUE</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sudo_become_plugin</span><span class="p">]</span>
|
||||
<span class="n">user</span> <span class="o">=</span> <span class="n">VALUE</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Environment variable: <span class="target" id="index-4"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_BECOME_USER</span></code></p></li>
|
||||
<li><p>Environment variable: <span class="target" id="index-5"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SUDO_USER"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SUDO_USER</span></code></a></p></li>
|
||||
<li><p>Variable: ansible_become_user</p></li>
|
||||
<li><p>Variable: ansible_sudo_user</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">checking uid of file 'foo'</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.stat</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span>
|
||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo.stat.uid</span>
|
||||
<span class="c1"># The output shows that it's owned by the login user</span>
|
||||
<span class="c1"># ok: [test_host] => {</span>
|
||||
<span class="c1"># "foo.stat.uid": "1003"</span>
|
||||
<span class="c1"># }</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mounting the file to an unprivileged container and modifying its owner</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chmod_foo</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">alpine</span>
|
||||
<span class="w"> </span><span class="nt">rm</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">volume</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">:/opt/test:z"</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chown 1000 /opt/test/foo</span>
|
||||
|
||||
<span class="c1"># Now the file 'foo' is owned by the container uid 1000,</span>
|
||||
<span class="c1"># which is mapped to something completaly different on the host.</span>
|
||||
<span class="c1"># It creates a situation when the file is unaccessible to the host user (uid 1003)</span>
|
||||
<span class="c1"># Running stat again, debug output will be like this:</span>
|
||||
<span class="c1"># ok: [test_host] => {</span>
|
||||
<span class="c1"># "foo.stat.uid": "328679"</span>
|
||||
<span class="c1"># }</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">running stat in modified user namespace</span>
|
||||
<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span>
|
||||
<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.stat</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span>
|
||||
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
|
||||
<span class="c1"># By gathering file stats with podman_ushare</span>
|
||||
<span class="c1"># we can see the uid set in the container:</span>
|
||||
<span class="c1"># ok: [test_host] => {</span>
|
||||
<span class="c1"># "foo.stat.uid": "1000"</span>
|
||||
<span class="c1"># }</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">resetting file ownership with podman unshare</span>
|
||||
<span class="w"> </span><span class="nt">become_method</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">containers.podman.podman_unshare</span>
|
||||
<span class="w"> </span><span class="nt">become</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.file</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">file</span>
|
||||
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">test_dir</span> <span class="cp">}}</span><span class="s">/foo"</span>
|
||||
<span class="w"> </span><span class="nt">owner</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span><span class="w"> </span><span class="c1"># in a modified user namespace host uid is mapped to 0</span>
|
||||
<span class="c1"># If we run stat and debug with 'become: false',</span>
|
||||
<span class="c1"># we can see that the file is ours again:</span>
|
||||
<span class="c1"># ok: [test_host] => {</span>
|
||||
<span class="c1"># "foo.stat.uid": "1003"</span>
|
||||
<span class="c1"># }</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Janos Gerzson (@grzs)</p></li>
|
||||
</ul>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -233,49 +66,56 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_volume_info_module.html" title="previous chapter">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li>Next: <a href="buildah_connection.html" title="next chapter">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li>Previous: <a href="podman_volume_info_module.html" title="previous chapter">containers.podman.podman_volume_info module</a></li>
|
||||
<li>Next: <a href="buildah_connection.html" title="next chapter">containers.podman.buildah connection</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_volume_info module – Gather info about podman volumes — Python documentation</title>
|
||||
<title>containers.podman.podman_volume_info module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_unshare become – Run tasks using podman unshare" href="podman_unshare_become.html" />
|
||||
<link rel="prev" title="containers.podman.podman_volume module – Manage Podman volumes" href="podman_volume_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_unshare become" href="podman_unshare_become.html" />
|
||||
<link rel="prev" title="containers.podman.podman_volume module" href="podman_volume_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,113 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-volume-info-module"></span><section id="containers-podman-podman-volume-info-module-gather-info-about-podman-volumes">
|
||||
<h1>containers.podman.podman_volume_info module – Gather info about podman volumes<a class="headerlink" href="#containers-podman-podman-volume-info-module-gather-info-about-podman-volumes" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_volume_info</span></code>.</p>
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Gather info about podman volumes with podman inspect command.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-volume-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Podman installed on host</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-info-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-info-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the volume</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about all present volumes</span>
|
||||
<span class="w"> </span><span class="nt">podman_volume_info</span><span class="p">:</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Gather info about specific volume</span>
|
||||
<span class="w"> </span><span class="nt">podman_volume_info</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">specific_volume</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-volume-info-module"></span><section id="containers-podman-podman-volume-info-module">
|
||||
<h1>containers.podman.podman_volume_info module<a class="headerlink" href="#containers-podman-podman-volume-info-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_volume_info, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-volumes"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-info-module-return-volumes"><strong>volumes</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-volumes" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Facts from all or specified volumes</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{"CreatedAt":</span> <span class="pre">"2023-11-30T16:41:31.310865559+02:00",</span> <span class="pre">"Driver":</span> <span class="pre">"local",</span> <span class="pre">"Labels":</span> <span class="pre">{},</span> <span class="pre">"LockNumber":</span> <span class="pre">18,</span> <span class="pre">"MountCount":</span> <span class="pre">0,</span> <span class="pre">"Mountpoint":</span> <span class="pre">"/home/user/.local/share/containers/storage/volumes/postgres9/_data",</span> <span class="pre">"Name":</span> <span class="pre">"postgres9",</span> <span class="pre">"NeedsChown":</span> <span class="pre">true,</span> <span class="pre">"NeedsCopyUp":</span> <span class="pre">true,</span> <span class="pre">"Options":</span> <span class="pre">{},</span> <span class="pre">"Scope":</span> <span class="pre">"local"}]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -160,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_volume_module.html" title="previous chapter">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li>Next: <a href="podman_unshare_become.html" title="next chapter">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li>Previous: <a href="podman_volume_module.html" title="previous chapter">containers.podman.podman_volume module</a></li>
|
||||
<li>Next: <a href="podman_unshare_become.html" title="next chapter">containers.podman.podman_unshare become</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
<meta content="2.5.0" name="antsibull-docs" />
|
||||
|
||||
<title>containers.podman.podman_volume module – Manage Podman volumes — Python documentation</title>
|
||||
<title>containers.podman.podman_volume module — Python documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
|
|
@ -15,8 +15,8 @@
|
|||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="containers.podman.podman_volume_info module – Gather info about podman volumes" href="podman_volume_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_tag module – Add an additional name to a local image" href="podman_tag_module.html" />
|
||||
<link rel="next" title="containers.podman.podman_volume_info module" href="podman_volume_info_module.html" />
|
||||
<link rel="prev" title="containers.podman.podman_tag module" href="podman_tag_module.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
|
@ -33,222 +33,19 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-volume-module"></span><section id="containers-podman-podman-volume-module-manage-podman-volumes">
|
||||
<h1>containers.podman.podman_volume module – Manage Podman volumes<a class="headerlink" href="#containers-podman-podman-volume-module-manage-podman-volumes" title="Permalink to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.16.2).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||||
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">containers.podman</span></code>.
|
||||
You need further requirements to be able to use this module,
|
||||
see <a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman_volume</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in containers.podman 1.1.0</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Manage Podman volumes</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-containers-podman-podman-volume-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>podman</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
<th class="head"><p>Comments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-debug"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-debug"><strong>debug</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Return additional information which can be helpful for investigations.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-driver"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-driver"><strong>driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Specify volume driver name (default local).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-executable"><strong>executable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-executable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to <code class="docutils literal notranslate"><span class="pre">podman</span></code> executable if it is not in the <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> on the machine running <code class="docutils literal notranslate"><span class="pre">podman</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"podman"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-label"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-label"><strong>label</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Add metadata to a pod volume (e.g., label com.example.key=value).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of volume.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-options"><strong>options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set driver specific options. For example ‘device=tpmfs’, ‘type=tmpfs’. UID and GID idempotency is not supported due to changes in podman.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_dir"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-dir"><strong>quadlet_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to the directory to write quadlet file in. By default, it will be set as <code class="docutils literal notranslate"><span class="pre">/etc/containers/systemd/</span></code> for root user, <code class="docutils literal notranslate"><span class="pre">~/.config/containers/systemd/</span></code> for non-root users.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_file_mode"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-file-mode"><strong>quadlet_file_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_file_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The permissions of the quadlet file.</p>
|
||||
<p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> can be specied as octal numbers or as a symbolic mode (for example, <code class="ansible-value docutils literal notranslate"><span class="pre">u+rwx</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">u=rw,g=r,o=r</span></code>). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like <code class="ansible-value docutils literal notranslate"><span class="pre">0644</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">01777</span></code>) or quote it (like <code class="ansible-value docutils literal notranslate"><span class="pre">'644'</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">'1777'</span></code>) so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does not</strong> exist, the default <code class="ansible-value docutils literal notranslate"><span class="pre">'0640'</span></code> mask will be used when setting the mode for the newly created file.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is not specified and the quadlet file <strong>does</strong> exist, the mode of the existing file will be used.</p>
|
||||
<p>Specifying <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-file-mode"><span class="std std-ref"><span class="pre">quadlet_file_mode</span></span></a></strong></code> is the best way to ensure files are created with the correct permissions.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_filename"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-filename"><strong>quadlet_filename</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_filename" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of quadlet file to write. By default it takes <em>name</em> value.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-quadlet_options"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-quadlet-options"><strong>quadlet_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-quadlet_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Options for the quadlet file. Provide missing in usual network args options as a list of lines to add.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-recreate"><strong>recreate</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Recreate volume even if exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>State of volume, default ‘present’</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"present"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"mounted"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"unmounted"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"quadlet"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># What modules does for example</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a volume</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_volume</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">volume1</span>
|
||||
<span class="w"> </span><span class="nt">label</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value</span>
|
||||
<span class="w"> </span><span class="nt">key2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">value2</span>
|
||||
<span class="w"> </span><span class="nt">options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"device=/dev/loop1"</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"type=ext4"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a Quadlet file for a volume</span>
|
||||
<span class="w"> </span><span class="nt">containers.podman.podman_volume</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quadlet</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quadlet_volume</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_filename</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom-name</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_file_mode</span><span class="p">:</span><span class="w"> </span><span class="s">'0640'</span>
|
||||
<span class="w"> </span><span class="nt">quadlet_options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Group=192</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Copy=true</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Image=quay.io/centos/centos:latest</span>
|
||||
<span class="target" id="ansible-collections-containers-podman-podman-volume-module"></span><section id="containers-podman-podman-volume-module">
|
||||
<h1>containers.podman.podman_volume module<a class="headerlink" href="#containers-podman-podman-volume-module" title="Permalink to this heading">¶</a></h1>
|
||||
<p>The documentation for the module plugin, containers.podman.podman_volume, was malformed.</p>
|
||||
<p>The errors were:</p>
|
||||
<ul>
|
||||
<li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="n">validation</span> <span class="n">error</span> <span class="k">for</span> <span class="n">ModuleDocSchema</span>
|
||||
<span class="n">doc</span> <span class="o">-></span> <span class="n">plugin_name</span>
|
||||
<span class="n">extra</span> <span class="n">fields</span> <span class="ow">not</span> <span class="n">permitted</span> <span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">value_error</span><span class="o">.</span><span class="n">extra</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-volume"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-volume-module-return-volume"><strong>volume</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-volume" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Volume inspection results if exists.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"CreatedAt":</span> <span class="pre">"2023-11-30T16:41:31.310865559+02:00",</span> <span class="pre">"Driver":</span> <span class="pre">"local",</span> <span class="pre">"Labels":</span> <span class="pre">{},</span> <span class="pre">"LockNumber":</span> <span class="pre">18,</span> <span class="pre">"MountCount":</span> <span class="pre">0,</span> <span class="pre">"Mountpoint":</span> <span class="pre">"/home/user/.local/share/containers/storage/volumes/volname/_data",</span> <span class="pre">"Name":</span> <span class="pre">"volname",</span> <span class="pre">"NeedsChown":</span> <span class="pre">true,</span> <span class="pre">"NeedsCopyUp":</span> <span class="pre">true,</span> <span class="pre">"Options":</span> <span class="pre">{},</span> <span class="pre">"Scope":</span> <span class="pre">"local"}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="collection-links">
|
||||
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="ansible-links">
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<p>File a bug with the <a class="reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc">containers.podman collection</a> in order to have it corrected.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -269,49 +66,56 @@ see <a class="reference internal" href="#ansible-collections-containers-podman-p
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="podman_tag_module.html" title="previous chapter">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li>Next: <a href="podman_volume_info_module.html" title="next chapter">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li>Previous: <a href="podman_tag_module.html" title="previous chapter">containers.podman.podman_tag module</a></li>
|
||||
<li>Next: <a href="podman_volume_info_module.html" title="next chapter">containers.podman.podman_volume_info module</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -83,41 +83,48 @@
|
|||
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module – Copy file to/from a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module – Search for remote images using podman</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_copy_module.html">containers.podman.podman_container_copy module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_module.html">containers.podman.podman_quadlet module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_quadlet_info_module.html">containers.podman.podman_quadlet_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_search_module.html">containers.podman.podman_search module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_system_info_module.html">containers.podman.podman_system_info module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection – Interact with an existing podman container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_connection.html">containers.podman.podman connection</a></li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="buildah_containers_inventory.html">containers.podman.buildah_containers inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="podman_containers_inventory.html">containers.podman.podman_containers inventory</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
51
playbooks/examples/README.md
Normal file
51
playbooks/examples/README.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
### Buildah connection playbook examples
|
||||
|
||||
This folder contains self-contained Ansible playbooks demonstrating how to build images with Buildah while executing steps inside a working container through the Buildah connection plugin (`ansible_connection: containers.podman.buildah`). Each example shows a realistic workflow and explains the options used.
|
||||
|
||||
Prerequisites
|
||||
- Podman and Buildah installed (rootless supported)
|
||||
- Ansible installed (`ansible-core` recommended)
|
||||
- Network access to pull base images
|
||||
|
||||
How these playbooks work
|
||||
- A working container is created on localhost using `buildah from <image>`.
|
||||
- The playbook dynamically adds a temporary inventory host whose `ansible_connection` is `containers.podman.buildah` and `remote_addr` is the Buildah working container ID.
|
||||
- File operations and commands within the container use the Buildah connection plugin (no SSH), so modules like `copy`, `command`, and `shell` act inside the container.
|
||||
- Image metadata/commit/push operations are executed on localhost with `buildah config/commit/push` referencing the same container ID.
|
||||
|
||||
Common variables
|
||||
- `buildah_base_image`: base image to start the working container (varies per example)
|
||||
- `image_name`: final image name (and optional tag)
|
||||
- `ansible_buildah_working_directory`: working directory inside the container for all build steps (passed to the connection plugin)
|
||||
|
||||
Examples
|
||||
1) build_node_ai_api.yml — Node.js AI prediction API image without a Dockerfile
|
||||
- Starts from `node:14`, copies `package.json` and app sources to `/app`, runs `npm install`, sets image metadata, commits to `my-ai-node-app:latest`.
|
||||
- Options highlighted:
|
||||
- `ansible_connection: containers.podman.buildah`
|
||||
- `ansible_buildah_working_directory: /app`
|
||||
|
||||
2) build_go_ai_multistage.yml — Multi-stage Go build to a minimal runtime image
|
||||
- Stage 1: compile inside `golang:1.21` working container, fetch the compiled binary to host.
|
||||
- Stage 2: start `alpine:latest`, copy binary into the container, configure CMD and exposed port, commit `minimal-ai-inference:latest`.
|
||||
- Shows how to move artifacts between stages using the connection plugin’s `fetch_file` and normal `copy`.
|
||||
|
||||
3) build_ai_env_with_ansible.yml — Create a consistent AI dev environment image with an Ansible role
|
||||
- Starts from `python:3.11-slim`, then applies role `roles/ai-dev-env` which installs common data-science packages inside the container using raw/pip commands.
|
||||
- Demonstrates layering higher-level Ansible logic on top of a Buildah working container.
|
||||
|
||||
4) gitlab_ci_build_model_image.yml — CI-friendly image build using Buildah connection (template)
|
||||
- Builds and optionally pushes an image for a simple model serving app (`app.py`, `requirements.txt`).
|
||||
- Designed to be called from GitLab CI; see the included `.gitlab-ci.yml` for a minimal job that runs `ansible-playbook`.
|
||||
|
||||
Running an example
|
||||
```bash
|
||||
cd playbook/examples
|
||||
ansible-playbook build_node_ai_api.yml -e image_name=my-ai-node-app:latest
|
||||
```
|
||||
|
||||
Notes
|
||||
- The Buildah connection runs commands with `buildah run <container> …` under the hood; metadata operations such as `buildah config`, `commit`, and `push` still run on localhost and reference the working container ID.
|
||||
- If you prefer persistent names, set `container_name` (Buildah will use named working containers). Otherwise, the container ID returned by `buildah from` is used.
|
||||
|
||||
|
||||
41
playbooks/examples/build_ai_env_with_ansible.yml
Normal file
41
playbooks/examples/build_ai_env_with_ansible.yml
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
- name: Build a consistent AI dev environment image using Ansible and Buildah connection
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
base_image: "python:3.11-slim"
|
||||
image_name: "ai-dev-env:latest"
|
||||
workdir: "/workspace"
|
||||
tasks:
|
||||
- name: Start Buildah working container
|
||||
command: buildah from {{ base_image }}
|
||||
register: from_out
|
||||
|
||||
- set_fact:
|
||||
container_id: "{{ from_out.stdout | trim }}"
|
||||
|
||||
- name: Configure working directory
|
||||
command: buildah config --workingdir {{ workdir }} {{ container_id }}
|
||||
|
||||
- name: Add working container as dynamic host (Buildah connection)
|
||||
add_host:
|
||||
name: "buildcntr_{{ container_id }}"
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: "{{ container_id }}"
|
||||
ansible_buildah_working_directory: "{{ workdir }}"
|
||||
|
||||
- name: Provision AI environment inside container using role
|
||||
import_role:
|
||||
name: ai-dev-env
|
||||
delegate_to: "buildcntr_{{ container_id }}"
|
||||
|
||||
- name: Set container metadata
|
||||
shell: |
|
||||
buildah config --env "JUPYTER_TOKEN=ansible" {{ container_id }}
|
||||
buildah config --port 8888 {{ container_id }}
|
||||
buildah config --cmd "jupyter lab --ip=0.0.0.0 --no-browser" {{ container_id }}
|
||||
|
||||
- name: Commit image
|
||||
command: buildah commit {{ container_id }} {{ image_name }}
|
||||
|
||||
|
||||
84
playbooks/examples/build_go_ai_multistage.yml
Normal file
84
playbooks/examples/build_go_ai_multistage.yml
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
- name: Build minimal Go-based AI inference image with multi-stage using Buildah connection
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
build_stage_image: "golang:1.23"
|
||||
runtime_image: "alpine:latest"
|
||||
image_name: "minimal-ai-inference:latest"
|
||||
source_dir: "{{ playbook_dir }}/go_app"
|
||||
build_workdir: "/app"
|
||||
tasks:
|
||||
- name: Ensure source exists
|
||||
stat:
|
||||
path: "{{ source_dir }}/main.go"
|
||||
register: go_src
|
||||
|
||||
- name: Fail if source missing
|
||||
fail:
|
||||
msg: "Provide a Go main.go under {{ source_dir }}"
|
||||
when: not go_src.stat.exists
|
||||
|
||||
- name: Start build stage container (Go toolchain)
|
||||
command: buildah from {{ build_stage_image }}
|
||||
register: build_from
|
||||
|
||||
- set_fact:
|
||||
build_container: "{{ build_from.stdout | trim }}"
|
||||
|
||||
- name: Add build container to inventory
|
||||
add_host:
|
||||
name: "build_stage_{{ build_container }}"
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: "{{ build_container }}"
|
||||
ansible_buildah_working_directory: "{{ build_workdir }}"
|
||||
|
||||
- name: Configure workdir
|
||||
command: buildah config --workingdir {{ build_workdir }} {{ build_container }}
|
||||
|
||||
- name: Copy sources
|
||||
copy:
|
||||
src: "{{ source_dir }}/main.go"
|
||||
dest: "{{ build_workdir }}/main.go"
|
||||
delegate_to: "build_stage_{{ build_container }}"
|
||||
|
||||
- name: Build static binary
|
||||
shell: CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o inference-engine main.go
|
||||
args:
|
||||
chdir: "{{ build_workdir }}"
|
||||
delegate_to: "build_stage_{{ build_container }}"
|
||||
|
||||
- name: Fetch compiled binary to host
|
||||
fetch:
|
||||
src: "{{ build_workdir }}/inference-engine"
|
||||
dest: "{{ playbook_dir }}/inference-engine"
|
||||
flat: true
|
||||
delegate_to: "build_stage_{{ build_container }}"
|
||||
|
||||
- name: Remove build container
|
||||
command: buildah rm {{ build_container }}
|
||||
|
||||
- name: Start runtime container
|
||||
command: buildah from {{ runtime_image }}
|
||||
register: run_from
|
||||
|
||||
- set_fact:
|
||||
run_container: "{{ run_from.stdout | trim }}"
|
||||
|
||||
- name: Copy binary into runtime container
|
||||
command: buildah copy {{ run_container }} {{ playbook_dir }}/inference-engine /inference-engine
|
||||
|
||||
- name: Configure runtime image
|
||||
shell: |
|
||||
buildah config --cmd "/inference-engine" {{ run_container }}
|
||||
buildah config --port 8080 {{ run_container }}
|
||||
|
||||
- name: Commit image
|
||||
command: buildah commit {{ run_container }} {{ image_name }}
|
||||
|
||||
- name: Cleanup host artifact
|
||||
file:
|
||||
path: "{{ playbook_dir }}/inference-engine"
|
||||
state: absent
|
||||
|
||||
|
||||
76
playbooks/examples/build_node_ai_api.yml
Normal file
76
playbooks/examples/build_node_ai_api.yml
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
---
|
||||
- name: Build Node.js AI prediction API without Dockerfile using Buildah connection
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
buildah_base_image: "node:24"
|
||||
image_name: "my-ai-node-app:latest"
|
||||
workdir: "/app"
|
||||
# App sources live under examples/node_app/
|
||||
app_src_dir: "{{ playbook_dir }}/node_app"
|
||||
tasks:
|
||||
- name: Ensure app sources exist
|
||||
stat:
|
||||
path: "{{ app_src_dir }}/package.json"
|
||||
register: app_sources
|
||||
|
||||
- name: Fail if sources are missing
|
||||
fail:
|
||||
msg: "Example sources not found under {{ app_src_dir }}. Provide package.json and app.js."
|
||||
when: not app_sources.stat.exists
|
||||
|
||||
- name: Start Buildah working container
|
||||
command: buildah from {{ buildah_base_image }}
|
||||
register: from_out
|
||||
changed_when: true
|
||||
|
||||
- name: Set container id fact
|
||||
set_fact:
|
||||
container_id: "{{ from_out.stdout | trim }}"
|
||||
|
||||
- name: Add working container as a dynamic host to inventory
|
||||
add_host:
|
||||
name: "buildcntr_{{ container_id }}"
|
||||
ansible_connection: containers.podman.buildah
|
||||
ansible_host: "{{ container_id }}"
|
||||
ansible_buildah_working_directory: "{{ workdir }}"
|
||||
|
||||
- name: Configure image metadata (workdir)
|
||||
command: buildah config --workingdir {{ workdir }} {{ container_id }}
|
||||
|
||||
- name: Copy package files first for better layer caching
|
||||
copy:
|
||||
src: "{{ item }}"
|
||||
dest: "{{ workdir }}/"
|
||||
with_items:
|
||||
- "{{ app_src_dir }}/package.json"
|
||||
- "{{ app_src_dir }}/package-lock.json"
|
||||
delegate_to: "buildcntr_{{ container_id }}"
|
||||
|
||||
- name: Install dependencies
|
||||
command: npm install
|
||||
delegate_to: "buildcntr_{{ container_id }}"
|
||||
|
||||
- name: Copy application code
|
||||
copy:
|
||||
src: "{{ app_src_dir }}/app.js"
|
||||
dest: "{{ workdir }}/app.js"
|
||||
delegate_to: "buildcntr_{{ container_id }}"
|
||||
|
||||
- name: Expose port and set default command
|
||||
shell: |
|
||||
buildah config --port 3000 {{ container_id }}
|
||||
buildah config --cmd "node app.js" {{ container_id }}
|
||||
|
||||
- name: Commit image
|
||||
command: buildah commit {{ container_id }} {{ image_name }}
|
||||
|
||||
- name: Show resulting image
|
||||
command: buildah images --format '{{"{{.Name}}:{{.Tag}}"}}\t{{"{{.Size}}"}}'
|
||||
register: imgs
|
||||
changed_when: false
|
||||
|
||||
- debug:
|
||||
var: imgs.stdout_lines
|
||||
|
||||
|
||||
19
playbooks/examples/go_app/main.go
Normal file
19
playbooks/examples/go_app/main.go
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"math/rand"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func predict(w http.ResponseWriter, r *http.Request) {
|
||||
fmt.Fprintf(w, "prediction=%f\n", rand.Float64())
|
||||
}
|
||||
|
||||
func main() {
|
||||
http.HandleFunc("/predict", predict)
|
||||
fmt.Println("Inference engine listening on :8080")
|
||||
http.ListenAndServe(":8080", nil)
|
||||
}
|
||||
|
||||
|
||||
13
playbooks/examples/model_server/app.py
Normal file
13
playbooks/examples/model_server/app.py
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
from flask import Flask, jsonify
|
||||
import random
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
@app.get("/predict")
|
||||
def predict():
|
||||
return jsonify({"prediction": random.random()})
|
||||
|
||||
if __name__ == "__main__":
|
||||
app.run(host="0.0.0.0", port=5000)
|
||||
|
||||
|
||||
2
playbooks/examples/model_server/requirements.txt
Normal file
2
playbooks/examples/model_server/requirements.txt
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
flask==3.0.0
|
||||
|
||||
11
playbooks/examples/node_app/app.js
Normal file
11
playbooks/examples/node_app/app.js
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
const express = require('express');
|
||||
const app = express();
|
||||
|
||||
app.get('/predict', (req, res) => {
|
||||
// Dummy prediction endpoint
|
||||
res.json({ prediction: Math.random() });
|
||||
});
|
||||
|
||||
app.listen(3000, () => console.log('AI prediction API listening on :3000'));
|
||||
|
||||
|
||||
18
playbooks/examples/node_app/package-lock.json
generated
Normal file
18
playbooks/examples/node_app/package-lock.json
generated
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"name": "ai-prediction-api",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "ai-prediction-api",
|
||||
"version": "1.0.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"express": "^4.18.2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
12
playbooks/examples/node_app/package.json
Normal file
12
playbooks/examples/node_app/package.json
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"name": "ai-prediction-api",
|
||||
"version": "1.0.0",
|
||||
"description": "Sample Node.js AI prediction API for Buildah example",
|
||||
"main": "app.js",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"express": "^4.18.2"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
10
playbooks/examples/roles/ai-dev-env/tasks/main.yml
Normal file
10
playbooks/examples/roles/ai-dev-env/tasks/main.yml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
# Minimal example role to provision an AI dev environment inside a Buildah working container
|
||||
- name: Ensure pip present
|
||||
shell: python3 -m ensurepip || true
|
||||
|
||||
- name: Upgrade pip
|
||||
shell: python3 -m pip install --upgrade pip
|
||||
|
||||
- name: Install common data science packages
|
||||
shell: python3 -m pip install --no-cache-dir numpy pandas jupyterlab
|
||||
110
plugins/inventory/buildah_containers.py
Normal file
110
plugins/inventory/buildah_containers.py
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
# Copyright (c) 2025
|
||||
# GNU General Public License v3.0+
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
name: buildah_containers
|
||||
short_description: Inventory plugin that discovers Buildah working containers as hosts
|
||||
version_added: '1.18.0'
|
||||
author:
|
||||
- "Sagi Shnaidman (@sshnaidm)"
|
||||
description:
|
||||
- Discover Buildah working containers on the local host and add them as inventory hosts.
|
||||
- Each discovered host is assigned the Buildah connection plugin so tasks execute inside the working container.
|
||||
options:
|
||||
plugin:
|
||||
description: Token that ensures this is a source file for the 'containers.podman.buildah_containers' inventory plugin.
|
||||
required: true
|
||||
type: str
|
||||
choices: ['containers.podman.buildah_containers']
|
||||
executable:
|
||||
description: Path to the C(buildah) executable.
|
||||
type: str
|
||||
default: buildah
|
||||
env:
|
||||
- name: ANSIBLE_BUILDAH_EXECUTABLE
|
||||
name_patterns:
|
||||
description: Glob patterns to match working container names or IDs; empty means include all.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
connection_plugin:
|
||||
description: Fully-qualified connection plugin to use for discovered hosts.
|
||||
type: str
|
||||
default: containers.podman.buildah
|
||||
# Logging uses Ansible verbosity (-v/-vvv). Extra debug option is not required.
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
plugin: containers.podman.buildah_containers
|
||||
connection_plugin: containers.podman.buildah
|
||||
name_patterns:
|
||||
- my-build-*
|
||||
"""
|
||||
|
||||
import json
|
||||
import fnmatch
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
from ansible.errors import AnsibleParserError
|
||||
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
|
||||
from ansible_collections.containers.podman.plugins.module_utils.inventory.utils import verify_inventory_file
|
||||
|
||||
|
||||
class InventoryModule(BaseInventoryPlugin, Cacheable, Constructable):
|
||||
NAME = "containers.podman.buildah_containers"
|
||||
|
||||
def verify_file(self, path: str) -> bool:
|
||||
if not super(InventoryModule, self).verify_file(path):
|
||||
return False
|
||||
return verify_inventory_file(self, path)
|
||||
|
||||
def parse(self, inventory, loader, path, cache=True):
|
||||
super(InventoryModule, self).parse(inventory, loader, path)
|
||||
config = self._read_config_data(path)
|
||||
|
||||
executable = config.get("executable", "buildah")
|
||||
name_patterns = list(config.get("name_patterns", []) or [])
|
||||
connection_plugin = config.get("connection_plugin", "containers.podman.buildah")
|
||||
# Logging is controlled by Ansible verbosity flags
|
||||
|
||||
buildah_path = shutil.which(executable) or executable
|
||||
|
||||
# 'buildah containers -a --format json' lists working containers
|
||||
args = [buildah_path, "containers", "-a", "--json"]
|
||||
output = ""
|
||||
containers = []
|
||||
try:
|
||||
output = subprocess.check_output(args, stderr=subprocess.STDOUT)
|
||||
containers = json.loads(output.decode("utf-8"))
|
||||
except Exception as exc:
|
||||
raise AnsibleParserError(f"Failed to list buildah containers: {exc} from output {output}")
|
||||
|
||||
for c in containers:
|
||||
name = c.get("name") or c.get("containername") or c.get("id")
|
||||
cid = c.get("id") or c.get("containerid")
|
||||
if not name and cid:
|
||||
name = cid[:12]
|
||||
|
||||
# name filtering
|
||||
if name_patterns:
|
||||
if not any(fnmatch.fnmatch(name, pat) or (cid and fnmatch.fnmatch(cid, pat)) for pat in name_patterns):
|
||||
self.display.vvvv(f"Filtered out {name or cid} by name_patterns option")
|
||||
continue
|
||||
|
||||
host = name or cid
|
||||
if not host:
|
||||
self.display.vvvv(f"Filtered out {name or cid} by no name or cid")
|
||||
continue
|
||||
|
||||
self.inventory.add_host(host)
|
||||
self.inventory.set_variable(host, "ansible_connection", connection_plugin)
|
||||
self.inventory.set_variable(host, "ansible_host", name or cid)
|
||||
if cid:
|
||||
self.inventory.set_variable(host, "buildah_container_id", cid)
|
||||
if name:
|
||||
self.inventory.set_variable(host, "buildah_container_name", name)
|
||||
304
plugins/inventory/podman_containers.py
Normal file
304
plugins/inventory/podman_containers.py
Normal file
|
|
@ -0,0 +1,304 @@
|
|||
# Copyright (c) 2025
|
||||
# GNU General Public License v3.0+
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
name: podman_containers
|
||||
short_description: Inventory plugin that discovers Podman containers as hosts
|
||||
version_added: '1.18.0'
|
||||
author:
|
||||
- "Sagi Shnaidman (@sshnaidm)"
|
||||
description:
|
||||
- Discover running (and optionally stopped) Podman containers on the local host and add them as inventory hosts.
|
||||
- Each discovered host is assigned an Ansible connection plugin so tasks execute inside the container without SSH.
|
||||
options:
|
||||
plugin:
|
||||
description: Token that ensures this is a source file for the 'containers.podman.podman_containers' inventory plugin.
|
||||
required: true
|
||||
type: str
|
||||
choices: ['containers.podman.podman_containers']
|
||||
executable:
|
||||
description: Path to the C(podman) executable.
|
||||
type: str
|
||||
default: podman
|
||||
env:
|
||||
- name: ANSIBLE_PODMAN_EXECUTABLE
|
||||
include_stopped:
|
||||
description: Whether to include stopped/exited containers.
|
||||
type: bool
|
||||
default: false
|
||||
name_patterns:
|
||||
description: Glob patterns to match container names or IDs; empty means include all.
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
label_selectors:
|
||||
description: Key/value labels that must match (all) for a container to be included.
|
||||
type: dict
|
||||
default: {}
|
||||
connection_plugin:
|
||||
description: Fully-qualified connection plugin to use for discovered hosts.
|
||||
type: str
|
||||
default: containers.podman.podman
|
||||
group_by_image:
|
||||
description: Add containers to a group derived from image name (e.g., C(image_node_14)).
|
||||
type: bool
|
||||
default: true
|
||||
group_by_label:
|
||||
description: Label keys to group containers by (C(label_<key>_<value>)).
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
# Additional options (non-API dependent), aligned with community.docker
|
||||
verbose_output:
|
||||
description: When true, store raw C(podman ps --format json) entry under C(podman_ps) host var.
|
||||
type: bool
|
||||
default: false
|
||||
strict:
|
||||
description: Fail when keyed/composed grouping references missing data.
|
||||
type: bool
|
||||
default: false
|
||||
keyed_groups:
|
||||
description: Create groups based on hostvars/labels.
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
groups:
|
||||
description: Add hosts to groups based on Jinja2 conditionals.
|
||||
type: dict
|
||||
default: {}
|
||||
filters:
|
||||
description: Include/exclude selection by attributes - C(name), C(id), C(image), C(status), or C(label.<key>).
|
||||
type: dict
|
||||
default: {}
|
||||
# Logging uses Ansible verbosity (-v/-vvv). Extra debug option is not required.
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
plugin: containers.podman.podman_containers
|
||||
include_stopped: false
|
||||
label_selectors:
|
||||
role: api
|
||||
connection_plugin: containers.podman.podman
|
||||
"""
|
||||
|
||||
import json
|
||||
import fnmatch
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
from ansible.errors import AnsibleParserError
|
||||
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
|
||||
from ansible_collections.containers.podman.plugins.module_utils.inventory.utils import verify_inventory_file
|
||||
|
||||
|
||||
class InventoryModule(BaseInventoryPlugin, Cacheable, Constructable):
|
||||
NAME = "containers.podman.podman_containers"
|
||||
|
||||
def __init__(self):
|
||||
super(InventoryModule, self).__init__()
|
||||
|
||||
def verify_file(self, path: str) -> bool:
|
||||
if not super(InventoryModule, self).verify_file(path):
|
||||
return False
|
||||
return verify_inventory_file(self, path)
|
||||
|
||||
def parse(self, inventory, loader, path, cache=True):
|
||||
super(InventoryModule, self).parse(inventory, loader, path)
|
||||
config = self._read_config_data(path)
|
||||
|
||||
executable = config.get("executable", "podman")
|
||||
include_stopped = bool(config.get("include_stopped", False))
|
||||
name_patterns = list(config.get("name_patterns", []) or [])
|
||||
label_selectors = dict(config.get("label_selectors", {}) or {})
|
||||
connection_plugin = config.get("connection_plugin", "containers.podman.podman")
|
||||
group_by_image = bool(config.get("group_by_image", True))
|
||||
group_by_label = list(config.get("group_by_label", []) or [])
|
||||
verbose_output = bool(config.get("verbose_output", False))
|
||||
strict = bool(config.get("strict", False))
|
||||
keyed_groups = list(config.get("keyed_groups", []) or [])
|
||||
composed_groups = dict(config.get("groups", {}) or {})
|
||||
filters = dict(config.get("filters", {}) or {})
|
||||
# Logging is controlled by Ansible verbosity flags
|
||||
|
||||
podman_path = shutil.which(executable) or executable
|
||||
|
||||
args = [podman_path, "ps", "--format", "json"]
|
||||
if include_stopped:
|
||||
args.insert(2, "-a")
|
||||
|
||||
output = ""
|
||||
containers = []
|
||||
try:
|
||||
output = subprocess.check_output(args, stderr=subprocess.STDOUT)
|
||||
containers = json.loads(output.decode("utf-8"))
|
||||
except Exception as exc:
|
||||
raise AnsibleParserError(f"Failed to list podman containers: {exc} from output {output}")
|
||||
|
||||
def matches_filters(name, cid, image, status, labels):
|
||||
include_rules = dict(filters.get("include", {}) or {})
|
||||
exclude_rules = dict(filters.get("exclude", {}) or {})
|
||||
|
||||
def matches_one(k, v):
|
||||
if k.startswith("label."):
|
||||
lk = k.split(".", 1)[1]
|
||||
return fnmatch.fnmatch(str((labels or {}).get(lk, "")).lower(), str(v).lower())
|
||||
if k == "name":
|
||||
return fnmatch.fnmatch((name or "").lower(), str(v).lower())
|
||||
if k == "id":
|
||||
return fnmatch.fnmatch((cid or "").lower(), str(v).lower())
|
||||
if k == "image":
|
||||
return fnmatch.fnmatch((image or "").lower(), str(v).lower())
|
||||
if k == "status":
|
||||
return fnmatch.fnmatch((status or "").lower(), str(v).lower())
|
||||
return False
|
||||
|
||||
if include_rules:
|
||||
for k, v in include_rules.items():
|
||||
if not matches_one(k, v):
|
||||
return False
|
||||
for k, v in exclude_rules.items():
|
||||
if matches_one(k, v):
|
||||
return False
|
||||
return True
|
||||
|
||||
for c in containers:
|
||||
name = (
|
||||
(c.get("Names") or [c.get("Names", "")])[0]
|
||||
if isinstance(c.get("Names"), list)
|
||||
else c.get("Names") or c.get("Names", "")
|
||||
)
|
||||
cid = c.get("Id") or c.get("ID")
|
||||
if not name and cid:
|
||||
name = cid[:12]
|
||||
|
||||
# name filtering
|
||||
if name_patterns:
|
||||
if not any(fnmatch.fnmatch(name, pat) or (cid and fnmatch.fnmatch(cid, pat)) for pat in name_patterns):
|
||||
self.display.vvvv(f"Filtered out {name or cid} by name_patterns option")
|
||||
continue
|
||||
|
||||
# label filtering
|
||||
labels = c.get("Labels") or {}
|
||||
if any(labels.get(k) != v for k, v in label_selectors.items()):
|
||||
self.display.vvvv(f"Filtered out {name or cid} by label_selectors option")
|
||||
continue
|
||||
|
||||
image = c.get("Image") or c.get("ImageName")
|
||||
status = c.get("Status") or c.get("State")
|
||||
|
||||
# additional include/exclude filters
|
||||
if filters and not matches_filters(name, cid, image, status, labels):
|
||||
self.display.vvvv(f"Filtered out {name or cid} by filters option")
|
||||
continue
|
||||
|
||||
host = name or cid
|
||||
if not host:
|
||||
self.display.vvvv(f"Filtered out {name or cid} by no name or cid")
|
||||
continue
|
||||
|
||||
self.inventory.add_host(host)
|
||||
# Set connection plugin and remote_addr (container id or name works)
|
||||
self.inventory.set_variable(host, "ansible_connection", connection_plugin)
|
||||
self.inventory.set_variable(host, "ansible_host", name or cid)
|
||||
|
||||
# Common vars
|
||||
self.inventory.set_variable(host, "podman_container_id", cid)
|
||||
self.inventory.set_variable(host, "podman_container_name", name)
|
||||
if image:
|
||||
self.inventory.set_variable(host, "podman_image", image)
|
||||
if status:
|
||||
self.inventory.set_variable(host, "podman_status", status)
|
||||
if labels:
|
||||
self.inventory.set_variable(host, "podman_labels", labels)
|
||||
if verbose_output:
|
||||
self.inventory.set_variable(host, "podman_ps", c)
|
||||
|
||||
# Grouping
|
||||
if group_by_image and image:
|
||||
safe_image = image.replace(":", "_").replace("/", "_").replace("-", "_")
|
||||
self.inventory.add_group(f"image_{safe_image}")
|
||||
self.inventory.add_host(host, group=f"image_{safe_image}")
|
||||
|
||||
for key in group_by_label:
|
||||
if key in labels:
|
||||
val = str(labels.get(key)).replace("/", "_").replace(":", "_").replace("-", "_")
|
||||
group = f"label_{key}_{val}"
|
||||
self.inventory.add_group(group)
|
||||
self.inventory.add_host(host, group=group)
|
||||
|
||||
# Composed and keyed groups
|
||||
hostvars = {
|
||||
"name": name,
|
||||
"id": cid,
|
||||
"image": image,
|
||||
"status": status,
|
||||
"labels": labels,
|
||||
}
|
||||
try:
|
||||
if composed_groups:
|
||||
self._add_host_to_composed_groups(composed_groups, hostvars, host)
|
||||
if keyed_groups:
|
||||
# Try built-in helper first (signature may vary by ansible-core), do not fail hard
|
||||
try:
|
||||
self._add_host_to_keyed_groups(keyed_groups, hostvars, host)
|
||||
except Exception as _e:
|
||||
self.display.vvvv(f"_add_host_to_keyed_groups helper failed: {_e}")
|
||||
# Always run manual keyed grouping to support dotted keys like labels.role
|
||||
for kg in keyed_groups:
|
||||
key_expr = kg.get("key")
|
||||
if not key_expr:
|
||||
continue
|
||||
# Resolve dotted key path against hostvars
|
||||
value = None
|
||||
cur = hostvars
|
||||
for part in str(key_expr).split("."):
|
||||
if isinstance(cur, dict) and part in cur:
|
||||
cur = cur.get(part)
|
||||
else:
|
||||
cur = None
|
||||
break
|
||||
value = cur if isinstance(cur, (str, int)) else (cur if cur is not None else None)
|
||||
if value is None:
|
||||
if strict and kg.get("default_value") is None:
|
||||
raise AnsibleParserError(f"Missing keyed_groups key '{key_expr}' for host {host}")
|
||||
value = kg.get("default_value")
|
||||
if value is None or value == "":
|
||||
continue
|
||||
value = str(value)
|
||||
prefix = kg.get("prefix", "") or ""
|
||||
sep = kg.get("separator", "_") or "_"
|
||||
leading = bool(kg.get("leading_separator", False))
|
||||
trailing = bool(kg.get("trailing_separator", False))
|
||||
group_name = ""
|
||||
if leading and not prefix:
|
||||
group_name += sep
|
||||
if prefix:
|
||||
group_name += prefix
|
||||
if value:
|
||||
group_name += sep
|
||||
group_name += value
|
||||
if trailing:
|
||||
group_name += sep
|
||||
parent = kg.get("parent_group")
|
||||
# Sanitize group names per Ansible rules
|
||||
sanitized = self._sanitize_group_name(group_name)
|
||||
parent_sanitized = self._sanitize_group_name(parent) if parent else None
|
||||
if parent_sanitized:
|
||||
self.inventory.add_group(parent_sanitized)
|
||||
self.inventory.add_group(sanitized)
|
||||
try:
|
||||
self.inventory.add_child(parent_sanitized, sanitized)
|
||||
except Exception:
|
||||
pass
|
||||
self.inventory.add_host(host, group=sanitized)
|
||||
else:
|
||||
self.inventory.add_group(sanitized)
|
||||
self.inventory.add_host(host, group=sanitized)
|
||||
except Exception as exc:
|
||||
if strict:
|
||||
raise
|
||||
self.display.vvvv(f"Grouping error for host {host}: {exc}")
|
||||
18
plugins/module_utils/inventory/utils.py
Normal file
18
plugins/module_utils/inventory/utils.py
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
import os
|
||||
|
||||
|
||||
def verify_inventory_file(self, path: str) -> bool:
|
||||
|
||||
unused, ext = os.path.splitext(path)
|
||||
if ext not in (".yml", ".yaml"):
|
||||
return False
|
||||
try:
|
||||
with open(path, "r", encoding="utf-8") as f:
|
||||
header = f.read(2048)
|
||||
return (
|
||||
(f"plugin: {self.NAME}\n" in header)
|
||||
or (f"plugin: '{self.NAME}'" in header)
|
||||
or (f'plugin: "{self.NAME}"' in header)
|
||||
)
|
||||
except Exception:
|
||||
return False
|
||||
|
|
@ -2,3 +2,5 @@ ansible-core
|
|||
pytest
|
||||
pytest-forked
|
||||
pytest-xdist
|
||||
pytest-cov
|
||||
coverage==7.6.1
|
||||
|
|
|
|||
|
|
@ -0,0 +1,116 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
import json
|
||||
from unittest.mock import patch
|
||||
|
||||
|
||||
class FakeInventory:
|
||||
def __init__(self):
|
||||
self.hostvars = {}
|
||||
self.groups = {}
|
||||
|
||||
def add_group(self, name):
|
||||
self.groups.setdefault(name, {"hosts": [], "children": []})
|
||||
|
||||
def add_host(self, host, group=None):
|
||||
self.hostvars.setdefault(host, {})
|
||||
if group:
|
||||
self.add_group(group)
|
||||
if host not in self.groups[group]["hosts"]:
|
||||
self.groups[group]["hosts"].append(host)
|
||||
else:
|
||||
self.add_group("ungrouped")
|
||||
if host not in self.groups["ungrouped"]["hosts"]:
|
||||
self.groups["ungrouped"]["hosts"].append(host)
|
||||
|
||||
def set_variable(self, host, var, value):
|
||||
self.hostvars.setdefault(host, {})
|
||||
self.hostvars[host][var] = value
|
||||
|
||||
|
||||
def build_containers_json(entries):
|
||||
return json.dumps(entries).encode("utf-8")
|
||||
|
||||
|
||||
@patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.buildah_containers.shutil.which", return_value="buildah"
|
||||
)
|
||||
def test_basic_buildah_inventory(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.buildah_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"name": "w1", "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "containername": "w1"},
|
||||
{"containername": "build/with/slash", "containerid": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"},
|
||||
{"id": "cccccccccccccccccccccccccccccccc"}, # no name
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.buildah_containers.subprocess.check_output",
|
||||
return_value=build_containers_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"connection_plugin": "containers.podman.buildah"}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
# Names resolved
|
||||
assert "w1" in inv.hostvars
|
||||
assert "build/with/slash" in inv.hostvars
|
||||
# Unnamed container present (either as short id or full id depending on plugin behavior)
|
||||
unnamed_id = "cccccccccccccccccccccccccccccccc"
|
||||
assert (unnamed_id in inv.hostvars) or (unnamed_id[:12] in inv.hostvars)
|
||||
# Hostvars contain id/name
|
||||
assert inv.hostvars["w1"]["buildah_container_id"].startswith("a")
|
||||
assert inv.hostvars["w1"]["buildah_container_name"] == "w1"
|
||||
|
||||
|
||||
@patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.buildah_containers.shutil.which", return_value="buildah"
|
||||
)
|
||||
def test_name_patterns_filtering_buildah(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.buildah_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"name": "alpha", "id": "id1"},
|
||||
{"name": "beta", "id": "id2"},
|
||||
{"name": "gamma", "id": "id3"},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.buildah_containers.subprocess.check_output",
|
||||
return_value=build_containers_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"name_patterns": ["b*", "id3"], "connection_plugin": "containers.podman.buildah"}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
# Should include beta by name pattern, and gamma via id pattern
|
||||
assert set(inv.hostvars.keys()) == {"beta", "gamma"}
|
||||
|
||||
|
||||
def test_verify_inventory_file_helper():
|
||||
from ansible_collections.containers.podman.plugins.module_utils.inventory.utils import (
|
||||
verify_inventory_file,
|
||||
)
|
||||
|
||||
class Dummy:
|
||||
NAME = "containers.podman.buildah_containers"
|
||||
|
||||
# wrong extension
|
||||
assert not verify_inventory_file(Dummy(), "inv.txt")
|
||||
# missing plugin header
|
||||
p = "/tmp/test_inv.yml"
|
||||
with open(p, "w", encoding="utf-8") as f:
|
||||
f.write("foo: bar\n")
|
||||
assert not verify_inventory_file(Dummy(), p)
|
||||
# correct header
|
||||
with open(p, "w", encoding="utf-8") as f:
|
||||
f.write("plugin: containers.podman.buildah_containers\n")
|
||||
assert verify_inventory_file(Dummy(), p)
|
||||
458
tests/unit/plugins/inventory/test_podman_containers_inventory.py
Normal file
458
tests/unit/plugins/inventory/test_podman_containers_inventory.py
Normal file
|
|
@ -0,0 +1,458 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
import json
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
|
||||
from ansible.errors import AnsibleParserError
|
||||
|
||||
|
||||
class FakeInventory:
|
||||
def __init__(self):
|
||||
self.hostvars = {}
|
||||
self.groups = {}
|
||||
|
||||
def add_group(self, name):
|
||||
self.groups.setdefault(name, {"hosts": [], "children": []})
|
||||
|
||||
def add_child(self, parent, child):
|
||||
self.add_group(parent)
|
||||
self.add_group(child)
|
||||
if child not in self.groups[parent]["children"]:
|
||||
self.groups[parent]["children"].append(child)
|
||||
|
||||
def add_host(self, host, group=None):
|
||||
self.hostvars.setdefault(host, {})
|
||||
if group:
|
||||
self.add_group(group)
|
||||
if host not in self.groups[group]["hosts"]:
|
||||
self.groups[group]["hosts"].append(host)
|
||||
else:
|
||||
self.add_group("ungrouped")
|
||||
if host not in self.groups["ungrouped"]["hosts"]:
|
||||
self.groups["ungrouped"]["hosts"].append(host)
|
||||
|
||||
def set_variable(self, host, var, value):
|
||||
self.hostvars.setdefault(host, {})
|
||||
self.hostvars[host][var] = value
|
||||
|
||||
|
||||
def build_ps_json(entries):
|
||||
return json.dumps(entries).encode("utf-8")
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_basic_discovery_and_hostvars(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{
|
||||
"Names": ["app-1"],
|
||||
"Id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
|
||||
"Image": "docker.io/library/alpine:latest",
|
||||
"Status": "Up 1 second",
|
||||
"Labels": {"env": "dev", "role": "api"},
|
||||
},
|
||||
{
|
||||
"Names": ["db/primary"],
|
||||
"ID": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
|
||||
"ImageName": "quay.io/ns/repo-name:1.0",
|
||||
"State": "Exited (0) 2 seconds ago",
|
||||
"Labels": {},
|
||||
},
|
||||
]
|
||||
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
# Feed config directly
|
||||
with patch.object(
|
||||
mod,
|
||||
"_read_config_data",
|
||||
return_value={
|
||||
"executable": "podman",
|
||||
"include_stopped": True,
|
||||
"connection_plugin": "containers.podman.podman",
|
||||
"group_by_image": True,
|
||||
"group_by_label": ["env"],
|
||||
"verbose_output": True,
|
||||
},
|
||||
):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
# Hosts discovered
|
||||
assert "app-1" in inv.hostvars
|
||||
assert "db/primary" in inv.hostvars
|
||||
# Hostvars set - image, id, status keys
|
||||
assert inv.hostvars["app-1"]["podman_image"] == "docker.io/library/alpine:latest"
|
||||
assert inv.hostvars["db/primary"]["podman_image"] == "quay.io/ns/repo-name:1.0"
|
||||
assert inv.hostvars["app-1"]["podman_container_id"].startswith("a")
|
||||
assert inv.hostvars["db/primary"]["podman_container_id"].startswith("b")
|
||||
assert inv.hostvars["app-1"]["podman_status"].lower().startswith("up")
|
||||
assert inv.hostvars["db/primary"]["podman_status"].lower().startswith("exited")
|
||||
# Verbose output included
|
||||
assert "podman_ps" in inv.hostvars["app-1"]
|
||||
# Image grouping sanitized
|
||||
assert "image_docker.io_library_alpine_latest" in inv.groups
|
||||
assert "image_quay.io_ns_repo_name_1.0" in inv.groups
|
||||
# Label grouping
|
||||
assert "label_env_dev" in inv.groups
|
||||
assert "app-1" in inv.groups["label_env_dev"]["hosts"]
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_name_patterns_and_label_selectors(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["one"], "Id": "id1", "Image": "alpine:latest", "Status": "Up", "Labels": {}},
|
||||
{"Names": ["two"], "Id": "id2", "Image": "alpine:latest", "Status": "Up", "Labels": {"role": "api"}},
|
||||
{"Names": ["three"], "Id": "id3", "Image": "alpine:latest", "Status": "Up", "Labels": {"role": "db"}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {
|
||||
"name_patterns": ["t*"],
|
||||
"label_selectors": {"role": "api"},
|
||||
}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
# Only 'two' matches both name pattern and label
|
||||
assert list(inv.hostvars.keys()) == ["two"]
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_filters_include_exclude_and_status(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["run-a"], "Id": "r1", "Image": "quay.io/ns/a:latest", "Status": "Up", "Labels": {}},
|
||||
{"Names": ["stop-b"], "Id": "s1", "Image": "quay.io/ns/b:latest", "Status": "Exited (0)", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {
|
||||
"include_stopped": True,
|
||||
"filters": {"include": {"image": "quay.io/*"}, "exclude": {"status": "exited*"}},
|
||||
}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
# Stopped excluded, running included
|
||||
assert "run-a" in inv.hostvars
|
||||
assert "stop-b" not in inv.hostvars
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_keyed_groups_and_parent_group(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["svc"], "Id": "x1", "Image": "img", "Status": "Up", "Labels": {"role": "api"}},
|
||||
{"Names": ["svc2"], "Id": "x2", "Image": "img", "Status": "Up", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {
|
||||
"keyed_groups": [
|
||||
{"key": "labels.role", "prefix": "k", "separator": "-", "parent_group": "keyed"},
|
||||
{"key": "labels.missing", "prefix": "missing", "default_value": "unknown"},
|
||||
]
|
||||
}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
assert "k_api" in inv.groups # sanitized hyphen -> underscore
|
||||
assert "svc" in inv.groups["k_api"]["hosts"]
|
||||
assert "keyed" in inv.groups
|
||||
assert "k_api" in inv.groups["keyed"]["children"]
|
||||
assert "missing_unknown" in inv.groups
|
||||
assert set(inv.groups["missing_unknown"]["hosts"]) == {"svc", "svc2"}
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_strict_missing_key_raises(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["h"], "Id": "id", "Image": "img", "Status": "Up", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"strict": True, "keyed_groups": [{"key": "labels.nonexistent"}]}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
with pytest.raises(AnsibleParserError):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_include_stopped_toggles_args(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
def fake_co_with_a(args, stderr=None):
|
||||
# ensure -a present when include_stopped true
|
||||
assert "-a" in args
|
||||
return build_ps_json([])
|
||||
|
||||
def fake_co_without_a(args, stderr=None):
|
||||
# ensure -a absent when include_stopped false
|
||||
assert "-a" not in args
|
||||
return build_ps_json([])
|
||||
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
side_effect=fake_co_without_a,
|
||||
):
|
||||
with patch.object(mod, "_read_config_data", return_value={"include_stopped": False}):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
inv2 = FakeInventory()
|
||||
mod2 = InventoryModule()
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
side_effect=fake_co_with_a,
|
||||
):
|
||||
with patch.object(mod2, "_read_config_data", return_value={"include_stopped": True}):
|
||||
mod2.parse(inv2, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_debug_paths_and_no_host(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
# One container with no name and no id to hit host==None path
|
||||
containers = [{}]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"filters": {"include": {"name": "nomatch"}}}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
# Nothing added
|
||||
assert inv.hostvars == {}
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_check_output_exception_path(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
side_effect=RuntimeError("boom"),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
with patch.object(mod, "_read_config_data", return_value={}):
|
||||
with pytest.raises(AnsibleParserError):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_filter_include_only_and_label_match(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["svc"], "Id": "x1", "Image": "reg/ns/app:1", "Status": "Up", "Labels": {"tier": "be"}},
|
||||
{"Names": ["svc2"], "Id": "x2", "Image": "reg/ns/oth:1", "Status": "Up", "Labels": {"tier": "fe"}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"filters": {"include": {"label.tier": "be", "image": "reg/*"}}}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
assert list(inv.hostvars.keys()) == ["svc"]
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_group_by_image_and_label_skip_branches(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
# One without Image to skip image grouping, and one without target label for label grouping
|
||||
containers = [
|
||||
{"Names": ["nolbl"], "Id": "y1", "Status": "Up", "Labels": {}},
|
||||
{"Names": ["haslbl"], "Id": "y2", "Image": "img", "Status": "Up", "Labels": {"other": "x"}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"group_by_image": True, "group_by_label": ["tier"]}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
# Image "img" should group when present; this asserts grouping executes while label grouping is skipped
|
||||
assert "image_img" in inv.groups
|
||||
assert "label_tier_x" not in inv.groups
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_keyed_groups_leading_trailing_separators(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["svc"], "Id": "x1", "Image": "img", "Status": "Up", "Labels": {"num": 7}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {
|
||||
"keyed_groups": [
|
||||
{
|
||||
"key": "labels.num",
|
||||
"prefix": "p",
|
||||
"separator": "-",
|
||||
"leading_separator": True,
|
||||
"trailing_separator": True,
|
||||
}
|
||||
]
|
||||
}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
# Expect group name sanitized; verify host assignment in some group containing 'p' and '7'
|
||||
assert any(("p" in g and "7" in g and "svc" in inv.groups[g]["hosts"]) for g in inv.groups)
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_filters_include_by_id_only(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["first"], "Id": "idaaa", "Image": "img1", "Status": "Up", "Labels": {}},
|
||||
{"Names": ["second"], "Id": "idbbb", "Image": "img2", "Status": "Up", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"filters": {"include": {"id": "ida*"}}}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
assert list(inv.hostvars.keys()) == ["first"]
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_name_falls_back_to_short_id_when_no_names(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
long_id = "1234567890abcdef1234567890abcdef"
|
||||
containers = [
|
||||
{"Id": long_id, "Image": "img", "Status": "Up", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
with patch.object(mod, "_read_config_data", return_value={}):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
# Host should be short id
|
||||
assert long_id[:12] in inv.hostvars
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_filters_unknown_key_path(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["x"], "Id": "idx", "Image": "img", "Status": "Up", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"filters": {"include": {"unknown": "val"}}}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
# Include with unknown key should exclude host
|
||||
assert inv.hostvars == {}
|
||||
|
||||
|
||||
@patch("ansible_collections.containers.podman.plugins.inventory.podman_containers.shutil.which", return_value="podman")
|
||||
def test_include_rules_status_only(mock_which):
|
||||
from ansible_collections.containers.podman.plugins.inventory.podman_containers import (
|
||||
InventoryModule,
|
||||
)
|
||||
|
||||
containers = [
|
||||
{"Names": ["run"], "Id": "r1", "Image": "img1", "Status": "Up 2s", "Labels": {}},
|
||||
{"Names": ["stop"], "Id": "s1", "Image": "img2", "Status": "Exited (0)", "Labels": {}},
|
||||
]
|
||||
with patch(
|
||||
"ansible_collections.containers.podman.plugins.inventory.podman_containers.subprocess.check_output",
|
||||
return_value=build_ps_json(containers),
|
||||
):
|
||||
inv = FakeInventory()
|
||||
mod = InventoryModule()
|
||||
cfg = {"include_stopped": True, "filters": {"include": {"status": "up*"}}}
|
||||
with patch.object(mod, "_read_config_data", return_value=cfg):
|
||||
mod.parse(inv, loader=None, path="dummy.yml", cache=False)
|
||||
assert list(inv.hostvars.keys()) == ["run"]
|
||||
Loading…
Add table
Add a link
Reference in a new issue