Create an image pipeline using the EC2 Image Builder console wizard - EC2 Image Builder

Create an image pipeline using the EC2 Image Builder console wizard

This tutorial walks you through creating an automated pipeline to build and maintain a customized EC2 Image Builder image using the Create image pipeline console wizard. To help you move through the steps efficiently, default settings are used when they are available, and optional sections are skipped.

Step 1: Specify pipeline details

  1. Open the EC2 Image Builder console at https://console.aws.amazon.com/imagebuilder/.

  2. To begin creating your pipeline, choose Create image pipeline.

  3. In the General section, enter your Pipeline name (required).

    Tip

    Enhanced metadata collection is turned on by default. To ensure compatibility between components and base images, keep it turned on.

  4. In the Build schedule section, you can keep the defaults for the Schedule options. Note that the Time zone shown for the default schedule is Universal Coordinated Time (UTC). For more information about UTC time, and to find the offset for your time zone, see Time Zone Abbreviations – Worldwide List.

    For Dependency update settings, choose the Run pipeline at the scheduled time if there are dependency updates option. This setting causes your pipeline to check for updates before starting the build. If there are no updates, it skips the scheduled pipeline build.

    Note

    To ensure that your pipeline recognizes dependency updates and builds as expected, you must use semantic versioning (x.x.x) for your base image and components. To learn more about semantic versioning for Image Builder resources, see Semantic versioning.

  5. Choose Next to proceed to the next step.

Step 2: Choose recipe

  1. Image Builder defaults to Use existing recipe in the Recipe section. For your first time through, choose the Create new recipe option.

  2. In the Image type section, choose the Amazon Machine Image (AMI) option to create an image pipeline that will produce and distribute an AMI.

  3. In the General section, enter the following required boxes:

    • Name – your recipe name

    • Version – your recipe version (use the format <major>.<minor>.<patch>, where major, minor, and patch are integer values). New recipes generally start with 1.0.0.

  4. In the Source image section, keep the default values for Select image, Image Operating System (OS), and Image origin. This results in a list of Amazon Linux 2 AMIs, managed by Amazon, for you to choose from for your base image.

    1. From the Image name dropdown, choose an image.

    2. Keep the default for Auto-versioning options (Use latest available OS version).

      Note

      This setting ensures that your pipeline uses semantic versioning for the base image, to detect dependency updates for automatically scheduled jobs. To learn more about semantic versioning for Image Builder resources, see Semantic versioning.

  5. In the Instance configuration section, keep the default values for the Systems Manager agent. This results in Image Builder keeping the Systems Manager agent after the build and tests are complete, to include the Systems Manager agent in your new image.

    Keep User data blank for this tutorial. You can use this area at other times to provide commands, or a command script to run when you launch your build instance. However, it replaces any commands that Image Builder might have added to ensure that Systems Manager is installed. When you do use it, make sure that the Systems Manager agent is preinstalled on your base image, or that you include the install in your user data.

  6. In the Components section, you must choose at least one build component.

    In the Build components – Amazon Linux panel, you can browse through the components listed on the page. Use the pagination control in the upper right corner to navigate through additional components that are available for your base image OS. You can also search for specific components, or create your own build component using the Component manager.

    For this tutorial, choose a component that updates Linux with the latest security updates, as follows:

    1. Filter the results by entering the word update in the search bar that's located at the top of the panel.

    2. Select the check box for the update-linux build component.

    3. Scroll down, and in the upper right corner of the Selected components list, choose Expand all .

    4. Keep the default for Versioning options (Use latest available component version).

      Note

      This setting ensures that your pipeline uses semantic versioning for the selected component, to detect dependency updates for automatically scheduled jobs. To learn more about semantic versioning for Image Builder resources, see Semantic versioning.

      If you had selected a component that has input parameters, you would also see the parameters in this area. Parameters are not covered in this tutorial. For more information about using input parameters in your components, and setting them in your recipes, see Manage AWSTOE component parameters with EC2 Image Builder.

    Reorder components (optional)

    If you have chosen more than one component to include in your image, you can use the drag-and-drop action to rearrange them into the order in which they should run during the build process.

    1. Scroll back up to the list of available components.

    2. Select the check box for the update-linux-kernel-mainline build component (or any other component of your choice).

    3. Scroll down to the Selected components list, to see that there are at least two results.

    4. Newly added components might not have their versioning or input parameter settings expanded. To expand Versioning options or Input parameters settings, you can either choose the arrow next to the name of the setting, or you can toggle the Expand all switch off and on to expand all of the settings for all of the selected components.

    5. Choose one of the components, and drag it up or down to change the order in which the components will run.

    6. To remove the update-linux-kernel-mainline component, choose X from the upper right corner of the component box.

    7. Repeat the previous step to remove any other components you might have added, leaving only the update-linux component selected.

  7. Choose Next to proceed to the next step.

