DisaggregatedSet API

Generated API reference documentation for disaggregatedset.x-k8s.io/v1.

Resource Types

DisaggregatedSet

Appears in:

DisaggregatedSet is the Schema for the disaggregatedsets API

FieldDescription
apiVersion
string
disaggregatedset.x-k8s.io/v1
kind
string
DisaggregatedSet
spec [Required]
DisaggregatedSetSpec

spec defines the desired state of DisaggregatedSet

status
DisaggregatedSetStatus

status defines the observed state of DisaggregatedSet

DisaggregatedRoleSpec

Appears in:

DisaggregatedRoleSpec defines the configuration for a disaggregated role. This structure embeds LeaderWorkerSetTemplateSpec from sigs.k8s.io/lws, with validation to reject unsupported fields (RolloutStrategy.Type must be RollingUpdate, RolloutStrategy.RollingUpdateConfiguration.Partition must not be set).

FieldDescription
name [Required]
string

Name is the unique identifier for this role.

LeaderWorkerSetTemplateSpec [Required]
LeaderWorkerSetTemplateSpec
(Members of LeaderWorkerSetTemplateSpec are embedded into this type.)

LeaderWorkerSetTemplateSpec defines the LWS template for this role. Note: Spec.RolloutStrategy.Type must be RollingUpdate (or empty) and Spec.RolloutStrategy.RollingUpdateConfiguration.Partition must not be set. DisaggregatedSet handles rollouts across roles.

DisaggregatedSetSpec

Appears in:

DisaggregatedSetSpec defines the desired state of DisaggregatedSet

FieldDescription
roles [Required]
[]DisaggregatedRoleSpec

Roles defines the list of roles (at least 2 required). Each role has a unique name and its own configuration.

slices
int32

Slices is the number of independent copies of the whole role topology. Each slice is a complete set of all roles that rolls out independently. Changing Slices scales copies up or down and does not trigger a rollout.

DisaggregatedSetStatus

Appears in:

DisaggregatedSetStatus defines the observed state of DisaggregatedSet.

FieldDescription
roleStatuses
[]RoleStatus

RoleStatuses contains the status for each role. The order matches spec.roles.

conditions
[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition

conditions represent the current state of the DisaggregatedSet resource. Each condition has a unique type and reflects the status of a specific aspect of the resource.

Standard condition types include:

  • "Available": the resource is fully functional
  • "Progressing": the resource is being created or updated
  • "Degraded": the resource failed to reach or maintain its desired state

The status of each condition is one of True, False, or Unknown.

RoleStatus

Appears in:

RoleStatus defines the observed state of a single role.

FieldDescription
name [Required]
string

Name is the name of the role (matches spec.roles[].name).

replicas
int32

Replicas is the total number of replicas for this role.

readyReplicas
int32

ReadyReplicas is the number of ready replicas for this role.

updatedReplicas
int32

UpdatedReplicas is the number of replicas updated to the latest revision.

Feedback

Was this page helpful?