An image is a type of template for a virtual machine.
You can launch an instance and install the software and files you want to use, then request an image of the instance using the Request Imaging form within Atmosphere, as outlined below. This allows you to retain a complete copy of all of the changes and updates you made to the instance so you can reuse it again later, much like a template. It also is a way to share your image with other CyVerse users and define who can view and launch the image, from public sharing (visible to and launchable by all users) to private sharing (only you can view and launch the image), and with specific users (visible to and launchable to specified users).
Images save resources, since you can relaunch an instance of your image at any time instead of having to keep the instance running when you don't need to use it. After submitting your form, the Atmosphere support staff completes the request. Future versions of Atmosphere will allow users to initiate the VM imaging process automatically.
You can request an image (a type of template for a virtual machine) of a running instance. This saves a complete copy of all changes and updates you made to the instance since you launched it so you can reuse it at any time. It also saves resources by launching the instance only when you need it. You also can see the list of all image requests you have made.
You can add a script before requesting the image that executes after an instance using the image is launched and active.
Click Projects on the menu bar and open the project with the instance to use for the new image.
Click the instance name. The instance must be in Active status.
In the Actions list on the right, click Image.
Step 1 – Image Info
Name and description
Enter up to 30 characters for the new image name.
Enter the description as you want it to appear when viewed in Atmosphere. The description should include key words that concisely describe the tools installed, the purpose of the tools (e.g., This image performs X analysis), and the initial intent of the machine image (e.g. designed for XYZ workshop).
Doc note: Any changes made to the steps about image tags (selecting an existing tag or creating a new one) should also be copied to the tag steps in Adding and Removing Instance Tags (feature removed).
If editing the step on editing tags, dup the content on .
Click in the Search by tag name field and begin entering the first letter or two of a tag.
Click the tag to use and then click Add.
Repeat for each tag to add to the image.
Add a new tag to the tags list:
Click New tag.
Enter the tag name and description.
Click Create tag.
Repeat for each new tag to add to the image.
Click Done editing.
Step 2 – Version Info
In New Version Name, enter the new (unique) name or number of the tool to distinguish this tool from others with a similar name.
In Change Log, enter a brief description of the changes you made to this version of the tool.
Step 3 – Privacy (image visibility)
Select the visibility level for the image from the dropdown list:
Public: Makes the image visible to and launchable by all users.
Private: Allows only you to view and launch the image.
Specific Users: Makes the image visible to and launchable only by specified users.
If done, click Submit.
Click Advanced Options to set additional options.
Steps 4, 5, and 6 – Advanced Options (optional)
Click Advanced Options to set advanced options such as excluding directories from the image, adding deployment scripts that execute when the image is launched or the status changes, or requiring the user to verify understanding of any license restrictions.
Step 4: Files to exclude
To exclude files from the image, list each file to exclude on a separate line and then click Next. (To not exclude any files, just click Next.)
Step 5: Deployment Scripts and Software Licenses
To add a deployment script, click in the search field and search for the title of the script. If done, click Next.
To create a new deployment script:
Click Create New Script, enter a title for the script, and then either click URL and enter the URL to the script, or click Full Text and enter the deployment script.
When done, click Create and Add, and then click Next.
To add a script that executes after the image is launched, see the section below.
To list licensed software used in the image and require users to agree to the license agreement before launching, click in the search field and search for the license title.
To create a new license:
Click Create New License, enter a title for the license, and then either click URL and enter the URL to the license, or click Full Text and enter the full license text.
When done, click Create and Add, and then click Next. (Just click Next to continue to the next screen without adding a new script.
Step 6: Review and submit request
In the Step6 screen, verify that the options you selected are correct (if not, click Back to change them).
Click the checkbox certifying that the license does not contain any license-restricted software. Read the Important notesto the right.
Click Request Image.
You will receive an email from Support when the image is completed. Please email questions to Support at firstname.lastname@example.org.
Viewing your list of images
To view your lists of images and image requests, click Images on the top menu bar.
ClickMy Images tab at the top of the screen.
Viewing your list of image requests
To view the list and status of your image requests, either:
Click Images on the top menu bar and then click My Image Requests at the top of the screen. –or–
Click your username at the top right of the screen, click My requests, and then click Imaging Requests.
Before submitting your request for an image of your instance, you must remove the following software from the instance:
Licensed software that was not purchased by CyVerse.
Software in which the licensing otherwise prevents the use within a cloud or virtualized environment.
The following directories are deleted from the resulting image as part of the imaging process. (They are not deleted from the instance from which the image is created, which remains intact throughout the entire process.)
About your /home/ directory
All files, directories, and icons located under /home/<username>/Desktop will be deleted from the resulting image. To preserve them, please email CyVerse Support.
NOT COPIED as part of the image:
iRODS FUSE mounts
OVERWRITTEN: The following system files are typically overwritten by CyVerse for security or operational reasons:
NOTE: The permissions of the operating system are NOT affected by the imaging process.