ARTESCA-14623 // implement Metalk8sVolumeProvider by hervedombya · Pull Request #4530 · scality/metalk8s

hervedombya · 2025-03-04T17:44:32Z

feat: implement K8SLocalVolumeProvider and remove Metalk8sLocalVolumeProvider

feat: add K8SLocalVolumeProvider implementation and associated tests

Component:

Context:

Summary:

Acceptance criteria:

Closes: #ISSUE_NUMBER

bert-e · 2025-03-04T17:44:35Z

Hello hervedombya,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options

name	description	privileged	authored
`/after_pull_request`	Wait for the given pull request id to be merged before continuing with the current one.
`/bypass_author_approval`	Bypass the pull request author's approval	⭐
`/bypass_build_status`	Bypass the build and test status	⭐
`/bypass_commit_size`	Bypass the check on the size of the changeset `TBA`	⭐
`/bypass_incompatible_branch`	Bypass the check on the source branch prefix	⭐
`/bypass_jira_check`	Bypass the Jira issue check	⭐
`/bypass_peer_approval`	Bypass the pull request peers' approval	⭐
`/bypass_leader_approval`	Bypass the pull request leaders' approval	⭐
`/approve`	Instruct Bert-E that the author has approved the pull request.		✍️
`/create_pull_requests`	Allow the creation of integration pull requests.
`/create_integration_branches`	Allow the creation of integration branches.
`/no_octopus`	Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
`/unanimity`	Change review acceptance criteria from `one reviewer at least` to `all reviewers`
`/wait`	Instruct Bert-E not to run until further notice.

Available commands

name	description	privileged
`/help`	Print Bert-E's manual in the pull request.
`/status`	Print Bert-E's current status in the pull request `TBA`
`/clear`	Remove all comments from Bert-E from the history `TBA`
`/retry`	Re-start a fresh build `TBA`
`/build`	Re-start a fresh build `TBA`
`/force_reset`	Delete integration branches & pull requests, and restart merge process from the beginning.
`/reset`	Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

bert-e · 2025-03-04T17:44:49Z

Request integration branches

Waiting for integration branch creation to be requested by the user.

To request integration branches, please comment on this pull request with the following command:

/create_integration_branches

Alternatively, the /approve and /create_pull_requests commands will automatically
create the integration branches.

JBWatenbergScality · 2025-03-05T08:40:39Z

ui/public/.well-known/micro-app-configuration

        "scope": "metalk8s"
      }
    },
