Patch Envelopes are versioned bundles of files, scripts, or configuration that can be pushed to edge nodes and delivered into running applications without requiring a full app redeployment. They are attached to App Bundles and mounted as a volume inside the running app at a defined path. A patch envelope has a manifest that describes the included files and their target locations.

• A versioned bundle containing: binary files, config files, shell scripts, or any artifact
• Attached to an App Bundle definition; delivered inline to the running app via a volume mount
• The manifest describes each file: name, target path inside the app, and optional execution permissions
• Multiple versions of a patch envelope can coexist; the app bundle specifies which version to use
• Applied without restarting the app or redeploying the full App Bundle (for file delivery; script execution may require app-side handling)

1. Navigate to Objects > Patch Envelopes
2. Click Create Patch Envelope
3. Enter a name and version string
4. Upload one or more artifact files
5. Define the manifest: for each file, specify the target path inside the app
6. Click Save
7. To apply: edit the target App Bundle and add the patch envelope reference under Patch Envelopes
8. Re-deploy or update the App Instance to push the new envelope

resource "zedcloud_patch_envelope" "app_config" {
  name        = "app-config-v2"
  version     = "2"
  description = "Updated config files for workshop app"
  project_id  = zedcloud_project.workshop.id
 
  artifact {
    binary_artifact = filebase64("config/app.conf")
    file_name       = "app.conf"
    volume_path     = "/config/app.conf"
  }
}
 
# Reference in the App Bundle
resource "zedcloud_application" "workshop_app" {
  # ... other fields ...
  patch_envelope {
    patch_id = zedcloud_patch_envelope.app_config.id
    version  = "2"
  }
}

# Create the patch envelope
POST /v1/patchenvelopes
{
  "name": "app-config-v2",
  "version": "2",
  "projectId": "<project_id>",
  "artifacts": [
    {
      "artifactMetaData": {
        "fileName": "app.conf",
        "volumePath": "/config/app.conf"
      },
      "binaryArtifact": "<base64_encoded_content>"
    }
  ]
}

# Associate with an app bundle via the app definition
PATCH /v1/apps/{app_id}
{
  "patchEnvelopes": [
    { "patchId": "<envelope_id>", "version": "2" }
  ]
}

1. The controller delivers the patch envelope metadata and download reference to EVE-OS at next heartbeat
2. EVE-OS downloads the patch envelope bundle from the controller-internal store
3. EVE-OS mounts the patch envelope as a read-write volume inside the running app container or VM at the paths defined in the manifest
4. The app can read, execute, or process the delivered files immediately without restart
5. On update (new version assigned), EVE-OS delivers the new version and replaces the mounted files

• Images
• Edge Apps
• Persistent Volumes and Content Trees