Skip to main content

AppVersion

The AppVersion represents the "Application Version" record and is an essential component designed for initiating the launch of an application. It has the title, description and icon that will be displayed on the workbench tile, along with the full name of the Docker image, including tag.

# Initialize version
version = AppVersion(
app_id="my-app-id",
version="1.0.0",
title="My Application Title",
description="This Is An Example Edge Application",
icon=ICON,
kind=AppKindEnum.Native,
link="quay.io/enthought/YOUR_IMAGE_NAME_HERE:TAG",
recommended_profile="edge.medium"
)

# Create version
edge.applications.add_app_version(version)

Properties

app_id

Property (str). Application UID.

version

Property (str). Version identifier.

title

Property (str). Version title.

description

Property (str). Detailed description.

icon

Property (str). Icon represented as a Base64-encoded string, supporting both PNG and JPEG formats.

kind

Property (AppKindEnum). Native or External app.

framework

Property (AppFrameworkEnum). Framework selection for edge proxy.

Property (str). External redirect or Native Image.

Property (str). Recommended profile name.

volume_mount_point

Property (str). Mount point for a persistent volume.

suggested_volume_size

Property (int). Default initial size in GB for a persistent volume.

Methods

to_dict

to_dict() -> dict

Translates the connection as a dictionary for serialization.

Returns

dict Connection contents as a dictionary.