Release Template Management

Overview

Release Template Management is a tool in KOS Studio that allows administrators to define the collection of images(Templates) that make up a manufacturing release. Unlike over-the-air, or usb updates, manufacturing releases typically consist of multiple images, including an end-of-line image for testing the device during manufacturing, a production image to run once shipped, and a recovery image. A release template allows the user to place these images into the boot queue and install them onto a device in a single operation during the manufacturing process. Release Templates can then be used to create release versions and release candidates using the release management tool.

Understanding Release Templates

Before using the Release Manager – Templates tool, it’s helpful to understand what release templates are and how they work.

What Are Release Templates?

A release template is a reusable boot image queue configuration that defines:

  • Which images should be deployed to a device
  • The order and slot assignment for those images
  • The authority that signs the release
  • Hardware profile requirements
  • Whether the template is for testing or production release

Templates act as blueprints that you can use repeatedly to create new candidate releases without reconfiguring the image boot queue each time.

Why Use Release Templates?

Consistency:
Templates ensure that releases are created with the same image boot queue configuration each time, reducing errors and standardizing across devices.

Efficiency:
Instead of manually selecting and arranging images for each release, you apply a template, and the configuration is set automatically.

Template Components

Each release template includes:

Template Name:
A unique identifier for the template within your project.

Description:
Information about the template’s purpose and when to use it.

Authority:
The organization’s authority that will sign the releases created from this template. This should be provided as your organization’s current authority, or a delegated authority assigned to your organization.

Image Queue:
A collection of up to 10 image slots (indexed 0-9) that define the boot order for the device. After installation, the device boots from the lowest slot and can be programmed to boot from the next slot if a specific condition is met. For example, in end-of-line (EOL) testing, when all EOL tests pass, an engineer can mark EOL complete and deactivate the image, which could cause the device to boot from the next slot in the queue, potentially the production image. If a run-time error occurs, rendering the image non-bootable, the system rolls back to the next image in the queue until the recovery image, ensuring your device remains available without downtime. Slot 9 is reserved for the recovery image.

Status:
Indicates whether the template is configured for testing only or is releasable for production deployment. To create the production-signed manufacturing build, you must have access to the production-signed key for the same authority added to KOS Studio via Keyset Manager. In case of absence of the production keys users can create release candidates with test keys.

Hardware Profile:
All images in a template must match the same hardware profile (board and architecture) to ensure compatibility.

Visibility State:
Templates can be hidden to remove them from the Release Manager without deleting them.

Lock State:
Templates can be locked to prevent modifications while still allowing them to be used for creating releases.

Project Scope

Release templates are project-specific:

  • Templates created in one project are only available within that project
  • Users in other projects cannot see or use your project’s templates
  • This keeps templates organized and prevents confusion across different product lines or teams

Template Usage in Release Manager

Once created, templates become available in the Release Manager tool where they can be used to create new candidate releases quickly. The Release Manager reads the template configuration and applies it to the release creation process.

Accessing Release Manager – Templates

Opening the Tool

  1. Log into KOS Studio as an administrator
  2. In the upper-left corner, click Tools
  3. Select Release Manager – Templates

The Release Manager – Templates window opens, displaying all templates in your current project.

Note: This tool is only available to organization administrators.

Understanding the Interface

The Release Manager – Templates interface is organized into three main areas:

Templates List (Left Panel)

Displays all release templates in your current project:

  • Templates are sorted alphabetically by name
  • Each template shows its name and lock or hidden status
  • Hidden templates display with a closed eye icon
  • Locked templates display with a lock icon

Template Details (Center Panel)

Shows comprehensive information about the selected template:

  • Template name
  • Associated authority (displayed as a tag)
  • Created by username
  • Description
  • Queue status
  • Filled/total slots in the queue (e.g., “7/10 slots filled”)
  • Image Queue: Displays 10 numbered slots (0-9) where images can be assigned:
    • Slot 9 is marked for “Recovery Image.”
    • Each slot shows the assigned image (if any)
    • Images can be dragged and dropped into slots
    • Images already added to the queue appear disabled in the available images list

Available Images List (Right Panel)

Shows the scrollable list of all images in your project that can be added to the template:

  • Searchable and filterable
  • Images already in the queue appear disabled
  • Images can be dragged into queue slots

Creating a Release Template

Initial Empty State

When you first access Release Manager – Templates and no templates exist:

  • You see a message indicating no templates are available

Creating Your First Template

To create a new release template:

  1. Click Create new template button
  2. In the “Create new template” dialog, enter:
    • Name (required) – Must be unique within your project
    • Description (optional) – Explain the template’s purpose and when to use it
    • Authority (defaults to your organization’s authority) – Can be changed if needed
  3. Click Create
  4. This creates a new template in the templates list, which displays,
  • An empty queue with 10 slots (indexed 0-9) is displayed
  • Slot 9 is marked for “Recovery Image”
  • All slots indicate that images need to be added
  • The available images list appears, ready for you to add images

