image

Description

Venue	Equivalent Concept(s)
	Amazon Machine Image (AMI)
	Managed Image

An instance image used when creating a virtual machine. Defines the boot and optionally data devices, and other settings. It is also called a template.

Venue-Specific Properties

These fields are subject to change in the future. They allow for venue- specific behavior.

AWS

venue:
  aws:
    image_id: The id of the ami image you wish to use

To provision a virtual machine in AWS you must provide an image_id.

Azure

venue:
  azure:
    image: The name of the image or the full id of the image to use.  If you
           specify a name, the folder containing the image is used to locate
           it in the correct resource group.

Required Properties

This object has no required properties, but it likely requires a combination of optional properties to be useful.

Optional Properties

product (string)

The product name.

Example(s):

• GitHub-Enterprise

• UbuntuServer

• WindowsServer

publisher (string)

The name of the entity that published the image.

Example(s):

• Canonical

• GitHub

• MicrosoftWindowsServer

sku (string)

The version family.

Example(s):

• 18.04-LTS

• 2019-Datacenter-with-Containers

version (string)

The version of the product. If omitted, the latest version is used. If multiple versions are found that begin with the specified version, the ambiguity is resolved by policy (TODO!).

Example(s):

• 18.04.201902190

• 2.9.9

• latest

The default value if not specified is latest.

Common Properties

count (integer)

Indicates how many of this image should exist. When count is specified the name of the given resource will have a hyphen and numeric suffix added automatically, unless the count variable is referenced in the blueprint object name.

depends_on (⏩ any)

This property can be used to declare a dependency from this image to any other object in the blueprint. This is not necessary for dependencies generated normally by the schema.

folder (▶ location.folder)

The folder containing this image. If this is not specified and there is only one folder defined, that folder is used automatically.

name (string)

The name of this image. The name can be different than the blueprint object name. When the name property is not present we apply automatic naming strategies to make resources easier to identify in each venue's management console. When the name property is specified we will use it exactly as specified.

readonly (boolean)

Indicates whether or not this image is read-only. If so, we verify only the existence and correctness of this image to its specification rather than creating or modifying it.

The default value if not specified is false.

tags (dict)

The tags to place on this image. Tags are metadata stored in (key = value, ...) form. Consumers are not allowed to use tags that begin with _tuono as those are reserved.

Discovered Properties

These properties are populated and available in the inventory following a successful apply.

id (string)

The venue-specific identifier of this image.

Examples

Define an Ubuntu Bionic image:

compute:
  image:
    example-image:
      product: UbuntuServer
      publisher: Canonical
      sku: 18.04-LTS
location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA

Define a Windows Server image:

compute:
  image:
    example-image:
      product: WindowsServer
      publisher: MicrosoftWindowsServer
      sku: 2019-Datacenter-with-Containers
location:
  folder:
    example-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA

Define a custom image on AWS:

compute:
  image:
    example-custom-image:
      folder: other-folder
      venue:
        aws:
          image_id: ami-01234656789abcdef
location:
  folder:
    example-folder:
      region: example-region
    other-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA

Define a custom image on Azure:

compute:
  image:
    example-custom-image:
      folder: other-folder
      venue:
        azure:
          image: /subscriptions/eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee/resourceGroups/example-folder/providers/Microsoft.Compute/images/example-custom-image
location:
  folder:
    example-folder:
      region: example-region
    other-folder:
      region: example-region
  region:
    example-region:
      area: west
      country: USA