Update Image
1. Overview
The Update Image action allows you to replace the current image running on your instance with a different one without creating a new instance. This is useful when you need to switch frameworks, upgrade to a newer environment, or change your software stack while retaining your instance configuration.
However, updating the image restarts the instance and replaces the underlying environment, which can affect installed packages and running services.
2. When to Use
| Scenario | Description |
|---|---|
| Switch frameworks | When switching to a different framework or runtime (for example, from TensorFlow to PyTorch). |
| Upgrade environment | When upgrading to a newer version of the current image. |
| Change workload | When your workload requirements change and a different environment is needed. |
3. How to Update the Image
- Navigate to your instance and click Update Image from the Actions menu.
- Browse the list of supported images available for your instance.
- Select the image that matches your framework and workload requirements.
- Click Update to apply the new image to your instance.
- Ensure you save any unsaved work before updating the image, as the instance will restart during the process.
4. Impacts of Updating the Image
When an instance image is updated, the following behavior should be expected:
Instance Restart
Updating the image restarts the instance. During this process, the running environment is replaced with the newly selected image.
Data Persistence
Only the data stored inside the /home/jovyan directory is preserved after the update.
Any files stored outside this directory may be lost during the image update process.
Installed Packages
Any packages or libraries manually installed on the previous image (for example using pip install or apt install) will not persist after the image update.
These packages must be reinstalled manually if they are required in the new environment.
Running Services
If any services or processes are running on the instance, they will be interrupted when the image update occurs, since the instance restarts. These services will need to be started again after the instance becomes available.
Best Practices for Updating Images
Ensure you save any unsaved work before updating the image, as the instance will restart during the process.
The Update Image action replaces only the image. Your instance configuration, attached workspace, and plan remain unchanged.
Browse and confirm the selected image matches your framework and workload requirements before applying the update.