Duplicate Prevention:
You cannot create a template with a name that already exists in your project. Choose a unique, descriptive name.

Cancellation:
You can cancel template creation at any time by clicking “Cancel” in the create dialog.

Building the Image Boot Queue

After creating a template, configure which images should be deployed:

Adding Images to the Queue:

  1. Locate the desired image in the available images list
  2. Drag the image to an empty slot in the queue
  3. The image appears in that slot
  4. The image becomes disabled in the available images list (to prevent duplicate assignments)

Removing Images from the Queue:

  1. Click the remove or delete action on an image in the queue
  2. The image is removed from that slot
  3. The slot returns to empty state
  4. The image becomes enabled again in the available images list

Reordering Images:

  1. Drag an image from one slot to another slot in the queue
  2. The images swap positions or shift accordingly
  3. Slot indexes remain unchanged (the image moves, not the slot number)

Using Search and Filter in Image List

To find specific images in the available images list:

Search:

  1. Use the search box above the images list
  2. Type keywords related to the image name
  3. The list filters to show only matching images

Filter:

  1. Click the filter button
  2. Select filtering criteria (such as image type, status, or other attributes)
  3. The list updates to show only images matching your filter

These features are especially helpful when working with large image libraries.

Understanding Queue Status

The template status indicator shows whether the template is ready for production:

Test Mode:
If the queue contains any test-only images (images that do not meet the Production collaboration), the status shows “Test Only”. Templates in this state can only be used for creating test releases.

Releasable:
When all images in the queue meet the Production Collaboration criteria, the status shows “Releasable”. These templates can be used to create production releases.

Hardware Profile Validation

All images in a template must match the same hardware profile:

What is Validated:

  • Board type
  • Architecture

Mismatch Warning:
If you add an image with a different hardware profile than the existing images in the queue, you receive a warning about the profile mismatch. This prevents creating templates that would fail during deployment due to hardware incompatibility.

Best Practice:
Only add images designed for the same target hardware to a single template.

Viewing Release Templates

Browsing Templates

When you open Release Manager – Templates with existing templates:

  • All templates in your project are listed in the left panel
  • Templates are sorted alphanumerically
  • The first template is automatically selected (if any exist)
  • You can scroll through the list if templates exceed screen space

Selecting a Template

To view a specific template:

  1. Click on the template name in the templates list
  2. The template details appear in the center panel
  3. The image queue displays all assigned images
  4. The available images list shows images that can be added

Template Details Display

When viewing a template, you see:

Basic Information:

  • Template name
  • Associated authority (shown as a tag)
  • Username of the person who created the template
  • Description text

Queue Information:

  • Status (Test Only or Releasable)
  • Number of filled slots vs. total slots (e.g., “7/10”)
  • Visual representation of the queue with all images

Image States:

  • Images in the queue are shown in their assigned slots
  • Those same images appear disabled in the available images list
  • This prevents duplicate assignments and shows which images are already used

Editing Release Templates

Opening Template for Editing

To modify an existing template:

  1. Select the template from the templates list
  2. Click the Edit button (or edit icon)
  3. The template opens in edit mode

Editable Fields

When editing a template, you can modify:

Name:
Change the template name (must remain unique within your project).

Description:
Update the explanation of the template’s purpose.

Authority:
Change which organization authority signs releases created from this template.

Hide:
Toggle the visibility of the template.

Lock:
Toggle whether the template can be modified.

Queue:
Add, remove, reorder, or pin images in the queue (unless the template is locked).

Saving Changes

After making modifications:

  1. Click Save (or Update)
  2. Changes are immediately applied
  3. The updated template information appears instantly in the templates list
  4. Changes also reflect immediately in the Release Manager tool

This real-time update ensures that anyone using the Release Manager sees the latest template configuration.

Canceling Edits

If you want to discard changes:

  • Click Cancel
  • All modifications are discarded
  • The template returns to its previous state

Managing Template Visibility

Hiding a Template

To hide a template from the Release Manager:

  1. Select the template
  2. Click Edit
  3. Enable the Hide option
  4. Click Save

What happens:

  • The template appears in the templates list with a closed eye icon
  • The template no longer appears in the Release Manager tool
  • Users cannot select it when creating releases
  • Administrators can still see and manage it in Release Manager – Templates

When to hide templates:

  • Deprecating old configurations without deleting them
  • Temporarily removing templates from use

Unhiding a Template

