Complete execution environment template reference

The full structure of a team execution environment template as generated by execution environment builder, with key fields and customization options.

Template structure

The ee-start-from-scratch.yaml template defines the full wizard experience, including base image selection, collection and dependency configuration, Git provider authentication, and automated build dispatch. Use this template as the starting point when creating custom templates for your teams.

For the complete template source, see Content from github.com is not included.ee-start-from-scratch.yaml in the Ansible RHDH Templates repository on GitHub.

The template contains the following sections:

  • metadata — template name, description, and tags used for catalog discovery.
  • spec.parameters — three wizard steps that define the form fields users see:
    • Base Image — base image selection with predefined Red Hat EE images and a custom image option.
    • Configuration — collection picker, Python requirements, system packages, and additional build steps.
    • Destination and Build — EE definition name, Git publishing options, registry configuration, and build trigger.
  • spec.steps — auto-generated actions that create the EE definition, publish to GitHub or GitLab, register the catalog component, and dispatch the build pipeline.
  • output — links to the repository, pull request or merge request, build workflow, and catalog entry.

To customize a template for your team, copy the template and modify the default: values in the parameters section. For example, pre-select collections, set a team-specific base image, or configure a default build registry. For details, see Create standardized execution environment templates for teams.

Key fields

Field Purpose
metadata.annotations.ansible.io/saved-template: 'true' Marks this as a user-saved template in the catalog.
metadata.annotations.ansible.io/download-experience: 'true' Use instead of saved-template for download-only templates (teams build locally with ansible-builder). Changes the UI to show Download and Delete actions.
collections[].source Specifies which automation hub repository to pull each collection from during builds.
buildRegistry 'Private Automation Hub (PAH)' or 'Custom Registry' (with customRegistryUrl).
registryTlsVerify Set to false for registries with self-signed certificates.
customBaseImage Pre-fill with your organization's internal base image URL when teams use private registries.
Note:

All parameter default: values pre-populate the wizard form. Users can override any value at runtime.