Ansible Execution Environment

Ansible execution-environment.yml file

Type v3 | v1
File match **/execution-environment.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-execution-environment/latest.json
Source https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/execution-environment.json

Validate with Lintel

npx @lintel/lintel check
Type: v3 | v1

See https://docs.ansible.com/projects/builder/en/latest/definition/ for V3 or https://legacy-controller-docs.ansible.com/automation-controller/ for older V1 format.

One of

1. Ansible Execution Environment Schema v3 object
2. Ansible Execution Environment Schema v1 object

Definitions

TYPE_DictOrStringOrListOfStrings object | string | string[]
TYPE_StringOrListOfStrings string | string[]
v1 object
dependencies object required

Allows adding system, python or galaxy dependencies.

3 nested properties
galaxy string

Example requirements.yml

Examples: "requirements.yml"
python string

Example requirements.txt

Examples: "requirements.txt"
system string

Example bindep.txt

Examples: "bindep.txt"
version integer required
Values: 1
additional_build_steps object
2 nested properties
append string | string[]
prepend string | string[]
ansible_config string
Examples: "ansible.cfg"
build_arg_defaults object
1 nested properties
EE_BASE_IMAGE string
v3 object
dependencies object required

Allows adding system, python or galaxy dependencies.

6 nested properties
ansible_core object

Ansible package installation

One of: variant
1 nested properties
package_pip string

Ansible package to install via pip

ansible_runner object

Ansible Runner package installation

One of: variant
1 nested properties
package_pip string

Ansible Runner package to install via pip

galaxy object | string | string[]
python string | string[]
python_interpreter object

Python package name and path

2 nested properties
package_system string

The python package to install via system package manager

python_path string

Path to the python interpreter

system string | string[]
version integer required
Values: 3
additional_build_files object[]

Describes files to add to the build context

additional_build_steps object
8 nested properties
append_base string | string[]
append_builder string | string[]
append_final string | string[]
append_galaxy string | string[]
prepend_base string | string[]
prepend_builder string | string[]
prepend_final string | string[]
prepend_galaxy string | string[]
build_arg_defaults object
3 nested properties
ANSIBLE_GALAXY_CLI_COLLECTION_OPTS string
ANSIBLE_GALAXY_CLI_ROLE_OPTS string
PKGMGR_PRESERVE_CACHE string
images object
1 nested properties
base_image object
options object

Options that effect runtime behavior

8 nested properties
container_init object

Customize container startup behavior

3 nested properties
cmd string

literal value for CMD Containerfile directive

entrypoint string

literal value for ENTRYPOINT Containerfile directive

package_pip string

package to install via pip for entrypoint support

package_manager_path string

Path to the system package manager to use

relax_passwd_permissions boolean

allows GID0 write access to /etc/passwd; currently necessary for many uses

skip_ansible_check boolean

Disables the check for Ansible/Runner in final image

skip_pip_install boolean

Disables the installation of pip in the base image

user string

Sets the username or UID

workdir string | null

Default working directory, also often the homedir for ephemeral UIDs

tags string[]

A list of names to assign to the resulting image if build process completes successfully

Examples

"execution-environment.yml"