- What are Contributed Images ?
- How can I create a Contributed Image ?
- Contributed Image Criteria
- How can I demote a Contributed Image ?
- How can I renew my Contributed image ?
- How does a Contributed Image get archived ?
What are Contributed Images ?
Contributed images are public images that are contributed by the Nectar community members with a higher level of Quality Assurance (QA) than general public images. These images are expected to have a broader audience and provides Quality Assurance by fulfilling a standard criteria. For instance, research groups/organisations can host their customised images on Nectar, making it easily accessible and integrable on computational workflows running across the Nectar ecosystem. They are available in the Images tab of the Nectar dashboard.
How can I create a Contributed Image ?
Contributed images are created in the same way as general public images, however they should meet the quality assurance criteria set by Nectar. A Contributed status promotion request of public image is submitted by the owner through a helpdesk ticket. Nectar will be notified of the promotion request and perform quality assurance tests and reviews on the image. Once the public image passed the tests and review checks, it will be moved to the Contributed Image project maintained by Nectar.
Once a Contributed image has been promoted it will automatically expire after 6 months from the day it was promoted. Image creators are encouraged to resubmit an updated image to ensure their image contributed status. Also, it is the responsibility of the creator to maintain the quality of the contributed image, including promptly addressing security issues.
Contributed Image Criteria:
The Operating System on the image is up-to-date at the time of creation including security patches to address any known vulnerabilities. Contributed Images must not be based on deprecated operating systems.
Images are uploaded and served via the Research Cloud’s Image Catalog service (currently OpenStack Glance).
The image is made publicly available to all users of the research cloud.
The image is configured to use the research cloud instance metadata service to contextualise instances of the image at boot time (e.g. using cloud-init), this must include injection of public keys or creation of password for the default user.
The Glance image name needs to comply to:
Image name in Glance includes the following descriptions in the name
Title of the Contributed Image. Title must not include the word “Nectar”.
Operating System (OS) name or the name of the Distribution (Ubuntu, CentOS, Windows etc.).
Operating System version number. The os version code name and build number/type can also be included.
Operating System architecture type (e.g.Debian/Ubuntu to use ‘amd64’, others to use ‘x86_64’)
Name of the Image should be under 50 characters or less for readability. E.g. “My-Image-Title Ubuntu 16.04 LTS (Xenial) amd64”
Ensure the image name is unique and the name doesn’t conflict with any existing public or Nectar official images that may lead to confusion.
If applicable a publicly available open-source build script to build the image. The source script will not be hosted by Nectar.
Glance image specifications and custom properties (Image Metadata). See instructions to input these properties below. All properties are mandatory except for those marked with an asterisk:
Glance image properties
||The common name of the operating system, name should be in lowercase
||The operating system (OS) version as specified by the distributor.
||Image disk format. See here for list of acceptable formats.
||Image container format. See here for list of acceptable formats.
||If applicable, the minimum disk space required for image in gigabytes. E.g. 10gb == 10, 1tb == 1000
||If applicable, the minimum ram required for image in megabytes. E.g. 512mb == 512, 4gb == 4096
||Default user account used to login into new instance of image.
||The date when the image was built.
||The default user account name to be used to ssh into the instance of image.
||List of non-standard software packages included in image.
E.g. json format
||A brief description about the image and its purposes. Include any user id and passwords to pre-install programs and services For example, MySQL root user and password.
||Expected date where image/operating system will reach its end of life or when this image will no longer be supported by Nectar.
||Log of updates applied to image/operating system. Updates should be appended to this log.
||The date of when image was unpublished if applicable.
||Publisher or creator of the image name
||Publisher or creator of the image organisation name
||Publisher or creator of the image email contact
Sample Image overview:
You can check the image properties by clicking on its name in the images tab of the dashboard.
Setting Image Properties from the dashboard:
Glance image properties can be updated in the nectar dashboard by clicking "Update Metadata" in the Actions dropdown menu for the image.
In the "Custom" field, type the property name and click the " + ". The field will appear on the right hand side, where you can enter the value for that property. Click "save" when complete.
Setting Image Metadata from CLI:
See the openstack guide for more information on submitting image metadata using the commandline interface.
openstack image set\ --property publisher_name='My Name'\ --property publisher_org='My Org' \ image_name_or_id
Note: Nectar reserves the right to downgrade an Image from Contributed to Public if these requirements are not met.
How can I demote a Contributed Image ?
A Contributed image status can be demoted upon receiving the request from the original creator. The image will be unpublished from the Contributed image list and will be published in the Project image list of the creator after the ownership has been updated to the original creator.
How can I renew my Contributed image ?
Renewal request of Contributed image process is similar to the request of Contributed image promotion whereby the request is initiated by a helpdesk ticket. The image creator is required to submit an updated image together with the request. The updated image will proceed through the identical quality assurance procedures. Once the public image passed the tests and review checks, it will replace the earlier Contributed image.
Once a Contributed image has been renewed it will automatically expire after 6 months from the day it was updated. The outdated Contributed image will be moved to the Archived image list.
How does a Contributed Image get archived ?
Contributed images will be archived after expiry, which is six months from the published date. The original creator gets notification a month before the expiry date. After the image archival process, the image will be unpublished from the Contributed image list and held in an Archived image list.