Chapter 6. Creating execution environment definitions in self-service automation portal

Procedure

1. Open the configuration file for your Helm chart.
2. Navigate to the default.main-menu-items section.

3. Set the value of the enabled key under the default.ee configuration block to true.

   Note

   Setting enabled: true enables the EE definition files feature for all users.

   Example

   The final configuration must look like the following example:

   default.main-menu-items:
     menuItems:
       default.mycatalog:
         title: Templates
         icon: home
         to: /self-service/catalog
         priority: 120
       default.myitem:
         title: History
         icon: category
         to: /self-service/create/tasks
         priority: 110
       default.ee:
         enabled: false

   Copy to Clipboard Toggle word wrap

Procedure

1. Log into the self-service automation portal and select EE definition files from the lefthand navigation pane.
2. If this is your first time creating an EE definition file, click Create Execution Environment definition file, otherwise select the Create tab.
3. Click Start on your preferred template.

4. Select your preferred base image and click Next.

   Note

   Red Hat recommends using the Red Hat Minimal EE base. If selecting Custom Image, it is important you fully understand what the contents of your base image are. For example, a base image without Ansible core or Ansible runner will fail to build.

5. Select a collection from Add popular Collections or Add Collection Manually and click Next.

   1. Optional: To add additional Python or System requirements, select Specify additional python requirements and system packages, and then click Add packages manually or Choose File.
6. Select your desired MCP servers and click Next.

7. Optional: In the Additional Build Steps section, you can specify custom build instructions that will be executed at specific steps during the build process:

   1. Select Add build Step.
   2. Select a step from the Step type drop-down list.
   3. Input a command you want to run at that step. You can provide a string of commands by giving each command a new line.
   4. Click Next.

8. In the Generate and publish section:

   1. Fill in the following mandatory fields:

      • EE File name
      • Description
      • Select source control provider
      • SCM repository organization name or username
      • Repository name
   2. Ensure the execution-environment tag is applied. Click the plus (+) icon to add additional tags if required.
   3. Ensure Publish to a Git repository is selected. If unselected, your EE will be provided as a download after the build process.
   4. If the Repository name you provided does not already exist, select Create new repository. If it does exist and you check the box, a pull request will be created instead.
   5. Click Next.
9. Confirm your details are correct and click Create. This begins the scaffolding process.
10. After the scaffolding is complete, click Getting started for next steps on how to build your EE definition.

1. In the self-service automation portal:

   1. Click View details in catalog or Download EE files (downloads the generated files as a .tar file).
   2. Alternatively, select EE definition files in the left-hand navigation pane. The new file appears in the Execution Environment definition files box.

2. In the repository:

   1. Click GitHub repository or Gitlab repository to confirm the files were scaffolded into your repository.

Procedure

1. Go to the repository where your <ee-name>-template.yaml is stored and open it.
2. Copy the URL of the template.yaml page.
3. Log into the self-service automation portal and select EE definition files from the lefthand navigation pane.
4. Click Create > Add Template.
5. Paste the template URL into the Select URL field and click Analyze.
6. Click Import.

Procedure

1. Log into the self-service automation portal and select EE definition files from the lefthand navigation pane.

2. Under the Name column, select the EE you want to take action on:

   • To download your EE definition, click Download EE files.
   • To delete your EE definition, click the icon and then select Unregister entity.

   • To copy your EE definition:

     • Click the icon and then select Copy entity URL.
     • Select EE definition files from the lefthand navigation pane.
     • Click Create and then Add template.
     • Paste your entity URL into the Select URL field and click Analyze.
     • Click Import. The new template now appears in the Execution Environment definition files page.