AppWrapper API

Resource Types

Appears in:

AppWrapper is the Schema for the appwrappers API

Field	Description
`spec` [Required] `AppWrapperSpec`	No description provided.
`status` [Required] `AppWrapperStatus`	No description provided.

Appears in:

AppWrapperComponent describes a single wrapped Kubernetes resource

Field	Description
`annotations` `map[string]string`	Annotations is an unstructured key value map that may be used to store and retrieve arbitrary metadata about the Component to customize its treatment by the AppWrapper controller.
`podSets` `[]AppWrapperPodSet`	DeclaredPodSets for the Component (optional for known GVKs whose PodSets can be automatically inferred)
`podSetInfos` `[]AppWrapperPodSetInfo`	PodSetInfos assigned to the Component's PodSets by Kueue
`template` [Required] `k8s.io/apimachinery/pkg/runtime.RawExtension`	Template defines the Kubernetes resource for the Component

Appears in:

AppWrapperComponentStatus tracks the status of a single managed Component

Field	Description
`name` [Required] `string`	Name is the name of the Component
`kind` [Required] `string`	Kind is the Kind of the Component
`apiVersion` [Required] `string`	APIVersion is the APIVersion of the Component
`podSets` [Required] `[]AppWrapperPodSet`	PodSets is the validated PodSets for the Component (either from AppWrapperComponent.DeclaredPodSets or inferred by the controller)
`conditions` `[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition`	Conditions hold the latest available observations of the Component’s current state. The type of the condition could be ResourcesDeployed: The component is deployed on the cluster

(Alias of string)

Appears in:

AppWrapperPhase enumerates the valid Phases of an AppWrapper

Appears in:

AppWrapperPodSet describes a homogeneous set of pods

Field	Description
`replicas` `int32`	Replicas is the number of pods in this PodSet
`path` [Required] `string`	Path is the path within Component.Template to the PodTemplateSpec for this PodSet
`annotations` `map[string]string`	Annotations is an unstructured key value map that may be used to store and retrieve arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.

Appears in:

AppWrapperPodSetInfo contains the data that Kueue wants to inject into an admitted PodSpecTemplate

Field	Description
`annotations` `map[string]string`	Annotations to be added to the PodSpecTemplate
`labels` `map[string]string`	Labels to be added to the PodSepcTemplate
`nodeSelector` `map[string]string`	NodeSelectors to be added to the PodSpecTemplate
`tolerations` `[]k8s.io/api/core/v1.Toleration`	Tolerations to be added to the PodSpecTemplate
`schedulingGates` `[]k8s.io/api/core/v1.PodSchedulingGate`	SchedulingGates to be added to the PodSpecTemplate

Appears in:

AppWrapperSpec defines the desired state of the AppWrapper

Field	Description
`components` [Required] `[]AppWrapperComponent`	Components lists the components contained in the AppWrapper
`suspend` `bool`	Suspend suspends the AppWrapper when set to true
`managedBy` [Required] `string`	ManagedBy is used to indicate the controller or entity that manages the AppWrapper.

Appears in:

AppWrapperStatus defines the observed state of the AppWrapper

Field	Description
`phase` `AppWrapperPhase`	Phase of the AppWrapper object
`resettingCount` `int32`	Retries counts the number of times the AppWrapper has entered the Resetting Phase
`conditions` `[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition`	Conditions hold the latest available observations of the AppWrapper current state. The type of the condition could be QuotaReserved: The AppWrapper was admitted by Kueue and has quota allocated to it ResourcesDeployed: The contained resources are deployed (or being deployed) on the cluster PodsReady: All pods of the contained resources are in the Ready or Succeeded state Unhealthy: One or more of the contained resources is unhealthy DeletingResources: The contained resources are in the process of being deleted from the cluster
`componentStatus` [Required] `[]AppWrapperComponentStatus`	ComponentStatus parallels the Components array in the Spec and tracks the actually deployed resources