To make a hidden template visible again:

  1. Select the hidden template (shown with closed eye icon)
  2. Click Edit
  3. Disable the Hide option
  4. Click Save

What happens:

  • The closed eye icon disappears
  • The template reappears in the Release Manager tool
  • Users can select it when creating releases

Managing Template Lock State

Locking a Template

To prevent modifications to a template:

  1. Select the template
  2. Click Edit
  3. Enable the Lock option
  4. Click Save

What happens when locked:

  • You cannot add, remove, or reorder images in the queue
  • You cannot change any information in the edit dialog
  • The template can still be used normally in the Release Manager
  • The template displays with a lock icon

When to lock templates:

  • Finalizing a production configuration
  • Preventing accidental changes to tested templates
  • Maintaining stability for critical release configurations

Unlocking a Template

To allow modifications again:

  1. Select the locked template
  2. Click Edit
  3. Disable the Lock option
  4. Click Save

What happens when unlocked:

  • You can modify the queue (add, remove, reorder images)
  • You can change template information
  • The template can still be used in the Release Manager
  • The lock icon disappears

Template Availability in Release Manager

Automatic Synchronization

Release templates created or updated in Release Manager – Templates automatically become available in the Release Manager tool:

New Templates:
When you create a new template, it appears instantly in the Release Manager’s template selection list.

Updated Templates:
When you edit an existing template, the changes appear immediately in the Release Manager, ensuring users always work with the latest configuration.

Hidden Templates:
When you hide a template, it immediately disappears from the Release Manager’s template selection, preventing users from selecting it.

This real-time synchronization ensures consistency across the tools.

Offline Behavior

The Release Manager – Templates tool continues to function with limited capabilities when KOS Studio loses connection to the KOS Server:

Available Offline:

  • View all previously synced release templates
  • Browse template details and configurations
  • Review image queues and assignments
  • Access templates that were loaded before going offline

Disabled Offline:

  • Cannot create new release templates
  • Cannot edit existing templates
  • Cannot save changes to templates
  • Cannot load templates not previously synced

Indicators:

  • Standard offline indicators appear per KOS Studio conventions
  • Disabled features are clearly marked
  • Appropriate messaging explains limited functionality

Features Not Requiring Sync:
Some operations that don’t require server connection may remain enabled, such as viewing and navigating through cached template data.

Practical Usage Scenarios

Creating Standard Device Boot Queue Configurations

For organizations with consistent device deployments:

  1. Create a template for each standard configuration
  2. Name templates descriptively (e.g., “Production-v2.1-Standard”, “Testing-Development”)
  3. Configure the boot image queue with your standard image set
  4. Lock the template to prevent accidental changes
  5. Use the template repeatedly in Release Manager to create consistent releases

Managing Test vs. Production Templates

To separate testing and production workflows:

  1. Create test templates with test-only images for development
  2. Create production templates with all releasable images
  3. Use clear naming conventions (e.g., prefix with “TEST-” or “PROD-“)
  4. Keep test templates unhidden for development teams
  5. Lock production templates to maintain stability

Hardware-Specific Templates

When working with multiple hardware profiles:

  1. Create separate templates for each hardware type
  2. Name templates to indicate hardware (e.g., “ARM-DeviceA”, “x86-DeviceB”)
  3. Only add images matching that hardware profile to each template
  4. Use descriptions to document hardware requirements
  5. Filter or search templates by hardware type when needed

Template Evolution

When updating device configurations over time:

  1. Create a new template version rather than modifying the existing one
  2. Use version numbers in template names (e.g., “Standard-v1.0”, “Standard-v2.0”)
  3. Hide old versions when they’re deprecated
  4. Keep old templates for historical reference or rollback
  5. Lock templates that are no longer actively developed

Collaborative Template Management

When multiple administrators manage templates:

  1. Use descriptive names and thorough descriptions
  2. Document the “Created by” information for questions
  3. Lock finalized templates to prevent conflicting changes
  4. Hide templates that shouldn’t be used but need to be kept
  5. Communicate template changes to teams using the Release Manager

Tips for Effective Template Management

  • Use clear naming conventions: Include version numbers, hardware types, or deployment environments in template names
  • Write detailed descriptions: Explain when to use each template, what makes it different, and any special considerations
  • Validate hardware profiles early: Check that all images match before adding many images to the queue
  • Use the recovery slot: Always assign a recovery image to slot 9 for device safety
  • Lock production templates: Prevent accidental changes to templates used for production releases
  • Hide deprecated templates: Keep old templates hidden rather than deleting them for historical reference
  • Test before locking: Thoroughly test a template configuration before locking it
  • Regular review: Periodically review templates to hide or delete unused ones
  • Consistent image naming: Ensure images have clear names so the queue is easy to understand