References: Specification files

parent

Name of the catlet parent in geneset reference format. A geneset reference has to be specified in format <org>/<geneset>/<optional tag>. If <optional tag> is missing tag "latest" will be used.

The catlet will inherits all settings of the parent if not specified otherwise in the catlet (either by overwrites or mutations, see also below for mutations on capabilities, disks and fodder).

project

Name of the project to which the catlet will be assigned.
If omitted, the default project is used.

Projects are used to isolate catlets in terms of security requirements, network access, and storage.
Catlets between different projects cannot reach each other when overlay networks are used. Even at the storage level, catlets can only access volumes from the same project.

location

Catlet name on storage level.
Has to be unique within a project and environment.

Set the location if you would like to have human readable name also on file system level. Default is a time dependend generated value (aka storage identifier).

environment

The catlet's environment.
If missing the environment "default" will be used.

Environments can be used to place catlets with the same specification on different networks and datastore paths. A typical use case is to separate production and staging environments. Catlets in different environments can reach each other on the network, but are separated by subdomains (in the case of overlay networks).

store

Catlet datastore name, as configured in the agent settings.
If missing the datastore "default" will be used.

Datastores can be used to separate volumes and configurations according to your needs, for example, one storage with SSDs and another with HDDs. The datastore declared here will be used for catlet configuration files and not for disks.

name

Name of the drive in unix device name format (sda, sdb, etc..).
sda will be first disk, sdb second and so on. You can use a human readable name here, however in this case the disk controller position is no longer stable.

mutation

Optional setting on how parent disks should be inherited.
One of: merge, overwrite, remove

The default is merge, which means that settings on child catlets will overwrite parent settings for disks with the same name. Catlet disk will be a differencial disk.
With the value overwrite no parent settings are considered including the disk data (see source).
With remove parent disk will be removed completely.

location

Disk location name on storage.
Set the location if you want to reference or create a disk in a known location. If omitted, the catlet's location will be used.

This is useful if you want to use an existing disk or share the disk with other catlets. See also type for shared disks.

store

Disk datastore name, as configured in the agent settings.

Datastores can be used to separate volumes and configurations according to your needs, for example, one storage with SSDs and another with HDDs.

source

The disk source can be either a file path or a gene reference.

As a gene reference it has to be of format: gene:<org>/<geneset>/<optional tag>:<gene>, which will reference a gene from specified geneset on the genepool.

As a file path the disk path has to be accessable from the host agent / eryph-zero (not the client).
If disk type (see below) is DVD a ISO file is expected, otherwise a vhdx file. The catlet disk will be created as differencial disk with source as parent.
If source is empty a empty disk volume will be create.

type

Type of disk to be created.
One of: VHD, SharedVHD, PHD, DVD, VHDSet
If omitted, the type VHD is used.

SharedVHD and VHDSets are only supported on Windows servers with shared storage. Both cause the VHD to be copied from the source and not created as a differencial disk regardless of other settings. You have to set location for shared disks, as without it, each catlet will use its own location so they never map to same shared disk.

DVD will create a DVD disk with can consume a ISO file for a CD/DVD image.
PHD is reserved for future use (physical disk, LUN) and will not work.

mutation

Optional setting on how parent adapters should be inherited.
One of: merge, overwrite, remove

The default is merge, which means that settings on child catlets will overwrite parent settings for network adapters with the same name. With the value overwrite no parent settings are considered.
With remove parent network adapter will be removed completely.

mutation

Optional setting on how parent capabilities should be inherited.
One of: merge, overwrite, remove

The default is merge, which means that settings on child catlets will overwrite parent settings for capabilities with the same name. With the value overwrite no parent settings are considered for the capability.
With remove parent capability configuration will be removed.

dynamic_memory

Configures dynamic memory settings of the catlet.

secure_boot

Configures secure boot settings of the catlet.

nested_virtualization

Configures nested virtualization settings of the catlet.

mutation

Optional setting on how parent networks should be inherited.
One of: merge, overwrite, remove

The default is merge, which means that settings on child catlets will overwrite parent settings for networks with the same name. With the value overwrite no parent settings are considered for the network.
With remove parent network configuration will be removed.

adapter_name

Name of the network adapter this network will be bound to.

If not specified this will be auto assigned in the order of networks (eth0, eth1, etc.). If not enough adapters exists for each network new adapters will be created.

type

Fodder content type. Currently same as cloud-init supported user data formats.
One of: include-url, include-once-url,cloud-config-archive,upstart-job,cloud-config,part-handler,shellscript,cloud-boothook

If missing "cloud-init" is used.

content

Fodder content. Can be both specified as multiline string with |

Copy content: |
   multiline 
   content as string

or directly in yaml in case content is also YAML content like cloud-init configuration.

Copy content: 
   package_update: true

You can use variables within the fodder content like this:

{{ variable_name }}

Where variable_name is the name of a variable declared above (in fodder/catlet gene spec).

Copy content: 
   package_update: '{{ updatePackages }}'

variables

This setting is used to set variable values of referenced genes.
You can also use it to rebind variable values to a variable from the current gene. To set a variable you must specify the name of the referenced variable and the value of the variable. You can use a fixed value here or again a variable but this time from the current gene spec.

Copyvariables:
- name: spec_password
  required: true
  secret: true

fodder: 
- source: gene:dbosoft/starter-food:linux-starter
  variables: 
  - name: password
    value: "{{ spec_password }}"

environment

Optional setting of network environment.
If the environment is missing, the default environment is used.

If you set the environment for a network, catlets with the corresponding environment will use this network if both the network name and the environment match. Environment allows you to separate catlets, but still allow them to communicate with each other (see domain default below). Typical use cases for environments are staging and production environments that define the same services.

provider

Network provider name or settings. If omitted, the network provider "default" is used.

This setting configures which network provider from the network providers configuration should be used.

subnets

List of subnets declared in the network.
A network must contain at least one subnet.
See below for subnet settings.

For overlay networks, you should always define a "default" subnet, as this subnet will be used by all catlets that don't explicitly change the subnet. Flat networks don't use this setting, but the subnet settings of the network provider.

name

Name of the network provider
The network provider that should be used for the network.

If you specify a flat network here, the network will use the settings of the network provider for subnets and ip pools of the project network.
Otherwise it will use network provider subnets and ip pools to route and NAT traffic between the virtual network and the provider network.