rhaap:clean-up

Remove resources created during a software template execution from Ansible Automation Platform. Use this action as a cleanup step to delete projects, execution environments, or job templates.

Input parameters

Expand
Parameter Type Required Description
token string Yes OAuth2 token for Ansible Automation Platform authentication.
values object Yes Object specifying which resources to remove.

values object structure

Expand
Field Type Required Description
project object No Project to delete. Include projectName and organization.
executionEnvironment object No Execution environment to delete. Include environmentName and organization.
template object No Job template to delete. Include templateName and organization.

Output parameters

Expand
Parameter Type Description
cleanUp string Confirmation message indicating successful cleanup.

Example

steps:
  - id: cleanup
    name: Clean Up Resources
    action: rhaap:clean-up
    input:
      token: ${{ parameters.AAP_TOKEN }}
      values:
        project:
          projectName: ${{ steps['create-project'].output.data.name }}
          organization: ${{ parameters.organization | resourceFilter('name') }}
        template:
          templateName: ${{ steps['create-template'].output.data.name }}
          organization: ${{ parameters.organization | resourceFilter('name') }}