Manage Patch Envelopes

​

Introduction

Patch envelopes let you package binary content and configuration files into versioned, activatable bundles and deliver them to running application instances on nodes. Instead of redeploying an application to update its configuration or binary files, you create a patch envelope containing the changed content and attach it to the application instances you want to update. Each patch envelope belongs to a project and can include one or more artifacts. An artifact is either an inline base64-encoded payload or a reference to a binary artifact. When you set an envelope to Active, EVE-OS (Edge Virtualization Engine) delivers its artifacts to all attached application instances on the node.

​

Prerequisites

• You have the SysManager or SysAdmin role in your enterprise. See Manage Roles.
• At least one project configured in Edge Infrastructure Services.

​

Access Patch Envelopes

In the sidebar, navigate to Infrastructure > Workloads > Build > Patch Envelopes.

​

Patch Envelope States

A patch envelope has one of three admin states.

​

The Patch Envelopes List

The patch envelope list shows the following columns by default. Use the column customizer to show or hide individual columns. You can search by name or title, filter by project name, and toggle between list and grid views.

​

Patch Envelope Detail

Click any row in the list to open the detail page.

​

Identity

The identity section shows the following fields.

​

Artifacts

The artifacts section lists every artifact in the envelope. Each artifact shows its category (Inline or External), the content or referenced binary artifact, metadata, and the file name written on the node.

​

Create a Patch Envelope

A patch envelope groups artifacts into a versioned bundle that you deliver to application instances. Each artifact can be an inline base64-encoded payload or a reference to a binary artifact.

1. In the sidebar, navigate to Infrastructure > Workloads > Build > Patch Envelopes.
2. Click the add button (the + icon in the lower-right corner of the page). This opens the Add Patch Envelope page.
3. Fill in the required fields:
   • Name: enter a unique identifier using alphanumeric characters and hyphens. This field is required.
   • Title: enter a human-readable display name. This field is required.
   • Project: select the project this patch envelope belongs to. This field is required.
   • Description: enter an optional description.
   • Version: enter an optional version string.
4. Use the Activate Patch toggle to set the initial state:
   • Enabled: the envelope is created in the Active state and begins delivering to attached instances immediately.
   • Disabled: the envelope is created in the Stored state and does not deliver until you activate it.

​

Add artifacts to the envelope

Each artifact row defines one piece of content delivered to the application.

1. In the Artifacts table, each row has a Category selector:
   • Inline: embed a base64-encoded payload directly. Enter the base64 data in the Details field and set the File Name the artifact will be written as on the node.
   • External: reference a binary artifact. Click the Details field to search for and select a binary artifact, then set the File Name.
2. Optionally, enter Meta Data for the artifact row to associate key-value metadata with the delivered content.
3. To add more artifact rows, click the + icon at the end of the last row.
4. To remove an artifact row, click the × icon on that row.

​

Submit the patch envelope

After adding all artifacts, click Add Patch Envelope. Edge Infrastructure Services creates the patch envelope and navigates to the patch envelope detail page.

​

Edit a Patch Envelope

You can edit a patch envelope’s title, description, and active state from either the list or the detail page.

1. In the patch envelope list, hover over the row and click the action menu (⋯), then select Edit. Or open the detail page and click the edit icon in the page header.
2. In the Edit Patch Envelope dialog, update the Title or Description as needed.
3. Use the Activate Patch toggle to change the state between Active and Stored.
4. Click Save.

​

Delete a Patch Envelope

You cannot delete a patch envelope that has nodes attached. When deletion is blocked, a tooltip on the delete button shows the number of attached devices. Delete from the list:

1. Navigate to Infrastructure > Workloads > Build > Patch Envelopes.
2. Open the kebab menu on the row of the envelope you want to delete and select Delete.
3. Confirm the deletion in the dialog that appears. This action cannot be undone.

To delete multiple patch envelopes at once, select the checkbox next to each envelope you want to delete and select Delete from the toolbar that appears. Delete from the detail page:

1. Open the detail page for the envelope you want to delete.
2. Click the delete icon in the page header.
3. Confirm the deletion in the dialog that appears. This action cannot be undone.

​

Next Steps