Advanced Cluster Options
Also available as:
PDF

Structure of the image catalog

Use this information to create a valid image catalog.

The image catalog JSON file includes the following two high-level sections:

  • images: Contains information about the created images. The burned images are stored in the base-images section.
  • versions: Contains the cloudbreak entry, which includes mapping between Cloudbreak versions and the image identifiers of burned images available for these Cloudbreak versions.
Note
Note

After adding your image(s) to the images section, make sure to also update the versions section.

The images section

The burned images are stored in the base-images sub-section of images. The base-images section stores one or more image “records”. Every image “record” must contain the date, description, images, os, os_type, and uuid fields.

Parameter Description
date Date for your image catalog entry.
description Description for your image catalog entry.
images The image sets by cloud provider. An image set must store the virtual machine image IDs by the related region of the provider (AWS, Azure) or contain one default image for all regions (GCP, OpenStack). The virtual machine image IDs come from the result of the image burning process and must be an existing identifier of a virtual machine image on the related provider side. For the providers which use global rather than per-region images, the region should be replaced with default .
os The operating system used in the image.
os_type The type of operating system which will be used to determine the default Ambari and HDP/HDF repositories to use. Set os_type to “redhat6” for amazonlinux or centos6 images. Set os_type to “redhat7” for centos7 or rhel7 images.
uuid The uuid field must be a unique identifier within the file. You can generate it or select it manually. The utility uuidgen available from your command line is a convenient way to generate a unique ID.
package-versions The package versions used for Salt (salt) and Salt Bootstrap (salt-bootstrap).

The versions section

The versions section includes a single “cloudbreak” entry, which maps the uuids to a specific Cloudbreak version:

Parameter Description
images Image uuid, same as the one that you specified in the base-images section.
versions The Cloudbreak version(s) for which you would like to use the images.