|
| 1 | +# Moving between Machines |
| 2 | + |
| 3 | +The RoseLab environment provides a powerful utility for managing and migrating your containers across different servers. This tool allows you to copy your full environment between servers in less than 10 minutes, making it easy to balance workloads and access new resources. |
| 4 | + |
| 5 | +## Accessing the Utility |
| 6 | + |
| 7 | +1. On any RoseLab container, navigate to `/public/common-utilities/` |
| 8 | +2. Run the command: `python client.py`. You might need to install Python 3.8+ and libraries like `requests` and `json`. |
| 9 | + |
| 10 | +## Key Features |
| 11 | + |
| 12 | +The utility offers several options: |
| 13 | + |
| 14 | +1. Add or delete port mapping |
| 15 | +2. Copy container |
| 16 | +3. Start container |
| 17 | +4. Stop container |
| 18 | +5. Remove container |
| 19 | +6. Create new container |
| 20 | + |
| 21 | +## Container Migration Process |
| 22 | + |
| 23 | +To migrate your container to another server: |
| 24 | + |
| 25 | +1. Use option 2 to copy your environment to another server |
| 26 | +2. Use option 3 to start your copied container on the new server |
| 27 | + |
| 28 | +## Creating New Containers |
| 29 | + |
| 30 | +Use option 6 to create a new container from preset images on any available server. |
| 31 | + |
| 32 | +## Benefits of Using This Utility |
| 33 | + |
| 34 | +- Access to multiple servers (roselab1~4) independently |
| 35 | +- Quick replication of your environment on another server when your primary server is overloaded |
| 36 | +- Easy synchronization of environments across multiple servers |
| 37 | +- Set up external access to JupyterLab, TCP services, or web services without SSH forwarding |
| 38 | +- Restart containers that were accidentally shut down |
| 39 | +- Delete and recreate containers in case of environment corruption |
| 40 | +- Backup containers before risky operations |
| 41 | +- Immediate access to new RoseLab servers as they come online |
| 42 | + |
| 43 | +## Migration Time |
| 44 | + |
| 45 | +Migration speed depends on container size. With few concurrent migrations, the transfer speed exceeds 300MB/s. A 128 GB container takes approximately 6 minutes to copy. |
| 46 | + |
| 47 | +## Differences Between Copied and Original Containers |
| 48 | + |
| 49 | +Copied containers are nearly identical to the originals, with only these differences: |
| 50 | +- The hostname changes from roselabX.ucsd.edu to roselabY.ucsd.edu |
| 51 | +- Potential hardware variations (CPU, GPU) |
| 52 | + |
| 53 | +Software configurations remain the same. For example, a website available at roselabX.ucsd.edu:55555 will also be accessible at roselabY.ucsd.edu:55555, provided your port mappings are applied across all servers. |
| 54 | + |
| 55 | +## Port Mapping |
| 56 | + |
| 57 | +The utility allows you to manage TCP and HTTPS port mappings: |
| 58 | +- TCP mapping (e.g., roselabX.ucsd.edu:55555 → container:8888 for JupyterLab) makes your service available via http://roselabX.ucsd.edu:55555 |
| 59 | +- HTTPS mapping makes it available via https://roselabX.ucsd.edu:55555 |
| 60 | + |
| 61 | +HTTPS adds a security layer and is more browser-friendly but only supports hosted HTTP web services, not TCP services like FTP or SSH. |
| 62 | + |
| 63 | +## Limitations |
| 64 | + |
| 65 | +- Master students may have restricted cross-server copying permissions. Contact Rose for expanded access. |
| 66 | +- You can have only one container per host. To create or copy a new container, you must first remove your old one. |
| 67 | +- The script requires additional confirmation before container removal. Exercise extreme caution to prevent data loss. |
| 68 | +- It's recommended to access this utility from your "main" container, as you can't delete an active container. |
| 69 | + |
| 70 | +## Automation |
| 71 | + |
| 72 | +You can create scripts for frequent or scheduled synchronization. The current inter-server bandwidth is 25Gbps, with plans to upgrade to 100Gbps. The 300MB/s data transfer rate is well within these limits. |
| 73 | + |
| 74 | +## Security Measures |
| 75 | + |
| 76 | +The utility implements strict security measures: |
| 77 | +- It only accepts connections from the RoseLAN intranet. |
| 78 | +- Users can only manage containers under their own name. |
| 79 | +- You cannot modify other users' port mappings. |
| 80 | +- The /public/common-utilities/ folder is only visible to the ubuntu user, not even to root. |
| 81 | +- Non-ubuntu container users (unless with sudo or API key) cannot shut down or delete containers using this utility. |
| 82 | + |
| 83 | +::: warning |
| 84 | +If you accidentally share the API key from the client, notify the admin immediately so it can be updated. |
| 85 | +::: |
| 86 | + |
| 87 | +By utilizing this tool, you can efficiently manage your containers across the RoseLab servers, optimizing your workflow and making the most of the available resources. |
0 commit comments