Skip to content

Add Annotations to PodSet; editing pass on CRD comments #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Add Annotations to PodSet; editing pass on CRD comments #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 46 additions & 15 deletions api/v1beta2/appwrapper_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,57 +22,88 @@ import (
runtime "k8s.io/apimachinery/pkg/runtime"
)

// AppWrapperSpec defines the desired state of the appwrapper
// AppWrapperSpec defines the desired state of the AppWrapper
type AppWrapperSpec struct {
// Components lists the components in the job
// Components lists the components contained in the AppWrapper
Components []AppWrapperComponent `json:"components"`

// Suspend suspends the job when set to true
// Suspend suspends the AppWrapper when set to true
//+optional
Suspend bool `json:"suspend,omitempty"`
}

// AppWrapperComponent describes a wrapped resource
// AppWrapperComponent describes a single wrapped Kubernetes resource
type AppWrapperComponent struct {
// PodSets contained in the component
// 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.
//+optional
Annotations map[string]string `json:"annotations,omitempty"`

// PodSets contained in the Component
//+optional
PodSets []AppWrapperPodSet `json:"podSets,omitempty"`

// PodSetInfos assigned to the Component by Kueue
// PodSetInfos assigned to the Component's PodSets by Kueue
//+optional
PodSetInfos []AppWrapperPodSetInfo `json:"podSetInfos,omitempty"`

// +kubebuilder:pruning:PreserveUnknownFields
// +kubebuilder:validation:EmbeddedResource
// Template for the component
// Template defines the Kubernetes resource for the Component
Template runtime.RawExtension `json:"template"`
}

// AppWrapperPodSet describes an homogeneous set of pods
type AppWrapperPodSet struct {
// Replicas is the number of pods in the set
// Replicas is the number of pods in this PodSet
//+optional
Replicas *int32 `json:"replicas,omitempty"`

// ReplicaPath is the path to the replica count for the set
// ReplicaPath is the path within Component.Template to the replica count for this PodSet
//+optional
ReplicaPath string `json:"replicaPath,omitempty"`

// PodPath is the path to the PodTemplateSpec
// PodPath is the path Component.Template to the PodTemplateSpec for this PodSet
PodPath string `json:"podPath"`
}

// AppWrapperPodSetInfo contains the data that Kueue wants to inject into an admitted PodSpecTemplate
type AppWrapperPodSetInfo struct {
Annotations map[string]string `json:"annotations,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
// Annotations to be added to the PodSpecTemplate
//+optional
Annotations map[string]string `json:"annotations,omitempty"`
// Labels to be added to the PodSepcTemplate
//+optional
Labels map[string]string `json:"labels,omitempty"`
// NodeSelectors to be added to the PodSpecTemplate
//+optional
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
// Tolerations to be added to the PodSpecTemplate
//+optional
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}

// AppWrapperStatus defines the observed state of the appwrapper
type AppWrapperStatus struct {
// Phase of the AppWrapper object
//+optional
Phase AppWrapperPhase `json:"phase,omitempty"`

// Retries counts the number of times the AppWrapper has entered the Resetting Phase
//+optional
Retries int32 `json:"resettingCount,omitempty"`

// Conditions
// 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
//
//+optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

Expand Down
7 changes: 7 additions & 0 deletions api/v1beta2/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

52 changes: 40 additions & 12 deletions config/crd/bases/workload.codeflare.dev_appwrappers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,30 +50,45 @@ spec:
metadata:
type: object
spec:
description: AppWrapperSpec defines the desired state of the appwrapper
description: AppWrapperSpec defines the desired state of the AppWrapper
properties:
components:
description: Components lists the components in the job
description: Components lists the components contained in the AppWrapper
items:
description: AppWrapperComponent describes a wrapped resource
description: AppWrapperComponent describes a single wrapped Kubernetes
resource
properties:
annotations:
additionalProperties:
type: string
description: |-
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.
type: object
podSetInfos:
description: PodSetInfos assigned to the Component by Kueue
description: PodSetInfos assigned to the Component's PodSets
by Kueue
items:
description: AppWrapperPodSetInfo contains the data that Kueue
wants to inject into an admitted PodSpecTemplate
properties:
annotations:
additionalProperties:
type: string
description: Annotations to be added to the PodSpecTemplate
type: object
labels:
additionalProperties:
type: string
description: Labels to be added to the PodSepcTemplate
type: object
nodeSelector:
additionalProperties:
type: string
description: NodeSelectors to be added to the PodSpecTemplate
type: object
tolerations:
description: Tolerations to be added to the PodSpecTemplate
items:
description: |-
The pod this Toleration is attached to tolerates any taint that matches
Expand Down Expand Up @@ -114,28 +129,30 @@ spec:
type: object
type: array
podSets:
description: PodSets contained in the component
description: PodSets contained in the Component
items:
description: AppWrapperPodSet describes an homogeneous set
of pods
properties:
podPath:
description: PodPath is the path to the PodTemplateSpec
description: PodPath is the path Component.Template to
the PodTemplateSpec for this PodSet
type: string
replicaPath:
description: ReplicaPath is the path to the replica count
for the set
description: ReplicaPath is the path within Component.Template
to the replica count for this PodSet
type: string
replicas:
description: Replicas is the number of pods in the set
description: Replicas is the number of pods in this PodSet
format: int32
type: integer
required:
- podPath
type: object
type: array
template:
description: Template for the component
description: Template defines the Kubernetes resource for the
Component
type: object
x-kubernetes-embedded-resource: true
x-kubernetes-preserve-unknown-fields: true
Expand All @@ -144,7 +161,7 @@ spec:
type: object
type: array
suspend:
description: Suspend suspends the job when set to true
description: Suspend suspends the AppWrapper when set to true
type: boolean
required:
- components
Expand All @@ -153,7 +170,18 @@ spec:
description: AppWrapperStatus defines the observed state of the appwrapper
properties:
conditions:
description: Conditions
description: |-
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
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
Expand Down
Loading