Step 3: Define infrastructure configuration - optional

Image Builder launches EC2 instances in your account to customize images and run validation tests. The Infrastructure configuration settings specify infrastructure details for the instances that will run in your AWS account during the build process.

In the Infrastructure configuration section, the Configuration options default to Create infrastructure configuration using service defaults. This creates an IAM role and associated instance profile that are used by build instances to configure your EC2 AMIs. You can also create your own custom infrastructure configuration, or use settings that you have already created. For this tutorial, we are using the default settings.

  • Choose Next to proceed to the next step.

Step 4: Define distribution settings - optional

Distribution configurations include the output AMI name, specific Region settings for encryption, launch permissions, and AWS accounts, organizations, and organizational units (OUs) that can launch the output AMI, and license configurations.

In the Distribution settings section, the Configuration options default to Create distribution settings using service defaults. This option will distribute the output AMI to the current Region. For this tutorial, we are using the default settings.

  • Choose Next to proceed to the next step.

Step 5: Review

The Review section displays all of the settings you have configured. To edit information in any given section, choose the Edit button located in the top right corner of the step section. For example, if you want to change your pipeline name, choose the Edit button in the top right corner of the Step 1: Pipeline details section.

  1. When you have reviewed your settings, choose Create pipeline to create your pipeline.

  2. You can see success or failure messages at the top of the page, as your resources are created for distribution settings, infrastructure configuration, your new recipe, and the pipeline. To see details for a resource, including the resource identifier, choose View details.

  3. After you have viewed the details for a resource, you can view details about other resources by choosing the resource type from the navigation pane. For example, to see details for your new pipeline, choose Image pipelines from the navigation pane. If your build was successful, your new pipeline is displayed in the Image pipelines list.

Step 6: Clean up

Your Image Builder environment, just like your home, needs regular maintenance to help you find what you need, and complete your tasks without wading through clutter. Make sure to regularly clean up temporary resources that you created for testing. Otherwise, you might forget about those resources, and then later, not remember what they were used for. By then, it might not be clear if you can safely get rid of them.

Tip

To prevent dependency errors when you delete resources, make sure to delete your resources in the following order:

  1. Image pipeline

  2. Image recipe

  3. All remaining resources

To clean up the resources that you created for this tutorial, follow these steps:

Delete the pipeline

  1. To see a list of the build pipelines created under your account, choose Image pipelines from the navigation pane.

  2. Select the check box next to Pipeline name to select the pipeline that you want to delete.

  3. At the top of the Image pipelines panel, on the Actions menu, choose Delete.

  4. To confirm the deletion, enter Delete in the box, and choose Delete.

Delete the recipe

  1. To see a list of the recipes created under your account, choose Image recipes from the navigation pane.

  2. Select the check box next to Recipe name to select the recipe that you want to delete.

  3. At the top of the Image recipes panel, on the Actions menu, choose Delete recipe.

  4. To confirm the deletion, enter Delete in the box, and choose Delete.

Delete infrastructure configuration

  1. To see a list of the infrastructure configurations created under your account, choose Infrastructure configuration from the navigation pane.

  2. Select the check box next to Configuration name to select the infrastructure configuration that you want to delete.

  3. At the top of the Infrastructure configurations panel, choose Delete.

  4. To confirm the deletion, enter Delete in the box, and choose Delete.

Delete distribution settings

  1. To see a list of the distribution settings created under your account, choose Distribution settings from the navigation pane.

  2. Select the check box next to Configuration name to select the distribution settings that you created for this tutorial.

  3. At the top of the Distribution settings panel, choose Delete.

  4. To confirm the deletion, enter Delete in the box, and choose Delete.

Delete the image

Follow these steps to verify that you have deleted any image that was created from the tutorial pipeline. This tutorial is not likely to create an image unless enough time has elapsed since you created your pipeline that it runs, according to the build schedule.

  1. To see a list of the images created under your account, choose Images from the navigation pane.

  2. Choose the image Version for the image that you want to remove. This opens the Image build versions page.

  3. Select the check box next to the Version for any image that you want to delete. You can select more than one image version at a time.

  4. At the top of the Image build versions panel, choose Delete version.

  5. To confirm the deletion, enter Delete in the box, and choose Delete.