Skip to content

Fix: Pass SSHLocalPort in Instance to configure driver#3746

Merged
AkihiroSuda merged 1 commit intolima-vm:masterfrom
unsuman:fix/rm-sshlocalport
Aug 5, 2025
Merged

Fix: Pass SSHLocalPort in Instance to configure driver#3746
AkihiroSuda merged 1 commit intolima-vm:masterfrom
unsuman:fix/rm-sshlocalport

Conversation

@unsuman
Copy link
Member

@unsuman unsuman commented Jul 17, 2025 •
edited
Loading

This pull request refactors the configuration mechanism for drivers in the pkg/driver package, by passing the SSHLocalPort directly through Instance struct.

Closes #3703

@unsuman unsuman force-pushed the fix/rm-sshlocalport branch 4 times, most recently from 006b8ab to 4ccf7d9 Compare July 17, 2025 17:11
afbjorklund
afbjorklund requested changes Jul 17, 2025
View reviewed changes
Copy link
Member

@afbjorklund afbjorklund left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only meant to wrap the "int" second parameter in a struct, I think the first parameter was good as it was.

The name can be discussed, if it is ConfigOption or RuntimeOption or whatever it is actually referring to

pkg/driver/driver.go Outdated
// SetConfig sets the configuration for the instance.
Configure(inst *store.Instance, sshLocalPort int) *ConfiguredDriver
// Configure sets the configuration for the instance.
Configure(opts ...ConfigOption) *ConfiguredDriver
Copy link
Member

@afbjorklund afbjorklund Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to keep the instance, since that will always be there.

Configure(inst *store.Instance, opts ...ConfigOption) *ConfiguredDriver

@afbjorklund afbjorklund requested a review from AkihiroSuda July 17, 2025 18:23
afbjorklund
afbjorklund reviewed Jul 17, 2025
View reviewed changes
pkg/driver/external/driver.proto Outdated
message SetConfigRequest {
bytes instance_config_json = 1;
int64 ssh_local_port = 3;
bytes config_opts = 1;
Copy link
Member

@afbjorklund afbjorklund Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might have to decide on a transport here

afbjorklund
afbjorklund reviewed Jul 17, 2025
View reviewed changes
pkg/driver/external/driver.proto
}

message SetConfigRequest {
bytes instance_config_json = 1;
Copy link
Member

@afbjorklund afbjorklund Jul 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one should remain, I think?

@AkihiroSuda AkihiroSuda added this to the v2.0.0 milestone Jul 17, 2025
@AkihiroSuda AkihiroSuda added the gsoc/2025 Google Summer of Code 2025 label Jul 17, 2025
@unsuman unsuman force-pushed the fix/rm-sshlocalport branch from 4ccf7d9 to b60a4c2 Compare July 18, 2025 10:14
AkihiroSuda
AkihiroSuda reviewed Jul 18, 2025
View reviewed changes
pkg/driver/external/driver.proto Outdated
message SetConfigRequest {
bytes instance_config_json = 1;
int64 ssh_local_port = 3;
bytes config_opts = 2;
Copy link
Member

@AkihiroSuda AkihiroSuda Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need two jsons ?
Can't we just set the SSH port in the instance_config_json ?

Copy link
Member Author

@unsuman unsuman Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean to set it in Instance.SSHLocalPort?

Copy link
Member

@AkihiroSuda AkihiroSuda Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Copy link
Member Author

@unsuman unsuman Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then, is there a need for a ConfigOption?

Copy link
Member

@AkihiroSuda AkihiroSuda Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably no

Copy link
Member

@afbjorklund afbjorklund Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought the lima.yaml (config) said "0" for the port, and then the other parameter passed the current random port?

But if we edit the instance config in the store each time, then we don't need any runtime parameters

@unsuman unsuman force-pushed the fix/rm-sshlocalport branch from b60a4c2 to 9ea8cda Compare July 18, 2025 16:53
@unsuman unsuman changed the title Fix: Pass SSHLocalPort as an option to configure driver Fix: Pass SSHLocalPort in Instance to configure driver Jul 18, 2025
@unsuman
set sshlocalport to instance
a680340 
Signed-off-by: Ansuman Sahoo <[email protected]>
@unsuman unsuman force-pushed the fix/rm-sshlocalport branch from 9ea8cda to a680340 Compare July 18, 2025 16:56
AkihiroSuda
AkihiroSuda approved these changes Jul 20, 2025
View reviewed changes
Copy link
Member

@AkihiroSuda AkihiroSuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@AkihiroSuda AkihiroSuda requested a review from afbjorklund July 31, 2025 04:36
@afbjorklund
Copy link
Member

afbjorklund commented Jul 31, 2025

I don't understand how it separates the fixed port, versus the dynamic port?
Wouldn't the new instance config now choose the same port every time?

Or are we relying on that it is only changed while loading the yaml, not on disk?
I guess it is not fundamentally different from any other FillDefaults etc

@AkihiroSuda AkihiroSuda merged commit 5b41de8 into lima-vm:master Aug 5, 2025
87 of 90 checks passed
@AkihiroSuda AkihiroSuda added the area/vmdrivers VM driver infrastructure label Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AkihiroSuda AkihiroSuda AkihiroSuda approved these changes

@afbjorklund afbjorklund afbjorklund approved these changes

Assignees

No one assigned

Labels

area/vmdrivers VM driver infrastructure gsoc/2025 Google Summer of Code 2025

Projects

None yet

Milestone

v2.0.0

Development

Successfully merging this pull request may close these issues.

SSHLocalPort should be in instance, and not as a parameter

3 participants

@unsuman @afbjorklund @AkihiroSuda