Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 3.43 KB

VmApplication.md

File metadata and controls

40 lines (31 loc) · 3.43 KB

VmApplication

A VM workload managed by the FlightCtl agent. The VM definition may be delivered either as an OCI image/artifact or as inline application content. For inline providers, the package must contain a KubeVirt VirtualMachine YAML file named vm.yaml.

Properties

Name Type Description Notes
name str The application name must be 1–253 characters long, start with a letter or number, and contain no whitespace. [optional]
app_type AppType
annotations Dict[str, str] Arbitrary metadata annotations. Used internally by the control plane (e.g., flightctl.io/workload-type) when transforming application types at render time. [optional] [readonly]
desired_state ApplicationDesiredState Desired lifecycle state for this application, as most recently set by the stop/start device APIs. Read-only: cannot be set directly by apply; only present in the rendered application spec delivered to the agent. [optional] [readonly]
restart_generation int Counter incremented by the restart device API each time the application is restarted. Read-only: cannot be set directly by apply; only present in the rendered application spec delivered to the agent. [optional] [readonly]
run_as str The username of the system user this application should be run under. This is not the same as the user within any containers of the application (if applicable). Defaults to the user that the agent runs as (generally root) if not specified. [optional]
publish_ports List[str] List of host-to-guest port mappings for the VM. Each entry must follow the format "hostPort:guestPort" or "hostPort:guestPort/protocol" (e.g. "8080:80" or "8080:80/tcp"). [optional]
image str Reference to an OCI image or artifact with tag.
delta_image str Optional hint: a reference to a delta artifact for the main image. Set by the control plane when a successful delta generation record exists for the current-to-target digest transition. Read-only: generated by the control plane and only present in the rendered application spec delivered to the agent. [optional] [readonly]
delta_images List[ImageDeltaHint] Optional hints for nested OCI images referenced by this inline application. Each entry identifies a target image reference and digest and names its delta artifact. Read-only: generated by the control plane and only present in the rendered application spec delivered to the agent. [optional] [readonly]
inline List[ApplicationContent] A list of application content.

Example

from flightctl.models.vm_application import VmApplication

# TODO update the JSON string below
json = "{}"
# create an instance of VmApplication from a JSON string
vm_application_instance = VmApplication.from_json(json)
# print the JSON string representation of the object
print(VmApplication.to_json())

# convert the object into a dict
vm_application_dict = vm_application_instance.to_dict()
# create an instance of VmApplication from a dict
vm_application_from_dict = VmApplication.from_dict(vm_application_dict)

[Back to Model list] [Back to API list] [Back to README]