Documentation

apk - Manages apk packages

New in version 2.0.

Synopsis

  • Manages apk packages for Alpine Linux.

Options

parameter required default choices comments
available
(added in 2.4)
no
  • yes
  • no
During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them) if the currently installed package is no longer available from any repository.
name
no
A package name, like foo, or mutliple packages, like foo, bar.
repository
(added in 2.4)
no
A package repository or multiple repositories
state
no present
  • present
  • absent
  • latest
Indicates the desired package(s) state.
present ensures the package(s) is/are present.
absent ensures the package(s) is/are absent.
latest ensures the package(s) is/are present and the latest version(s).
update_cache
no
  • yes
  • no
Update repository indexes. Can be run with other steps or on it's own.
upgrade
no
  • yes
  • no
Upgrade all installed packages to their latest version.

Examples

# Update repositories and install "foo" package
- apk:
    name: foo
    update_cache: yes

# Update repositories and install "foo" and "bar" packages
- apk:
    name: foo,bar
    update_cache: yes

# Remove "foo" package
- apk:
    name: foo
    state: absent

# Remove "foo" and "bar" packages
- apk:
    name: foo,bar
    state: absent

# Install the package "foo"
- apk:
    name: foo
    state: present

# Install the packages "foo" and "bar"
- apk:
    name: foo,bar
    state: present

# Update repositories and update package "foo" to latest version
- apk:
    name: foo
    state: latest
    update_cache: yes

# Update repositories and update packages "foo" and "bar" to latest versions
- apk:
    name: foo,bar
    state: latest
    update_cache: yes

# Update all installed packages to the latest versions
- apk:
    upgrade: yes

# Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available
- apk:
    available: yes
    upgrade: yes

# Update repositories as a separate step
- apk:
    update_cache: yes

# Install package from a specific repository
- apk:
    name: foo
    state: latest
    update_cache: yes
    repository: http://dl-3.alpinelinux.org/alpine/edge/main

Return Values

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

name description returned type sample
packages a list of packages that have been changed when packages have changed list ['package', 'other-package']


Notes

Note

  • “name” and “upgrade” are mutually exclusive.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.