Skip to main content

Updating a VM Image

How to launch a registered VM image, modify it, save the updated version, and optionally apply it to all labs using that image.

Written by Mary Gordanier
Updated yesterday

For Admins

Vocareum allows you to update an existing virtual machine (VM) image by launching it, making changes to the environment, and saving the result as a new version. This is useful when you need to install software, update configurations, or otherwise modify the base environment that students work in.

Before updating an image, the image must be registered in your organization's Org VM Images list. If the image is not yet registered, refer to Registering a VM Image before proceeding.

For more context on VM Labs and where this process fits in, refer to the article What are Vocareum Virtual Machine Labs?

Launch and Modify a VM Image

Once an image is registered, launch it from the Org VM Images page to make changes.

  1. From the Courses page, click the link labeled Edit Org.

    The Courses page with the Edit Org link indicated.

  2. In the left sidebar, click Custom Infra.

  3. Under VM Settings, click View next to Register VM Images.

  4. On the Org VM Images page, click on the name of the image you want to update.

  5. In the configuration panel that opens, click Launch Image.

    The Org VM Images list with an image selected and the Launch Image button highlighted in the configuration panel below.

  6. The VM desktop opens in a new view. Click Start Lab in the top toolbar to begin a session. (Starting the lab may take several minutes.)

    The VM desktop with the top toolbar visible, showing Start Lab, End Lab, Replace Parent, Save Image, and Reset buttons.

  7. Make your desired changes to the VM environment.

  8. Click Save Image in the toolbar to save the current state of the VM as a new image.

    The VM toolbar after the lab session has ended, with the Start Lab and Save Image buttons highlighted.

  9. A default session timer is applied in this environment. Monitor the session timer and be sure to save your image within the session time limit. After the timer expires, the lab will be terminated.

  10. When you have finished making changes and saving your image, click End Lab in the toolbar.

    The VM desktop toolbar with the session timer and the End Lab button highlighted.

Replace the Parent Image (Optional)

After saving, you can use the Replace Parent feature to update all labs currently using the previous version of this image to use the newly saved version. This step is optional — if you do not replace the parent, existing labs will continue to use the original image.

  1. Click Replace Parent in the toolbar.

    The VM toolbar with the Replace Parent button highlighted.

  2. A confirmation dialog displays a list of assignments that will be updated to use the new image. Review the list.

  3. Click Yes to confirm. All listed assignments will be updated to use the newly saved image.

Did this answer your question?