Rename VM Api GRPC call RemoveDisk to DetachDisk

Signed-off-by: Guvenc Gulce <[email protected]>

Author: guvenc

cli/src/vm_commands.rs

@@ -9,7 +9,7 @@ use feos_proto::vm_service::{
     net_config, stream_vm_console_request as console_input, vm_service_client::VmServiceClient,
     AttachConsoleMessage, AttachDiskRequest, AttachNicRequest, ConsoleData, CpuConfig,
     CreateVmRequest, DeleteVmRequest, DiskConfig, GetVmRequest, ListVmsRequest, MemoryConfig,
-    NetConfig, PauseVmRequest, PingVmRequest, RemoveDiskRequest, DetachNicRequest, ResumeVmRequest,
+    NetConfig, PauseVmRequest, PingVmRequest, DetachDiskRequest, DetachNicRequest, ResumeVmRequest,
     ShutdownVmRequest, StartVmRequest, StreamVmConsoleRequest, StreamVmEventsRequest, TapConfig,
     VfioPciConfig, VmConfig, VmState, VmStateChangedEvent,
 };
@@ -153,14 +153,14 @@ pub enum VmCommand {
         #[arg(long, required = true, help = "Path to the disk image file")]
         path: String,
     },
-    /// Remove a disk from a virtual machine
-    RemoveDisk {
+    /// Detach a disk from a virtual machine
+    DetachDisk {
         #[arg(long, required = true, help = "VM identifier")]
         vm_id: String,
         #[arg(
             long,
             required = true,
-            help = "Device identifier of the disk to remove"
+            help = "Device identifier of the disk to detach"
         )]
         device_id: String,
     },
