Fleet Plans

🚧 Coming Soon

This feature will be available in production soon. Stay tuned for updates!

The Environment Fleet Management feature provides a way to perform bulk operations across multiple environments in parallel. It is designed for scenarios where users manage many active environments and need consistent updates, visibility, and control at scale. Using fleet plans, users can define environment targets through filters (projects, templates, and labels), configure common actions such as variable updates, template version changes, or resource operations, and schedule these updates with controlled concurrency. This enables reliable, efficient, and trackable management of large environment fleets without manual intervention on individual environments.

New Fleet Plan¶

Use the Fleet Plans page to create and configure a new plan for managing multiple environments in parallel.

In the left navigation pane, select Fleet Plans -> Environments
Click New Fleet Plan
In the dialog box:
- Name: Enter a unique identifier for the fleet plan (e.g., demo-fp2)
- Resource Type: Select Environment
Click Create to proceed

General Information¶

This section displays the basic details of the fleet plan provided during creation.

Name: The unique identifier of the fleet plan (e.g., env-fleet).
Resource Type: The selected resource type. For environment fleet plans, this is fixed to environments.

Operation Workflow¶

The Operation Workflow defines the sequence of operations or tasks that a fleet plan will execute on the selected environments. Operations can be configured step by step and support different lifecycle actions such as upgrading template versions, updating variables, or managing resources.

Step 1: Access the Operation Workflow Section¶

From the Fleet Plan, select the Operation Workflow tab and click + Operation Workflow to create a new operation.

Select the Operation Type

Available Operation Types¶

The following operation types are supported:

Template Version Update: Switches the selected environments to a different version of their template. Example: If environments are based on template T1, this action allows updating them to a newer version of T1.

Note: Works only when all selected environments are derived from the same template.

Input Variable Update: Updates the values of environment input variables defined within the template.
- Multiple variables can be updated in a single operation.
- Supported value types: Text, JSON, HCL, and Expression.

Note: Requires that all selected environments are derived from the same template.

Resource Destroy: Destroys all resources that belong to the selected environments. Works for environments derived from single or multiple templates.
Resource Deploy: Re-deploys all resources that belong to the selected environments. Works for environments derived from single or multiple templates.

Single-Template vs Multi-Template Operations¶

Single-template operations:
- Template Version Update
- Environment Variable Update

These operations can only be executed when all target environments are based on a single template and version.

Multi-template operations:
- Resource Destroy
- Resource Deploy

These operations work regardless of whether environments are based on one or multiple templates.

Step 2: Operation Configuration¶

Each operation supports the following fields:

Action Name: Identifier for the operation.
Description: Optional details about the operation.
Continue on Failure: If enabled, the workflow proceeds even if this operation fails. If disabled, execution stops at the point of failure.
Configuration: Operation-specific parameters such as:
- Version (for Template Version Update)
- Variable Key, Value, and Value Type (for Input Variable Update)

After saving, operations appear in the Operation Workflow list.

Environment Filters¶

This section allows you to define which environments are included in the fleet plan by applying filters. The filtering works at three levels:

Projects (Mandatory) – You must select at least one project.
Labels (Mandatory) – You must also apply label filters to further narrow down environments.
Templates (Optional) – You can add a template filter to refine the selection.

⚠️ Note: The operations list supports only a single environment template (ET)–based operation. This means only one template filter can be applied at a time.

Once the filters are selected:

All matching environments appear under Target Environments.
If multiple projects are chosen, the list aggregates environments from all of them.
Applying labels further narrows down the target set.
Adding a template filter (if used) restricts results to environments created from that specific template and version.

The Target Environments table displays the final computed list of environments based on the applied filters, along with their labels, template name, and version.

Adding a Schedule¶

You can configure schedules for your fleet plan using the Add Schedule wizard. A schedule allows you to automatically deploy environments based on a defined frequency.

General¶

Name: Enter a unique name for the schedule.
Description: (Optional) Provide a description to identify the schedule’s purpose.

Frequency¶

Define how often the schedule should run:

One Time: The schedule will run once.
- Time to Live (TTL): Specify how long (in hours/days) the deployed environment should remain active.
- Time Zone: Specify the time zone for the schedule.
Recurring: The schedule will repeat at the defined interval.
- Cron Expression: You can specify a cron expression for fine-grained scheduling.
- Time Zone: Select the time zone for the recurrence.

Actions¶

Deploy: Deploys the fleet plan. All actions defined in the operation workflow of the fleet plan will be executed (for example, provisioning or configuration).

Advanced Options¶

The Advanced Options section allows you to configure the Target Batch Size, which defines how many environments are processed in parallel during deployment.

Description: Enables batch execution of targets by defining the number of environments to process at the same time.
Default: If no value is provided, the system defaults to 5.
Custom Value: You can update the value to any number (for example, 1, 3, 10) based on your requirements.
Behavior:
- The specified number of environments will be processed in parallel.
- Remaining environments will wait until the current batch completes before starting.
- Example: If there are 10 targets and the batch size is set to 5: * Two batches will be created, each containing 5 targets. * The second batch will only start execution once the first batch has completed successfully.

Note: Setting a higher batch size can speed up deployments, but may also increase load on resources.

YAML and Form Options

In the Fleet Plan page, you can choose between two modes to define or update configurations:

Form – Provides a structured, guided UI to input values.
YAML – Allows direct editing of the YAML definition for advanced users.

When you click YAML, the editor opens up the raw YAML view of the Fleet Plan

Error Handling Between YAML and Form

If a user inputs incorrect or invalid information directly in the YAML, those errors may not automatically translate into the Form view.

In such cases, when switching back to the Form, a dialog box will appear indicating that the YAML contains errors that are not compatible with the form view.

Once operations are defined, click Save and Review Changes

Properties Page¶

Once a Fleet Plan is saved, users are redirected to the Properties page. This page provides a summary of the configuration defined in the plan.

The following details are displayed:

Projects: The selected project(s) associated with the fleet plan
Resources: The resources linked to the fleet plan
Labels: Labels applied to the fleet plan for identification and filtering
Operations: The configured operation(s). This includes the number of operations defined in the workflow
Template: The template used, if applicable
Target Batch Size: The batch size defined for executing targets
- By default, the batch size is set to 5
- This parameter can be defined either in the YAML or Form view.
Schedules: Displays the recurring schedules, if any. If no schedules are defined, it will show “No recurring schedules.”

Run the Fleet¶

Click the Run button to start a fleet job. The job will then appear in the list with its execution details.

Job Overview¶

Clicking the eye icon in the Actions column opens the Job Overview page. This view provides detailed insights into the selected job run. The job execution summary provides a snapshot of resource statuses, including the total number of resources and their state. Supported states include:

Success – The resource completed execution successfully.
Failed – The resource execution failed.
Pending – The resource is queued and awaiting execution.
Waiting – The resource is waiting for available capacity to execute.
In Progress – The resource is currently being executed.
Skipped – The resource execution was skipped.
Cancelled – The resource execution was cancelled.

A pie chart visualization and counters show the distribution across these states.

Once a job is successfully executed, the associated environments are updated based on the operations defined in the job. Users can then verify the Environments page to confirm the status of each applied action.