enable commentstart check on scheduling API group

Signed-off-by: liyuerich <yue.li@daocloud.io>

Kubernetes-commit: d61e923692317b6608e648f570d56b79f56e6287
This commit is contained in:
liyuerich
2026-07-16 18:17:42 +08:00
committed by Kubernetes Publisher
parent 5d73d31b74
commit 77256e6094
23 changed files with 64 additions and 64 deletions

View File

@@ -35,7 +35,7 @@ import (
// integer value. The value can be any valid integer.
type PriorityClassApplyConfiguration struct {
metav1.TypeMetaApplyConfiguration `json:""`
// Standard object's metadata.
// metadata is the standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*metav1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
// value represents the integer value of this priority class. This is the actual priority that pods

View File

@@ -24,7 +24,7 @@ package v1alpha3
// CompositeGangSchedulingPolicy indicates that the groups belonging to the composite group
// should be scheduled using all-or-nothing semantics.
type CompositeGangSchedulingPolicyApplyConfiguration struct {
// MinGroupCount is the minimum number of child groups that must be schedulable
// minGroupCount is the minimum number of child groups that must be schedulable
// or scheduled at the same time for the scheduler to admit the entire group.
// It must be a positive integer.
MinGroupCount *int32 `json:"minGroupCount,omitempty"`

View File

@@ -36,12 +36,12 @@ import (
// CompositePodGroup API enablement is toggled by the CompositePodGroup feature gate.
type CompositePodGroupApplyConfiguration struct {
v1.TypeMetaApplyConfiguration `json:""`
// Standard object's metadata.
// metadata is the standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
// Spec defines the desired state of the CompositePodGroup.
// spec defines the desired state of the CompositePodGroup.
Spec *CompositePodGroupSpecApplyConfiguration `json:"spec,omitempty"`
// Status represents the current observed state of the CompositePodGroup.
// status represents the current observed state of the CompositePodGroup.
Status *CompositePodGroupStatusApplyConfiguration `json:"status,omitempty"`
}

View File

@@ -28,10 +28,10 @@ import (
// CompositePodGroupSchedulingPolicy defines the scheduling configuration for a CompositePodGroup.
// Exactly one policy must be set.
type CompositePodGroupSchedulingPolicyApplyConfiguration struct {
// Basic specifies that the groups of this composite group should be scheduled independently.
// basic specifies that the groups of this composite group should be scheduled independently.
// This field is immutable.
Basic *schedulingv1alpha3.CompositeBasicSchedulingPolicy `json:"basic,omitempty"`
// Gang specifies that the groups of this composite group should be scheduled using
// gang specifies that the groups of this composite group should be scheduled using
// all-or-nothing semantics.
Gang *CompositeGangSchedulingPolicyApplyConfiguration `json:"gang,omitempty"`
}

View File

@@ -23,28 +23,28 @@ package v1alpha3
//
// CompositePodGroupSpec defines the desired state of CompositePodGroup.
type CompositePodGroupSpecApplyConfiguration struct {
// ParentCompositePodGroupName contains the name of the parent composite pod group
// parentCompositePodGroupName contains the name of the parent composite pod group
// within the same namespace as this composite pod group. It must be a DNS name.
// If it's nil, then this composite pod group is a root of a workload's hierarchy.
// This field is immutable.
ParentCompositePodGroupName *string `json:"parentCompositePodGroupName,omitempty"`
// WorkloadRef references an optional CompositePodGroup template within the
// workloadRef references an optional CompositePodGroup template within the
// Workload object that was used to create the CompositePodGroup.
// This field is required.
// This field is immutable.
WorkloadRef *WorkloadReferenceApplyConfiguration `json:"workloadRef,omitempty"`
// SchedulingPolicy defines the scheduling policy for this instance of the CompositePodGroup.
// schedulingPolicy defines the scheduling policy for this instance of the CompositePodGroup.
// Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate.
// This field is immutable.
SchedulingPolicy *CompositePodGroupSchedulingPolicyApplyConfiguration `json:"schedulingPolicy,omitempty"`
// PriorityClassName defines the priority that should be considered when scheduling this CompositePodGroup.
// priorityClassName defines the priority that should be considered when scheduling this CompositePodGroup.
// Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate.
// If left unspecified, it is validated and resolved similarly to the PriorityClassName field in Pods
// (i.e. if no priority class is specified, admission control can set this to the global default
// priority class if it exists. Otherwise, the composite pod group's priority will be zero).
// This field is immutable.
PriorityClassName *string `json:"priorityClassName,omitempty"`
// Priority is the value of priority of this composite pod group. Various system components
// priority is the value of priority of this composite pod group. Various system components
// use this field to find the priority of the composite pod group. When Priority Admission
// Controller is enabled, it prevents users from setting this field. The admission
// controller populates this field from PriorityClassName.

View File

@@ -27,7 +27,7 @@ import (
//
// CompositePodGroupStatus represents information about the status of a composite pod group.
type CompositePodGroupStatusApplyConfiguration struct {
// Conditions represent the latest observations of the CompositePodGroup's state.
// conditions represent the latest observations of the CompositePodGroup's state.
//
// Known condition types:
// - "CompositePodGroupInitiallyScheduled": Indicates whether the overall scheduling requirement

View File

@@ -23,30 +23,30 @@ package v1alpha3
//
// CompositePodGroupTemplate represents a template for a CompositePodGroup with a scheduling policy.
type CompositePodGroupTemplateApplyConfiguration struct {
// Name is a unique identifier for the CompositePodGroupTemplate within the Workload.
// name is a unique identifier for the CompositePodGroupTemplate within the Workload.
// It must be a DNS label. This field is required.
Name *string `json:"name,omitempty"`
// SchedulingPolicy defines the scheduling policy for this template.
// schedulingPolicy defines the scheduling policy for this template.
SchedulingPolicy *CompositePodGroupSchedulingPolicyApplyConfiguration `json:"schedulingPolicy,omitempty"`
// PriorityClassName indicates the priority that should be considered when scheduling
// priorityClassName indicates the priority that should be considered when scheduling
// a composite pod group created from this template. If no priority class is specified,
// admission control can set this to the global default priority class if it exists.
// Otherwise, composite pod groups created from this template will have the priority set
// to zero.
// This field is immutable.
PriorityClassName *string `json:"priorityClassName,omitempty"`
// Priority is the value of priority of composite pod groups created from this template.
// priority is the value of priority of composite pod groups created from this template.
// Various system components use this field to find the priority of the composite pod group.
// When Priority Admission Controller is enabled, it prevents users from setting this field.
// The admission controller populates this field from PriorityClassName.
// The higher the value, the higher the priority.
// This field is immutable.
Priority *int32 `json:"priority,omitempty"`
// PodGroupTemplates is the list of templates for children PodGroups.
// podGroupTemplates is the list of templates for children PodGroups.
// The maximum number of templates is 8. At least one entry in CompositePodGroupTemplates
// or PodGroupTemplates must be set.
PodGroupTemplates []PodGroupTemplateApplyConfiguration `json:"podGroupTemplates,omitempty"`
// CompositePodGroupTemplates is the list of templates for children CompositePodGroups.
// compositePodGroupTemplates is the list of templates for children CompositePodGroups.
// The maximum number of templates is 8. At least one entry in CompositePodGroupTemplates
// or PodGroupTemplates must be set.
CompositePodGroupTemplates []CompositePodGroupTemplateApplyConfiguration `json:"compositePodGroupTemplates,omitempty"`

View File

@@ -28,9 +28,9 @@ import (
// DisruptionMode defines how individual entities within a group can be disrupted.
// Exactly one mode can be set.
type DisruptionModeApplyConfiguration struct {
// Single specifies that children can be disrupted independently from each other.
// single specifies that children can be disrupted independently from each other.
Single *schedulingv1alpha3.SingleDisruptionMode `json:"single,omitempty"`
// All specifies that all children can only be disrupted together.
// all specifies that all children can only be disrupted together.
All *schedulingv1alpha3.AllDisruptionMode `json:"all,omitempty"`
}

View File

@@ -23,7 +23,7 @@ package v1alpha3
//
// GangSchedulingPolicy defines the parameters for gang scheduling.
type GangSchedulingPolicyApplyConfiguration struct {
// MinCount is the minimum number of pods that must be schedulable or scheduled
// minCount is the minimum number of pods that must be schedulable or scheduled
// at the same time for the scheduler to admit the entire group.
// It must be a positive integer. This field is mutable to support workload scaling.
//

View File

@@ -36,12 +36,12 @@ import (
// PodGroup API enablement is toggled by the GenericWorkload feature gate.
type PodGroupApplyConfiguration struct {
v1.TypeMetaApplyConfiguration `json:""`
// Standard object's metadata.
// metadata is the standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
// Spec defines the desired state of the PodGroup.
// spec defines the desired state of the PodGroup.
Spec *PodGroupSpecApplyConfiguration `json:"spec,omitempty"`
// Status represents the current observed state of the PodGroup.
// status represents the current observed state of the PodGroup.
Status *PodGroupStatusApplyConfiguration `json:"status,omitempty"`
}

View File

@@ -30,17 +30,17 @@ package v1alpha3
// own Spec.ResourceClaims. The Pod's claim must match all fields of the
// PodGroup's claim exactly.
type PodGroupResourceClaimApplyConfiguration struct {
// Name uniquely identifies this resource claim inside the PodGroup.
// name uniquely identifies this resource claim inside the PodGroup.
// This must be a DNS_LABEL.
Name *string `json:"name,omitempty"`
// ResourceClaimName is the name of a ResourceClaim object in the same
// resourceClaimName is the name of a ResourceClaim object in the same
// namespace as this PodGroup. The ResourceClaim will be reserved for the
// PodGroup instead of its individual pods.
//
// Exactly one of ResourceClaimName and ResourceClaimTemplateName must
// be set.
ResourceClaimName *string `json:"resourceClaimName,omitempty"`
// ResourceClaimTemplateName is the name of a ResourceClaimTemplate
// resourceClaimTemplateName is the name of a ResourceClaimTemplate
// object in the same namespace as this PodGroup.
//
// The template will be used to create a new ResourceClaim, which will

View File

@@ -25,11 +25,11 @@ package v1alpha3
// PodGroupResourceClaim which references a ResourceClaimTemplate. It stores the
// generated name for the corresponding ResourceClaim.
type PodGroupResourceClaimStatusApplyConfiguration struct {
// Name uniquely identifies this resource claim inside the PodGroup. This
// name uniquely identifies this resource claim inside the PodGroup. This
// must match the name of an entry in podgroup.spec.resourceClaims, which
// implies that the string must be a DNS_LABEL.
Name *string `json:"name,omitempty"`
// ResourceClaimName is the name of the ResourceClaim that was generated for
// resourceClaimName is the name of the ResourceClaim that was generated for
// the PodGroup in the namespace of the PodGroup. If this is unset, then
// generating a ResourceClaim was not necessary. The
// podgroup.spec.resourceClaims entry can be ignored in this case.

View File

@@ -23,7 +23,7 @@ package v1alpha3
//
// PodGroupSchedulingConstraints defines scheduling constraints (e.g. topology) for a PodGroup.
type PodGroupSchedulingConstraintsApplyConfiguration struct {
// Topology defines the topology constraints for the pod group.
// topology defines the topology constraints for the pod group.
// Currently only a single topology constraint can be specified. This may change in the future.
Topology []TopologyConstraintApplyConfiguration `json:"topology,omitempty"`
}

View File

@@ -30,11 +30,11 @@ import (
// Basic or Gang field. The PodGroup may not change policy after creation.
// Fields within chosen policy may be updated after creation when their individual fields allow it.
type PodGroupSchedulingPolicyApplyConfiguration struct {
// Basic specifies that the pods in this group should be scheduled using
// basic specifies that the pods in this group should be scheduled using
// standard Kubernetes scheduling behavior. Setting this field at group creation time
// opts this group to basic scheduling; this field cannot be changed afterward.
Basic *schedulingv1alpha3.BasicSchedulingPolicy `json:"basic,omitempty"`
// Gang specifies that the pods in this group should be scheduled using
// gang specifies that the pods in this group should be scheduled using
// all-or-nothing semantics. Setting this field at group creation time
// opts this group to gang scheduling; this field cannot be set or unset afterward.
// The minCount field within Gang scheduling policy remains mutable after group creation.

View File

@@ -27,25 +27,25 @@ import (
//
// PodGroupSpec defines the desired state of a PodGroup.
type PodGroupSpecApplyConfiguration struct {
// ParentCompositePodGroupName contains the name of the parent composite pod group
// parentCompositePodGroupName contains the name of the parent composite pod group
// within the same namespace as this pod group.
// If it's nil, then this pod group is a root of a workload's hierarchy.
// This field is used only when the CompositePodGroup feature gate is enabled.
// This field is immutable.
ParentCompositePodGroupName *string `json:"parentCompositePodGroupName,omitempty"`
// WorkloadRef references an optional PodGroup template within the Workload
// workloadRef references an optional PodGroup template within the Workload
// object that was used to create the PodGroup.
// This field is immutable.
WorkloadRef *WorkloadReferenceApplyConfiguration `json:"workloadRef,omitempty"`
// SchedulingPolicy defines the scheduling policy for this instance of the PodGroup.
// schedulingPolicy defines the scheduling policy for this instance of the PodGroup.
// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
SchedulingPolicy *PodGroupSchedulingPolicyApplyConfiguration `json:"schedulingPolicy,omitempty"`
// SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroup.
// schedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroup.
// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
// This field is immutable.
// This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.
SchedulingConstraints *PodGroupSchedulingConstraintsApplyConfiguration `json:"schedulingConstraints,omitempty"`
// ResourceClaims defines which ResourceClaims may be shared among Pods in
// resourceClaims defines which ResourceClaims may be shared among Pods in
// the group. Pods consume the devices allocated to a PodGroup's claim by
// defining a claim in its own Spec.ResourceClaims that matches the
// PodGroup's claim exactly. The claim must have the same name and refer to
@@ -56,26 +56,26 @@ type PodGroupSpecApplyConfiguration struct {
//
// This field is immutable.
ResourceClaims []PodGroupResourceClaimApplyConfiguration `json:"resourceClaims,omitempty"`
// DisruptionMode defines the mode in which a given PodGroup can be disrupted.
// disruptionMode defines the mode in which a given PodGroup can be disrupted.
// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
// One of Single, All. Defaults to Single if unset.
// This field is immutable.
DisruptionMode *DisruptionModeApplyConfiguration `json:"disruptionMode,omitempty"`
// PriorityClassName defines the priority that should be considered when scheduling this pod group.
// priorityClassName defines the priority that should be considered when scheduling this pod group.
// Controllers are expected to fill this field by copying it from a PodGroupTemplate.
// Otherwise, it is validated and resolved similarly to the PriorityClassName on PodGroupTemplate
// (i.e. if no priority class is specified, admission control can set this to the global default
// priority class if it exists. Otherwise, the pod group's priority will be zero).
// This field is immutable.
PriorityClassName *string `json:"priorityClassName,omitempty"`
// Priority is the value of priority of this pod group. Various system components
// priority is the value of priority of this pod group. Various system components
// use this field to find the priority of the pod group. When Priority Admission
// Controller is enabled, it prevents users from setting this field. The admission
// controller populates this field from PriorityClassName.
// The higher the value, the higher the priority.
// This field is immutable.
Priority *int32 `json:"priority,omitempty"`
// PreemptionPolicy is the Policy for preempting pods/podgroups with lower priority.
// preemptionPolicy is the Policy for preempting pods/podgroups with lower priority.
// One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
// When Priority Admission Controller is enabled, it populates this field from PriorityClassName,
// and defaults to PreemptLowerPriority if value is unset in PriorityClass.

View File

@@ -27,7 +27,7 @@ import (
//
// PodGroupStatus represents information about the status of a pod group.
type PodGroupStatusApplyConfiguration struct {
// Conditions represent the latest observations of the PodGroup's state.
// conditions represent the latest observations of the PodGroup's state.
//
// Known condition types:
// - "PodGroupInitiallyScheduled": Indicates whether the scheduling requirement has been satisfied.
@@ -46,7 +46,7 @@ type PodGroupStatusApplyConfiguration struct {
// - "PreemptionByScheduler": The PodGroup was preempted by the scheduler to make room for
// higher-priority PodGroups or Pods.
Conditions []v1.ConditionApplyConfiguration `json:"conditions,omitempty"`
// Status of resource claims.
// resourceClaimStatuses is status of resource claims.
ResourceClaimStatuses []PodGroupResourceClaimStatusApplyConfiguration `json:"resourceClaimStatuses,omitempty"`
}

View File

@@ -27,16 +27,16 @@ import (
//
// PodGroupTemplate represents a template for a set of pods with a scheduling policy.
type PodGroupTemplateApplyConfiguration struct {
// Name is a unique identifier for the PodGroupTemplate within the Workload.
// name is a unique identifier for the PodGroupTemplate within the Workload.
// It must be a DNS label. This field is immutable.
Name *string `json:"name,omitempty"`
// SchedulingPolicy defines the scheduling policy for this PodGroupTemplate.
// schedulingPolicy defines the scheduling policy for this PodGroupTemplate.
SchedulingPolicy *PodGroupSchedulingPolicyApplyConfiguration `json:"schedulingPolicy,omitempty"`
// SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroupTemplate.
// schedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroupTemplate.
// This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.
// This field is immutable.
SchedulingConstraints *PodGroupSchedulingConstraintsApplyConfiguration `json:"schedulingConstraints,omitempty"`
// ResourceClaims defines which ResourceClaims may be shared among Pods in
// resourceClaims defines which ResourceClaims may be shared among Pods in
// the group. Pods consume the devices allocated to a PodGroup's claim by
// defining a claim in its own Spec.ResourceClaims that matches the
// PodGroup's claim exactly. The claim must have the same name and refer to
@@ -47,20 +47,20 @@ type PodGroupTemplateApplyConfiguration struct {
//
// This field is immutable.
ResourceClaims []PodGroupResourceClaimApplyConfiguration `json:"resourceClaims,omitempty"`
// DisruptionMode defines the mode in which a given PodGroup can be disrupted.
// disruptionMode defines the mode in which a given PodGroup can be disrupted.
// One of Single, All.
// This field is immutable.
DisruptionMode *DisruptionModeApplyConfiguration `json:"disruptionMode,omitempty"`
// PriorityClassName indicates the priority that should be considered when scheduling
// priorityClassName indicates the priority that should be considered when scheduling
// a pod group created from this template.
// This field is immutable.
PriorityClassName *string `json:"priorityClassName,omitempty"`
// Priority is the value of priority of pod groups created from this template. Various
// priority is the value of priority of pod groups created from this template. Various
// system components use this field to find the priority of the pod group.
// The higher the value, the higher the priority.
// This field is immutable.
Priority *int32 `json:"priority,omitempty"`
// PreemptionPolicy is the Policy for preempting pods/podgroups with lower priority.
// preemptionPolicy is the Policy for preempting pods/podgroups with lower priority.
// One of Never, PreemptLowerPriority.
// This field is immutable.
// This field is available only when the PodGroupPreemptionPolicy feature gate is enabled.

View File

@@ -23,7 +23,7 @@ package v1alpha3
//
// TopologyConstraint defines a topology constraint for a PodGroup.
type TopologyConstraintApplyConfiguration struct {
// Key specifies the key of the node label representing the topology domain.
// key specifies the key of the node label representing the topology domain.
// All pods within the PodGroup must be colocated within the same domain instance.
// Different PodGroups can land on different domain instances even if they derive from the same PodGroupTemplate.
// Examples: "topology.kubernetes.io/rack"

View File

@@ -23,15 +23,15 @@ package v1alpha3
//
// TypedLocalObjectReference allows to reference typed object inside the same namespace.
type TypedLocalObjectReferenceApplyConfiguration struct {
// APIGroup is the group for the resource being referenced.
// apiGroup is the group for the resource being referenced.
// If APIGroup is empty, the specified Kind must be in the core API group.
// For any other third-party types, setting APIGroup is required.
// It must be a DNS subdomain.
APIGroup *string `json:"apiGroup,omitempty"`
// Kind is the type of resource being referenced.
// kind is the type of resource being referenced.
// It must be a path segment name.
Kind *string `json:"kind,omitempty"`
// Name is the name of resource being referenced.
// name is the name of resource being referenced.
// It must be a path segment name.
Name *string `json:"name,omitempty"`
}

View File

@@ -36,10 +36,10 @@ import (
// Workload API enablement is toggled by the GenericWorkload feature gate.
type WorkloadApplyConfiguration struct {
v1.TypeMetaApplyConfiguration `json:""`
// Standard object's metadata.
// metadata is the standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
// Spec defines the desired behavior of a Workload.
// spec defines the desired behavior of a Workload.
Spec *WorkloadSpecApplyConfiguration `json:"spec,omitempty"`
}

View File

@@ -24,12 +24,12 @@ package v1alpha3
// WorkloadReference references the Workload object together with the template
// that was used to create a particular PodGroup.
type WorkloadReferenceApplyConfiguration struct {
// WorkloadName is the name of the Workload object that contains a template
// workloadName is the name of the Workload object that contains a template
// that was used when creating a pod group. It must
// be a DNS name.
// This field is required.
WorkloadName *string `json:"workloadName,omitempty"`
// TemplateName is the name of a template within the Workload object that
// templateName is the name of a template within the Workload object that
// was used to create a pod group. It must be a DNS label.
// This field is required.
TemplateName *string `json:"templateName,omitempty"`

View File

@@ -23,17 +23,17 @@ package v1alpha3
//
// WorkloadSpec defines the desired state of a Workload.
type WorkloadSpecApplyConfiguration struct {
// ControllerRef is an optional reference to the controlling object, such as a
// controllerRef is an optional reference to the controlling object, such as a
// Deployment or Job. This field is intended for use by tools like CLIs
// to provide a link back to the original workload definition.
// This field is immutable.
ControllerRef *TypedLocalObjectReferenceApplyConfiguration `json:"controllerRef,omitempty"`
// PodGroupTemplates is the list of templates that make up the Workload.
// podGroupTemplates is the list of templates that make up the Workload.
// The maximum number of templates is 8. Templates cannot be added or removed after the workload is created.
// Existing templates may still be updated where their individual fields allow it.
// Exactly one of CompositePodGroupTemplates and PodGroupTemplates must be set.
PodGroupTemplates []PodGroupTemplateApplyConfiguration `json:"podGroupTemplates,omitempty"`
// CompositePodGroupTemplates is the list of CompositePodGroup templates that make up the Workload.
// compositePodGroupTemplates is the list of CompositePodGroup templates that make up the Workload.
// The maximum number of templates is 8. This field is immutable.
// Exactly one of CompositePodGroupTemplates and PodGroupTemplates must be set.
//

View File

@@ -36,7 +36,7 @@ import (
// integer value. The value can be any valid integer.
type PriorityClassApplyConfiguration struct {
v1.TypeMetaApplyConfiguration `json:""`
// Standard object's metadata.
// metadata is the standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
// value represents the integer value of this priority class. This is the actual priority that pods