@@ -262,8 +262,8 @@ pub async fn handle_vm_command(args: VmArgs) -> Result<()> {
         VmCommand::Events { vm_id } => watch_events(&mut client, vm_id).await?,
         VmCommand::Console { vm_id } => console_vm(&mut client, vm_id).await?,
         VmCommand::AttachDisk { vm_id, path } => attach_disk(&mut client, vm_id, path).await?,
-        VmCommand::RemoveDisk { vm_id, device_id } => {
-            remove_disk(&mut client, vm_id, device_id).await?
+        VmCommand::DetachDisk { vm_id, device_id } => {
+            detach_disk(&mut client, vm_id, device_id).await?
         }
         VmCommand::AttachNic {
             vm_id,
@@ -783,17 +783,17 @@ async fn attach_disk(
     Ok(())
 }
 
-async fn remove_disk(
+async fn detach_disk(
     client: &mut VmServiceClient<Channel>,
     vm_id: String,
     device_id: String,
 ) -> Result<()> {
-    let request = RemoveDiskRequest {
+    let request = DetachDiskRequest {
         vm_id: vm_id.clone(),
         device_id: device_id.clone(),
     };
-    client.remove_disk(request).await?;
-    println!("Disk remove request sent for device {device_id} on VM {vm_id}");
+    client.detach_disk(request).await?;
+    println!("Disk detach request sent for device {device_id} on VM {vm_id}");
     Ok(())
 }
 

feos/services/vm-service/src/api.rs

@@ -6,7 +6,7 @@ use feos_proto::vm_service::{
     vm_service_server::VmService, AttachDiskRequest, AttachDiskResponse, AttachNicRequest,
     AttachNicResponse, CreateVmRequest, CreateVmResponse, DeleteVmRequest, DeleteVmResponse,
     GetVmRequest, ListVmsRequest, ListVmsResponse, PauseVmRequest, PauseVmResponse, PingVmRequest,
-    PingVmResponse, RemoveDiskRequest, RemoveDiskResponse, DetachNicRequest, DetachNicResponse,
+    PingVmResponse, DetachDiskRequest, DetachDiskResponse, DetachNicRequest, DetachNicResponse,
     ResumeVmRequest, ResumeVmResponse, ShutdownVmRequest, ShutdownVmResponse, StartVmRequest,
     StartVmResponse, StreamVmConsoleRequest, StreamVmConsoleResponse, StreamVmEventsRequest,
     VmEvent, VmInfo,
@@ -195,13 +195,13 @@ impl VmService for VmApiHandler {
         .await
     }
 
-    async fn remove_disk(
+    async fn detach_disk(
         &self,
-        request: Request<RemoveDiskRequest>,
-    ) -> Result<Response<RemoveDiskResponse>, Status> {
-        info!("VmApi: Received RemoveDisk request.");
+        request: Request<DetachDiskRequest>,
+    ) -> Result<Response<DetachDiskResponse>, Status> {
+        info!("VmApi: Received DetachDisk request.");
         dispatch_and_wait(&self.dispatcher_tx, |resp_tx| {
-            Command::RemoveDisk(request.into_inner(), resp_tx)
+            Command::DetachDisk(request.into_inner(), resp_tx)
         })
         .await
     }

feos/services/vm-service/src/dispatcher.rs

@@ -5,7 +5,7 @@ use crate::{
     dispatcher_handlers::{
         handle_attach_disk_command, handle_attach_nic_command, handle_create_vm_command,
         handle_delete_vm_command, handle_get_vm_command, handle_list_vms_command,
-        handle_pause_vm_command, handle_remove_disk_command, handle_detach_nic_command,
+        handle_pause_vm_command, handle_detach_disk_command, handle_detach_nic_command,
         handle_resume_vm_command, handle_shutdown_vm_command, handle_start_vm_command,
         handle_stream_vm_console_command, handle_stream_vm_events_command,
         perform_startup_sanity_check,
@@ -107,8 +107,8 @@ impl VmServiceDispatcher {
                         Command::AttachDisk(req, responder) => {
                             handle_attach_disk_command(&self.repository, req, responder, hypervisor).await;
                         }
-                        Command::RemoveDisk(req, responder) => {
-                            handle_remove_disk_command(&self.repository, req, responder, hypervisor).await;
+                        Command::DetachDisk(req, responder) => {
+                            handle_detach_disk_command(&self.repository, req, responder, hypervisor).await;
                         }
                         Command::AttachNic(req, responder) => {
                             handle_attach_nic_command(&self.repository, req, responder, hypervisor).await;

feos/services/vm-service/src/dispatcher_handlers.rs

@@ -13,8 +13,8 @@ use feos_proto::{
         net_config, stream_vm_console_request as console_input, AttachConsoleMessage,
         AttachDiskRequest, AttachDiskResponse, AttachNicRequest, AttachNicResponse,
         CreateVmRequest, CreateVmResponse, DeleteVmRequest, DeleteVmResponse, GetVmRequest,
-        ListVmsRequest, ListVmsResponse, PauseVmRequest, PauseVmResponse, RemoveDiskRequest,
-        RemoveDiskResponse, DetachNicRequest, DetachNicResponse, ResumeVmRequest, ResumeVmResponse,
+        ListVmsRequest, ListVmsResponse, PauseVmRequest, PauseVmResponse, DetachDiskRequest,
+        DetachDiskResponse, DetachNicRequest, DetachNicResponse, ResumeVmRequest, ResumeVmResponse,
         ShutdownVmRequest, ShutdownVmResponse, StartVmRequest, StartVmResponse,
         StreamVmConsoleRequest, StreamVmConsoleResponse, StreamVmEventsRequest, VmEvent, VmInfo,
         VmState, VmStateChangedEvent,
@@ -677,10 +677,10 @@ pub(crate) async fn handle_attach_disk_command(
     tokio::spawn(worker::handle_attach_disk(req, responder, hypervisor));
 }
 
-pub(crate) async fn handle_remove_disk_command(
+pub(crate) async fn handle_detach_disk_command(
     repository: &VmRepository,
-    req: RemoveDiskRequest,
-    responder: oneshot::Sender<Result<RemoveDiskResponse, VmServiceError>>,
+    req: DetachDiskRequest,
+    responder: oneshot::Sender<Result<DetachDiskResponse, VmServiceError>>,
     hypervisor: Arc<dyn Hypervisor>,
 ) {
     let (_vm_id, record) = match parse_vm_id_and_get_record(&req.vm_id, repository).await {
@@ -697,12 +697,12 @@ pub(crate) async fn handle_remove_disk_command(
         VmState::Created | VmState::Running | VmState::Paused | VmState::Stopped
     ) {
         let _ = responder.send(Err(VmServiceError::InvalidState(format!(
-            "Cannot remove disk from VM in {current_state:?} state."
+            "Cannot detach disk from VM in {current_state:?} state."
         ))));
         return;
     }
 
-    tokio::spawn(worker::handle_remove_disk(req, responder, hypervisor));
+    tokio::spawn(worker::handle_detach_disk(req, responder, hypervisor));
 }
 
 pub(crate) async fn handle_attach_nic_command(

feos/services/vm-service/src/lib.rs

@@ -6,7 +6,7 @@ use feos_proto::vm_service::{
     AttachDiskRequest, AttachDiskResponse, AttachNicRequest, AttachNicResponse, CreateVmRequest,
     CreateVmResponse, DeleteVmRequest, DeleteVmResponse, GetVmRequest, ListVmsRequest,
     ListVmsResponse, PauseVmRequest, PauseVmResponse, PingVmRequest, PingVmResponse,
-    RemoveDiskRequest, RemoveDiskResponse, DetachNicRequest, DetachNicResponse, ResumeVmRequest,
+    DetachDiskRequest, DetachDiskResponse, DetachNicRequest, DetachNicResponse, ResumeVmRequest,
     ResumeVmResponse, ShutdownVmRequest, ShutdownVmResponse, StartVmRequest, StartVmResponse,
     StreamVmConsoleRequest, StreamVmConsoleResponse, StreamVmEventsRequest, VmEvent, VmInfo,
 };
@@ -80,9 +80,9 @@ pub enum Command {
         AttachDiskRequest,
         oneshot::Sender<Result<AttachDiskResponse, VmServiceError>>,
     ),
-    RemoveDisk(
-        RemoveDiskRequest,
-        oneshot::Sender<Result<RemoveDiskResponse, VmServiceError>>,
+    DetachDisk(
+        DetachDiskRequest,
+        oneshot::Sender<Result<DetachDiskResponse, VmServiceError>>,
     ),
     AttachNic(
         AttachNicRequest,
@@ -111,7 +111,7 @@ impl std::fmt::Debug for Command {
             Command::PauseVm(req, _) => f.debug_tuple("PauseVm").field(req).finish(),
             Command::ResumeVm(req, _) => f.debug_tuple("ResumeVm").field(req).finish(),
             Command::AttachDisk(req, _) => f.debug_tuple("AttachDisk").field(req).finish(),
-            Command::RemoveDisk(req, _) => f.debug_tuple("RemoveDisk").field(req).finish(),
+            Command::DetachDisk(req, _) => f.debug_tuple("DetachDisk").field(req).finish(),
             Command::AttachNic(req, _) => f.debug_tuple("AttachNic").field(req).finish(),
             Command::DetachNic(req, _) => f.debug_tuple("DetachNic").field(req).finish(),
         }

feos/services/vm-service/src/vmm/ch_adapter.rs

@@ -13,7 +13,7 @@ use cloud_hypervisor_client::{
 use feos_proto::vm_service::{
     net_config, AttachDiskRequest, AttachDiskResponse, AttachNicRequest, AttachNicResponse,
     CreateVmRequest, DeleteVmRequest, DeleteVmResponse, GetVmRequest, PauseVmRequest,
-    PauseVmResponse, PingVmRequest, PingVmResponse, RemoveDiskRequest, RemoveDiskResponse,
+    PauseVmResponse, PingVmRequest, PingVmResponse, DetachDiskRequest, DetachDiskResponse,
     DetachNicRequest, DetachNicResponse, ResumeVmRequest, ResumeVmResponse, ShutdownVmRequest,
     ShutdownVmResponse, StartVmRequest, StartVmResponse, VmConfig, VmInfo, VmState,
 };
@@ -499,9 +499,9 @@ impl Hypervisor for CloudHypervisorAdapter {
         ))
     }
 
-    async fn remove_disk(&self, _req: RemoveDiskRequest) -> Result<RemoveDiskResponse, VmmError> {
+    async fn detach_disk(&self, _req: DetachDiskRequest) -> Result<DetachDiskResponse, VmmError> {
         Err(VmmError::Internal(
-            "RemoveDisk not implemented for CloudHypervisorAdapter".to_string(),
+            "DetachDisk not implemented for CloudHypervisorAdapter".to_string(),
         ))
     }
 

feos/services/vm-service/src/vmm/mod.rs

@@ -5,7 +5,7 @@ use crate::VmEventWrapper;
 use feos_proto::vm_service::{
     AttachDiskRequest, AttachDiskResponse, AttachNicRequest, AttachNicResponse, CreateVmRequest,
     DeleteVmRequest, DeleteVmResponse, GetVmRequest, PauseVmRequest, PauseVmResponse,
-    PingVmRequest, PingVmResponse, RemoveDiskRequest, RemoveDiskResponse, DetachNicRequest,
+    PingVmRequest, PingVmResponse, DetachDiskRequest, DetachDiskResponse, DetachNicRequest,
     DetachNicResponse, ResumeVmRequest, ResumeVmResponse, ShutdownVmRequest, ShutdownVmResponse,
     StartVmRequest, StartVmResponse, VmEvent, VmInfo, VmStateChangedEvent,
 };
@@ -90,7 +90,7 @@ pub trait Hypervisor: Send + Sync {
     async fn pause_vm(&self, req: PauseVmRequest) -> Result<PauseVmResponse, VmmError>;
     async fn resume_vm(&self, req: ResumeVmRequest) -> Result<ResumeVmResponse, VmmError>;
     async fn attach_disk(&self, req: AttachDiskRequest) -> Result<AttachDiskResponse, VmmError>;
-    async fn remove_disk(&self, req: RemoveDiskRequest) -> Result<RemoveDiskResponse, VmmError>;
+    async fn detach_disk(&self, req: DetachDiskRequest) -> Result<DetachDiskResponse, VmmError>;
     async fn attach_nic(&self, req: AttachNicRequest) -> Result<AttachNicResponse, VmmError>;
     async fn detach_nic(&self, req: DetachNicRequest) -> Result<DetachNicResponse, VmmError>;
 }

feos/services/vm-service/src/worker.rs

@@ -11,7 +11,7 @@ use feos_proto::{
         stream_vm_console_request as console_input, AttachDiskRequest, AttachDiskResponse,
         AttachNicRequest, AttachNicResponse, ConsoleData, CreateVmRequest, CreateVmResponse,
         DeleteVmRequest, DeleteVmResponse, GetVmRequest, PauseVmRequest, PauseVmResponse,
-        PingVmRequest, PingVmResponse, RemoveDiskRequest, RemoveDiskResponse, DetachNicRequest,
+        PingVmRequest, PingVmResponse, DetachDiskRequest, DetachDiskResponse, DetachNicRequest,
         DetachNicResponse, ResumeVmRequest, ResumeVmResponse, ShutdownVmRequest,
         ShutdownVmResponse, StartVmRequest, StartVmResponse, StreamVmConsoleRequest,
         StreamVmConsoleResponse, StreamVmEventsRequest, VmEvent, VmInfo, VmState,
@@ -421,14 +421,14 @@ pub async fn handle_attach_disk(
     }
 }
 
-pub async fn handle_remove_disk(
-    req: RemoveDiskRequest,
-    responder: oneshot::Sender<Result<RemoveDiskResponse, VmServiceError>>,
+pub async fn handle_detach_disk(
+    req: DetachDiskRequest,
+    responder: oneshot::Sender<Result<DetachDiskResponse, VmServiceError>>,
     hypervisor: Arc<dyn Hypervisor>,
 ) {
-    let result = hypervisor.remove_disk(req).await;
+    let result = hypervisor.detach_disk(req).await;
     if responder.send(result.map_err(Into::into)).is_err() {
-        error!("VmWorker: Failed to send response for RemoveDisk.");
+        error!("VmWorker: Failed to send response for DetachDisk.");
     }
 }
 

proto/v1/vm.proto

@@ -40,7 +40,7 @@ service VMService {
   // Hot-plugs a new disk to a running VM.
   rpc AttachDisk(AttachDiskRequest) returns (AttachDiskResponse);
   // Hot-unplugs a disk from a running VM.
-  rpc RemoveDisk(RemoveDiskRequest) returns (RemoveDiskResponse);
+  rpc DetachDisk(DetachDiskRequest) returns (DetachDiskResponse);
   // Hot-plugs a new network interface to a running VM.
   rpc AttachNic(AttachNicRequest) returns (AttachNicResponse);
   // Hot-unplugs a network interface from a running VM.
@@ -230,7 +230,7 @@ message AttachDiskResponse {
   string device_id = 1;
 }
 
-message RemoveDiskRequest {
+message DetachDiskRequest {
   string vm_id = 1;
   string device_id = 2;
 }
@@ -261,4 +261,4 @@ message PauseVmResponse {}
 
 message ResumeVmResponse {}
 
-message RemoveDiskResponse {}
+message DetachDiskResponse {}