✨Allow diskSetup to include partition layout by miltalex · Pull Request #11634 · kubernetes-sigs/cluster-api

miltalex · 2025-01-02T16:39:00Z

What this PR does / why we need it:

This PR enhances disk partitioning capabilities by introducing support for custom partition layouts through the new DiskLayout field. Previously, disk partitioning was limited to a boolean option that could only create a single partition for the entire device. This enhancement allows users to define multiple partitions with specific size percentages and partition types.
The changes align with cloud_init logic's disk setup specification, which supports both boolean and list-based partition layouts. The existing layout boolean field is maintained for backward compatibility, while the new diskLayout field provides advanced partitioning capabilities when needed.

Examples

Before (Single Partition):

partitions:
  - device: /dev/sda
    layout: true  # Creates a single partition using entire disk

After (Multiple Partitions):

partitions:
  - device: /dev/sda
    diskLayout:
      - percentage: 33
      - percentage: 33
        partitionType: 82
      - percentage: 33

Generated cloud-init output:

disk_setup:
  /dev/sda:
    layout:
      - 33
      - [33, 82]
      - 33

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #8524

linux-foundation-easycla · 2025-01-02T16:39:05Z

The committers listed above are authorized under a signed CLA.

✅ login: miltalex / name: Miltiadis Alexis (618f83b)

k8s-ci-robot · 2025-01-02T16:39:09Z

This PR is currently missing an area label, which is used to identify the modified component when generating release notes.

Area labels can be added by org members by writing /area ${COMPONENT} in a comment

Please see the labels list for possible areas.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot · 2025-01-02T16:39:09Z

Welcome @miltalex!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-01-02T16:39:10Z

Hi @miltalex. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

JoelSpeed

Some initial thoughts on the API changes within this PR

JoelSpeed · 2025-01-02T16:45:18Z

api/bootstrap/kubeadm/v1beta1/kubeadmconfig_types.go

+	// Percentage of disk that partition will take (1-100)
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=100
+	Percentage int32 `json:"percentage"`


You should include a required marker to show explicitly that this is required

JoelSpeed · 2025-01-02T16:45:57Z

bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go

+
+	// PartitionType is the numerical value of the partition type (optional)
+	// +optional
+	PartitionType *int32 `json:"partitionType,omitempty"`


What are the valid values for this value? And how would I, as an end user, understand those?

Is there a limit on this? Is 0 a valid value? Are negative values valid?

Actually I can use a string here to reflect the correct linux partition types. It was an attempt to purely map the disk layout as described in the cloud init docs.

There's a choice to make here. Either you can allow all of the valid values there, in which case this should be a 2 character lowercase hex value. Or, you can allow specific, common types, and do that by creating an Enum here and creating PascalCase aliases to the formats we actually want to support.

IMO, the latter provides a better UX

Updated the code to reflect common types using enum

JoelSpeed · 2025-01-02T16:46:46Z

bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go

 }

+// DiskLayout represents an array of partition specifications
+type DiskLayout []PartitionSpec


I would avoid a type alias to a slice, it makes it harder to understand the API when looking at the go types (it looks like a struct for example if I look at the Partition usage)

I will convert it to a struct

I just meant you could inline this slice, rather than using an alias, I don't think it needs to be a struct does it?

JoelSpeed · 2025-01-02T16:47:43Z

bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go

+
+// PartitionSpec defines the size and optional type for a partition
+type PartitionSpec struct {
+	// Percentage of disk that partition will take (1-100)


Godoc must start with the serialised version of the field name

Suggested change

// Percentage of disk that partition will take (1-100)

// percentage of disk that partition will take (1-100)

JoelSpeed · 2025-01-02T16:47:53Z

bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go

+	// +kubebuilder:validation:Maximum=100
+	Percentage int32 `json:"percentage"`
+
+	// PartitionType is the numerical value of the partition type (optional)


Suggested change

// PartitionType is the numerical value of the partition type (optional)

// partitionType is the numerical value of the partition type (optional)

JoelSpeed · 2025-01-02T16:49:00Z

api/bootstrap/kubeadm/v1beta1/kubeadmconfig_types.go

 	// layout specifies the device layout.
 	// If it is true, a single partition will be created for the entire device.
 	// When layout is false, it means don't partition or ignore existing partitioning.
 	Layout bool `json:"layout"`
+
+	// diskLayout specifies the percentage of disk space and partition types.


Is this list ordered?

Can you validate that the percentages sum to 100? Are they allowed to sum to less than 100?

yeah the list is strictly ordered added a check to validate sum is less than 100

k8s-triage-robot · 2025-06-11T16:22:16Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2025-07-11T16:55:47Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2025-08-10T17:45:46Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2025-08-10T17:45:51Z

@k8s-triage-robot: Closed this PR.

Details

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

miltalex · 2025-11-19T07:45:52Z

/reopen

k8s-ci-robot · 2025-11-19T07:45:58Z

@miltalex: Reopened this PR.

Details

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot · 2025-11-19T07:46:06Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign joelspeed for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

miltalex · 2025-11-19T12:29:09Z

/remove-lifecycle rotten

miltalex · 2025-11-27T21:43:24Z

@JoelSpeed I did a rebase and addressed your initial comments. I would appreciate a review whenever time permits

Signed-off-by: Miltiadis Alexis <alexmiltiadis@gmail.com>

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 2, 2025

k8s-ci-robot requested review from JoelSpeed and enxebre January 2, 2025 16:39

k8s-ci-robot added the do-not-merge/needs-area PR is missing an area label label Jan 2, 2025

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jan 2, 2025

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 2, 2025

JoelSpeed reviewed Jan 2, 2025

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 13, 2025

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 11, 2025

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 11, 2025

k8s-ci-robot closed this Aug 10, 2025

k8s-ci-robot reopened this Nov 19, 2025

miltalex force-pushed the feat/add-disk-layout branch from 3560524 to 55c44ce Compare November 19, 2025 09:34

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 19, 2025

miltalex force-pushed the feat/add-disk-layout branch from 55c44ce to 92a33aa Compare November 19, 2025 09:55

miltalex requested a review from JoelSpeed November 19, 2025 09:56

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Nov 19, 2025

feat: allow diskSetup to include partition layout

618f83b

Signed-off-by: Miltiadis Alexis <alexmiltiadis@gmail.com>

miltalex force-pushed the feat/add-disk-layout branch from 92a33aa to 618f83b Compare February 15, 2026 10:27

	// Percentage of disk that partition will take (1-100)
	// percentage of disk that partition will take (1-100)

	// PartitionType is the numerical value of the partition type (optional)
	// partitionType is the numerical value of the partition type (optional)

Comments

Conversation

miltalex commented Jan 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Jan 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Jan 2, 2025

Uh oh!

k8s-ci-robot commented Jan 2, 2025

Uh oh!

k8s-ci-robot commented Jan 2, 2025

Uh oh!

JoelSpeed left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

k8s-triage-robot commented Jun 11, 2025

Uh oh!

k8s-triage-robot commented Jul 11, 2025

Uh oh!

k8s-triage-robot commented Aug 10, 2025

Uh oh!

k8s-ci-robot commented Aug 10, 2025

Uh oh!

miltalex commented Nov 19, 2025

Uh oh!

k8s-ci-robot commented Nov 19, 2025

Uh oh!

k8s-ci-robot commented Nov 19, 2025

Uh oh!

miltalex commented Nov 19, 2025

Uh oh!

miltalex commented Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miltalex commented Jan 2, 2025 •

edited

Loading

linux-foundation-easycla bot commented Jan 2, 2025 •

edited

Loading