Files
ansible_role_package/meta/argument_spec.yml
2026-01-25 01:38:28 -07:00

96 lines
3.0 KiB
YAML

# vim: set filetype=yaml.ansible :
---
argument_specs:
main:
short_description: Install software using ansible
description:
- Make the installation of packages consistent on each platform.
- Installs for RedHat, Debian and MacOS based systems.
author:
- Matthew Stobbs <matthew@stobbs.ca>
options:
packages:
type: list
elements: str
required: true
description:
- The list of packages to install by name.
- The list must contain only values that exist in B(Available Packages) in README.md
extra_packages:
type: list
elements: str
description:
- Extra system packages by installation name to install using the system package manager
flatpak_method:
type: str
default: system
description:
- Default installation method for flatpaks.
- Possible values are 'system' and 'user'
install_method:
type: str
default: system
choices:
- system
- source
- appimage
- flatpak
- cask
- snap
description:
- Default installation method for packages.
- Varies between each indivdual package, but this is for overall package installation.
- Possible values are V(system), V(source), V(appimage), V(flatpak), V(cask), V(snap)
install_prefix:
type: path
default: /usr/local
description:
- Default installation prefix when installation non-system packages.
store_path:
type: path
default: ANSIBLE_USER_DIR/.cache/ansible_role_package
description:
- Where to store cached files like archives and git repos
clean_source:
type: bool
default: false
description:
- Remove existing installation of package before installing
path_appimage:
type: path
default: INSTALL_PREFIX/appimage
description:
- Where appimage files are stored.
path_archive:
type: path
default: INSTALL_PREFIX/archive
description:
- Where archives are extracted.
path_bin:
type: path
default: INSTALL_PREFIX/bin
description:
- Where binaries are installed or linked.
- Needs to be added to your PATH
path_cargo:
type: path
default: INSTALL_PREFIX/cargo
description:
- Where cargo installs it's packages
path_go:
type: path
default: INSTALL_PREFIX/go
description:
- Where go is installed. Equivalent of GOROOT.
path_pipx:
type: path
default: INSTALL_PREFIX/pipx
description:
- Where pipx installs it's virtual environments
use_become:
type: bool
default: true
description:
- Elevate privileges when installing non-system packages.
- Building will be done as the ansible user, elevating only when installing.