+    "providers": {


Why do you need a new providers entry in the micro-app-configuration file ?

JBWatenbergScality · 2025-03-05T08:43:40Z

ui/src/services/k8s/K8SLocalVolumeProvider.test.ts

+
+      expect(volumes).toHaveLength(1);
+      expect(volumes[0]).toMatchObject({
+        IP: '192.168.1.100',


I think we can also return the k8s node name

JBWatenbergScality · 2025-03-05T08:44:15Z

ui/src/services/k8s/K8SLocalVolumeProvider.test.ts

+      expect(volumes[0]).toMatchObject({
+        IP: '192.168.1.100',
+        devicePath: '/dev/sda',
+        metadata: { name: 'test-volume' },


No need for the metadata layer, the name could be at the root and changed to pvName

JBWatenbergScality · 2025-03-05T08:45:36Z

ui/src/services/k8s/K8SLocalVolumeProvider.test.ts

+  });
+
+  describe('listLocalPersistentVolumes', () => {
+    it('should return local persistent volumes for a given node.', async () => {


We should have additional tests for sparseloopdevice and lvmLogicalVolume

JBWatenbergScality · 2025-03-05T08:45:56Z

ui/src/services/k8s/K8SLocalVolumeProvider.test.ts

+      ).rejects.toThrow('Failed to find IP for node non-existent-node');
+    });
+
+    it('should raise an error if volume recovery fails', async () => {


Suggested change

it('should raise an error if volume recovery fails', async () => {

it('should raise an error if volume retrieval fails', async () => {

JBWatenbergScality · 2025-03-05T08:46:41Z

ui/src/services/k8s/K8SLocalVolumeProvider.ts

+  ): Promise<LocalPersistentVolume[]>;
+}
+
+export default class K8SLocalVolumeProvider implements K8SLocalVolumeAdapter {


Suggested change

export default class K8SLocalVolumeProvider implements K8SLocalVolumeAdapter {

export default class Metalk8sLocalVolumeProvider implements K8SLocalVolumeAdapter {

JBWatenbergScality · 2025-03-05T08:48:15Z

ui/src/services/k8s/K8SLocalVolumeProvider.ts

+              {
+                ...isLocalPv,
+                IP: nodeIP.address,
+                devicePath: item.spec?.rawBlockDevice?.devicePath,


Missing handling sparseloopdevice and lvm volumes

You can refer to this documentation for data format of both https://metal-k8s.readthedocs.io/en/stable/operation/volume_management/volume_creation_deletion_cli.html

JBWatenbergScality · 2025-03-07T10:29:38Z

ui/src/services/k8s/Metalk8sLocalVolumeProvider.ts

+  nodeName: string;
+};
+
+export interface Metalk8sLocalVolumeAdapter {


The interface should not be linked to Metalk8s

JBWatenbergScality · 2025-03-07T10:31:08Z

ui/src/services/k8s/Metalk8sLocalVolumeProvider.ts

+              devicePath:
+                item.spec?.rawBlockDevice?.devicePath || item.metadata['name'],


I wonder if you might be missing an info on which adapter to use to retrieve the disk capacity.

I suggest to return the volumeType : 'rawBlockDevice' | 'sparseLoopDevice' | 'lvmLogicalVolume'

Use Virtual | Hardware

feat: implement K8SLocalVolumeProvider and remove Metalk8sLocalVolumeProvider feat: add K8SLocalVolumeProvider implementation and associated tests Add Metalk8sLocalVolumeProvider implementation and tests Enhance Metalk8sLocalVolumeProvider to support additional volume types and improve error handling in volume listing Remove Metalk8sLocalVolumeProvider entry from micro-app-configuration Add volumeType property to LocalPersistentVolume and refactor Metalk8sLocalVolumeProvider Refactor LocalPersistentVolume to use VolumeType enum for volumeType property

JBWatenbergScality · 2025-03-11T13:10:25Z

ui/src/services/k8s/Metalk8sLocalVolumeProvider.test.ts

+      const volumes = await provider.listLocalPersistentVolumes('test-node');
+
+      expect(volumes).toHaveLength(3);
+      expect(volumes[0]).toMatchObject({


We should also test virtual| hardware here IMO

hervedombya · 2025-03-11T13:18:03Z

/approve

bert-e · 2025-03-11T13:18:12Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge improvement/ARTESCA-14623 into
development/129.0
w/130.0/improvement/ARTESCA-14623 will be merged into development/130.0

The following branches will NOT be impacted:

development/123.0
development/124.0
development/124.1
development/125.0
development/126.0
development/127.0
development/128.0
development/2.0
development/2.1
development/2.10
development/2.11
development/2.2
development/2.3
development/2.4
development/2.5
development/2.6
development/2.7
development/2.8
development/2.9

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

The following options are set: approve

bert-e · 2025-03-11T15:59:41Z

Build failed

The build for commit did not succeed in branch improvement/ARTESCA-14623

The following options are set: approve

bert-e · 2025-03-11T17:33:10Z

I have successfully merged the changeset of this pull request
into targetted development branches:

✔️ development/129.0
✔️ development/130.0

The following branches have NOT changed:

development/123.0
development/124.0
development/124.1
development/125.0
development/126.0
development/127.0
development/128.0
development/2.0
development/2.1
development/2.10
development/2.11
development/2.2
development/2.3
development/2.4
development/2.5
development/2.6
development/2.7
development/2.8
development/2.9

Please check the status of the associated issue ARTESCA-14623.

Goodbye hervedombya.

The following options are set: approve

hervedombya requested a review from a team as a code owner March 4, 2025 17:44

JBWatenbergScality reviewed Mar 5, 2025

View reviewed changes

JBWatenbergScality reviewed Mar 7, 2025

View reviewed changes

hervedombya force-pushed the improvement/ARTESCA-14623 branch 2 times, most recently from 1ed8dca to c4559dc Compare March 10, 2025 13:08

hervedombya force-pushed the improvement/ARTESCA-14623 branch from c4559dc to 5aecf3d Compare March 11, 2025 12:58

JBWatenbergScality reviewed Mar 11, 2025

View reviewed changes

Add volumeType property to Metalk8sLocalVolumeProvider tests

0d3cc60

JBWatenbergScality approved these changes Mar 11, 2025

View reviewed changes

bert-e merged commit 0d3cc60 into development/129.0 Mar 11, 2025
27 checks passed

bert-e deleted the improvement/ARTESCA-14623 branch March 11, 2025 17:33

	it('should raise an error if volume recovery fails', async () => {
	it('should raise an error if volume retrieval fails', async () => {

	export default class K8SLocalVolumeProvider implements K8SLocalVolumeAdapter {
	export default class Metalk8sLocalVolumeProvider implements K8SLocalVolumeAdapter {

		devicePath:
		item.spec?.rawBlockDevice?.devicePath \|\| item.metadata['name'],

Conversation

hervedombya commented Mar 4, 2025

Uh oh!

bert-e commented Mar 4, 2025

Hello hervedombya,

Uh oh!

bert-e commented Mar 4, 2025

Request integration branches

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!

Choose a reason for hiding this comment

Uh oh!

hervedombya commented Mar 11, 2025

Uh oh!

bert-e commented Mar 11, 2025

Integration data created

Uh oh!

bert-e commented Mar 11, 2025

Build failed

Uh oh!

bert-e commented Mar 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants