[v0.4.0] Integrated Scenario for Cloud Migration #25

yunkon-kim · 2025-08-26T08:27:05Z

yunkon-kim
Aug 26, 2025
Maintainer

Hi folks 👋

I have written this discussion to show and discuss the Integrated Scenario for Cloud Migration (initial version).
This discussion illustrates a scenario that progresses from a computing infrastructure migration to a software migration.

Note

이번 cloud-migrator platform v0.4.0 릴리스의 주요 사항
컴퓨팅 인프라 마이그레이션 부터 소프트웨어 마이그레이션까지의 시나리오 검토 및 협의 필요(Beetle과 Grasshopper를 중심으로 작성)
시나리오 중에서 자동화 또는 반복수행 가능한 영역이 Cicada에서 Workflow로 제공될 것으로 보임

Important

현재까지 정리 또는 협의된 사항에 대해 안내 말씀 드립니다.

Beetle에서 최적 클라우드 인프라 추천 및 컴퓨팅 인프라 마이그레이션 수행
Grasshopper에서 Server와 VM 간 SW 마이그레이션을 수행 할 수 있도록 Beetle 개선
- 참고: vm 정보에 소스 서버 ID 기재 예정 (예: mciInfo.vm[N].label["sourceMachineId"]: "0036e4b9-c8b4-e811-906e-000ffee02d5c")
(마이그레이션 후) Tumblebug에서 인프라 관리 수행 (MCI 조회(VMs, pubIPs, sshKeyIDs), SSH Key 조회, 등)

검토를 요청 드리며, 개선 의견을 가감없이 공유해 주시기 바랍니다 😺

Computing Infra Migration Scenario

: Precondition: The user gets a recommended target infrastructure (i.e., target infra model) via Beetle.
: Postcondition: After migration, the user manages the migrated infrastructure via Tumblebug.

: Participants: User, Butterfly, Damselfly, Beetle, Tumblebug

sequenceDiagram
    participant User as "User"
    participant Browser as "Web Console"
    participant Butterfly as "Butterfly"
    participant Damselfly as "Damselfly"
    participant Beetle as "Beetle"
    participant Tumblebug as "Tumblebug"

	%% Step 0: User accesses the Computing Infra Migration View
    User->>Browser: Access the Computing Infra Migration View
    activate Browser
    Browser->>Butterfly: Request the Computing Infra Migration View
    activate Butterfly
    
    %% Retrieve the target models (cloud model) from Damselfly
    Butterfly->>Damselfly: API call to GET /damselfly/cloudmodel
    activate Damselfly
    Damselfly-->>Butterfly: Return the cloud model list
    deactivate Damselfly
    
    Butterfly-->>Browser: Respond with the view
    deactivate Butterfly
    Browser-->>User: Display Computing Infra Migration View
    deactivate Browser

    %% Select a target infra model (cloud model)
    User->>Browser: Select a target model
    activate Browser
    
    %% Execute Computing Infra Migration
    User->>Browser: Execute migration to cloud infrastructure
    Browser->>Butterfly: Request to migrate to cloud infrastructure
    activate Butterfly
    Butterfly->>Beetle: API call to POST /beetle/migration/ns/{nsId}/mci
    activate Beetle
    Beetle->>Tumblebug: Check if a namespace exists by API call to GET /tumblebug/ns/{nsId}
    activate Tumblebug
    Tumblebug-->>Beetle: Return the namespace info    
    Beetle->>Tumblebug: Create vNet by API call to POST /tumblebug/ns/{nsId}/resources/vNet
    Tumblebug-->>Beetle: Return the vNet info
    Beetle->>Tumblebug: Create SSH key by API call to POST /tumblebug/ns/{nsId}/resources/sshKey
    Tumblebug-->>Beetle: Return the SSH key info
    Beetle->>Tumblebug: Create security group by API call to POST /tumblebug/ns/{nsId}/resources/securityGroup
    Tumblebug-->>Beetle: Return the security group info
    Beetle->>Tumblebug: Create MCI by API call to POST /tumblebug/ns/{nsId}/mci
    Tumblebug-->>Beetle: Return the migrated infra info
    deactivate Tumblebug
    Beetle-->>Butterfly: Return the migrated infra info
    deactivate Beetle
    Butterfly-->>Browser: Respond with the migrated infra info
    deactivate Butterfly
    Browser-->>User: Display the migrated infra info
    deactivate Browser

Software Migration Scenario

: Precondition: The user gets a confirmed target software list (i.e., target sw model) via Grasshopper.
: Postcondition: 필요시 추가 바랍니다.

: Participants: Butterfly, Damselfly, Grasshopper, Honeybee, Tumblebug

sequenceDiagram
    participant User as User
    participant Browser as Web Console
    participant Butterfly as Butterfly
    participant Damselfly as Damselfly
    participant Grasshopper as Grasshopper
    participant Honeybee as Honeybee
    participant Beetle as Beetle
    participant Tumblebug as Tumblebug
    participant SourceVM as Source VM
    participant TargetVM as Target VM

    %% Step 0: User accesses the Software Migration View
    
    %% Request the view
    User->>Browser: Access the Software Migration View
    activate Browser
    Browser->>Butterfly: Request the Software Migration View
    activate Butterfly
    
    %% Retrieve a list of saved Target Software Models from Damselfly
    Butterfly->>Damselfly: API call to GET /damselfly/softwaremodel/target (list target software models)
    activate Damselfly
    Damselfly-->>Butterfly: Return list of saved target software models
    deactivate Damselfly

    %% Retrieve a list of migrated VM Infras (i.e., MCIs) from Tumblebug
    Note over Butterfly: Default nsId: mig01<br/>Available options: id, simple, status
    Butterfly->>Tumblebug: API call to GET /tumblebug/ns/{nsId}/mci
    activate Tumblebug
    Tumblebug-->>Butterfly: Return list of migrated VM Infras (or migrated VM Infra IDs by option)
    deactivate Tumblebug
    
    %% Display the view
    Butterfly-->>Browser: Respond with the view including target software models and migrated VM Infras (or migrated VM Infra IDs by option)
    deactivate Butterfly
    Browser-->>User: Display the Software Migration View including target software models and migrated VM Infras (or migrated VM Infra IDs by option)
    deactivate Browser
    
	opt Select and see a specific Target Software Model
	
		%% Request a specific target software model
	    User->>Browser: Select target software model for migration
	    activate Browser
	    Browser->>Butterfly: Send request with selected target software model ID
	    activate Butterfly   
	    
	    %% Retrieve specific Target Software Model
	    Butterfly->>Damselfly: API call to GET /damselfly/softwaremodel/target/{id} (retrieve specific target software model)
	    activate Damselfly
	    Damselfly-->>Butterfly: Return target software model data
	    deactivate Damselfly
	    
	    %% Display the view    
	    Butterfly-->>Browser: Respond with target software model data
	    deactivate Butterfly
	    Browser-->>User: Display selected target software model details
	    deactivate Browser
    end

	opt Select and see a specific migrated VM Infra
		
		%% Request a specific migrated VM Infra (i.e., MCI)
		User->>Browser: Select a migrated VM Infra
	    activate Browser
	    Browser->>Butterfly: Send request with nsId and mciId
	    activate Butterfly
	
		%% Retrieve the specific migrated VM infra (i.e., MCI)
		Note over Butterfly: Default nsId: mig01<br/>Default mciId: mmci01<br/>Available options: default, id, simple, status
	    Butterfly->>Tumblebug: API call to GET /tumblebug/ns/{nsId}/mci/{mciId}
	    activate Tumblebug
	    Tumblebug-->>Butterfly: Return the VM infra (or VM infra ID by option)
	    deactivate Tumblebug
	    
		%% Display the view    
	    Butterfly-->>Browser: Respond with the VM infra (or VM infra ID by option)
	    deactivate Butterfly
	    Browser-->>User: Display selected VM infra (or VM infra ID by option)
	    deactivate Browser
	end
	
    %% Step 1: Select the target software model and vm infra
    User->>Browser: Select the target software model and vm infra
    activate Browser
       
    %% Step 2: Execute software Migration
    
    %% Request
    User->>Browser: Execute software migration
    activate Browser
    Browser->>Butterfly: Request to migrate the softwares to the vm infra
    activate Butterfly
    Note over Butterfly: Path params: nsId, mciId<br/>Request body: a target sw model
    Butterfly->>Grasshopper: Execute software migration by API call to grasshopper/software/migrate
    activate Grasshopper
    
    %% Establish SSH connections with server in source computing environment
    Grasshopper->>Honeybee: Get source connection info
    activate Honeybee
    Note over Honeybee: Decrypt connection credentials<br/>using RSA private key
    Honeybee-->>Grasshopper: Return decrypted connection info
    deactivate Honeybee
    
    Grasshopper->>Tumblebug: Get target VMs connection info by API call to /tumblebug/ns/{nsId}/mci/{mciId}
    activate Tumblebug
    Tumblebug-->>Grasshopper: Return target VM infra info including VM info
    deactivate Tumblebug
    
    %% Execute migration for each software package in Target Software Model
    loop For each software package in Target Software Model
    
	    Grasshopper->>Grasshopper: Get ".vm[N].publicIP', ".vm[N].sshKeyId", and ".vm[N].label['sourceMachineId']" of each VM from the VM infra info
	    
	    opt Get SSH Key once 
		    Note over Grasshopper: Note: Currently, a single common SSH key is generated for each VM infrastructure.
		    Grasshopper->>Tumblebug: Get SSH key by API call to /tumblebug/ns/{nsId}/resources/sshKey/{sskKeyId}
		    activate Tumblebug
		    Tumblebug-->>Grasshopper: Return SSH key
		end
    
	    Grasshopper->>SourceVM: Establish SSH connection
	    activate SourceVM
	    Grasshopper->>TargetVM: Establish SSH connection  
	    activate TargetVM
    
    
        Note over Grasshopper: Update status to "installing"<br/>Process software from target software model
        Grasshopper->>TargetVM: Run Ansible playbook for package installation
        TargetVM-->>Grasshopper: Return installation result
        
        Grasshopper->>SourceVM: Copy configuration files and data
        SourceVM-->>Grasshopper: Return copied files
        Grasshopper->>TargetVM: Transfer configuration files
        
        Grasshopper->>SourceVM: Extract service configuration
        SourceVM-->>Grasshopper: Return service settings
        Grasshopper->>TargetVM: Configure and start services
        TargetVM-->>Grasshopper: Return service status
        
        Note over Grasshopper: Update status to "finished" or "failed"
    end
    
    deactivate SourceVM
    deactivate TargetVM
    
    Grasshopper-->>Butterfly: Return the software migration results and status
    deactivate Grasshopper
    Butterfly-->>Browser: Respond with the software migration results and status
    deactivate Butterfly
    Browser-->>User: Display the software migration results and status
    deactivate Browser

Appendix

Here's some information about the Tumblebug APIs used in the above scenario. I hope it's helpful. 👍