Skip to main content

Managing Image Templates

The Image Templates page is the primary workspace for managing your image definitions. It provides a comprehensive list of all templates configured in your environment, allowing you to monitor their status and access detailed configuration settings.

The Templates Table​

The central element of this page is the templates table. Each row represents a single image template and displays key information to help you identify and monitor your images.

Table Columns​

  1. Name: The user-defined name of the template. Clicking the name opens the Template Details page.
  2. Provider: The cloud provider for which the template is configured (e.g., AWS, Azure, GCP).
  3. OS: The operating system family (Linux or Windows).
  4. Distribution: The specific OS distribution and version (e.g., RHEL 8.x, Ubuntu 22.04).
  5. Build Status: A color-coded badge indicating the state of the most recent build attempt.
  6. Last Build Time: The timestamp of the most recent build completion or failure.

Status Badge Meanings​

The build status badges provide immediate visual feedback on the health of your templates:

  • IMAGE_CREATED (Green): The most recent build and test cycle completed successfully, and the image is ready for use.
  • IMAGE_BUILDING / TESTING / QUEUED (Yellow): An active process is currently running for this template.
  • IMAGE_ERROR / TEMPLATE_ERROR (Red): The last build attempt failed. This could be due to a component script error or a configuration issue.
  • TEMPLATE_CREATED (Gray): The template has been defined but no build has been triggered yet.

Search, Sort, and Filter​

To manage large numbers of templates, the interface provides comprehensive tools for locating specific items.

Filtering Controls​

You can narrow down the list of templates using the filter sidebar or dropdowns:

  • By Provider: View only templates for a specific cloud platform.
  • By OS Family: Filter by Linux or Windows templates.
  • By Build Status: Focus on templates with errors or those currently building.
  • EOL Distributions: A specific toggle allows you to show only templates using operating systems that have reached their End of Life. This is critical for security compliance.

Searching and Sorting​

The search bar allows you to find templates by name or description. You can also sort the table by any column, such as sorting by "Last Build Time" to see the most recently updated templates at the top.

Actions and Pagination​

At the top of the page, the Create Template button initiates the Template Builder wizard. This is the starting point for defining new image specifications.

The table supports pagination, allowing you to navigate through multiple pages of templates. You can adjust the number of items displayed per page using the selector at the bottom of the table.

Via API

You can query the list of templates and their current status using the GraphQL API. This allows you to programmatically monitor your image factory or integrate status information into your own tools.

query ListTemplates($filter: TemplateFilter) {
  templates(filter: $filter) {
    items {
      id
      name
      provider
      osFamily
      distribution
      latestImage {
        status
        createdAt
      }
    }
    totalCount
  }
}

By effectively using the search and filter capabilities, you can maintain control over a complex image catalog. The status badges ensure that you are always aware of any build failures that require your attention, while the EOL filter helps you stay ahead of operating system lifecycle changes.