Configuration options#

Some instance options:

agent.nic_config

Set the name and MTU to be the same as the instance devices

Default:

false

  • Type:

    bool

  • Live update:

    no

  • Condition:

    Virtual machine

Controls whether to set the name and MTU of the default network interfaces to be the same as the instance devices (this happens automatically for containers)

migration.incremental.memory.iterations

Maximum number of transfer operations

Default:

10

  • Type:

    integer

  • Live update:

    yes

  • Condition:

    container

Maximum number of transfer operations to go through before stopping the instance

cluster.evacuate

What to do when evacuating the instance

Default:

auto

  • Type:

    string

  • Live update:

    no

Controls what to do when evacuating the instance (auto, migrate, live-migrate, or stop)

These need the instance scope to be specified as second argument. The default scope is server, so this argument isn’t required.

Some server options:

backups.compression_algorithm

Compression algorithm for images

Default:

gzip

  • Type:

    string

  • Scope:

    global

Compression algorithm to use for new images (bzip2, gzip, lzma, xz or none)

instances.nic.host_name

How to generate a host name

Default:

random

  • Type:

    string

  • Scope:

    global

If set to random, use the random host interface name as the host name; if set to mac, generate a host name in the form lxd<mac_address> (MAC without leading two digits)

instances.placement.scriptlet

Custom automatic instance placement logic

  • Type:

    string

  • Scope:

    global

Stores the Instance placement scriptlet for custom automatic instance placement logic

maas.api.key

API key to manage MAAS

  • Type:

    string

  • Scope:

    global

API key to manage MAAS

Any other scope is also possible. This scope shows that you can use formatting, mainly in the short description and the description, and the available options.

test1

testing

Testing.

test2

Hello! bold and code

This is the real text.

With two paragraphs.

And a list:

  • Item

  • Item

  • Item

And a table:

Key

Type

Scope

Default

Description

acme.agree_tos

bool

global

false

Agree to ACME terms of service

acme.ca_url

string

global

https://acme-v02.api.letsencrypt.org/directory

URL to the directory resource of the ACME service

acme.domain

string

global

-

Domain for which the certificate is issued

acme.email

string

global

-

Email address used for the account registration

test3

testing

Default:

false

  • Type:

    Type

  • Live update:

    Python parses the options, so “no” is converted to “False” - to prevent this, put quotes around the text (“no” or “no”)

  • Condition:

    yes

  • Read-only:

    maybe - also add quotes if the option starts with code

  • Resource:

    Resource,

  • Managed:

    Managed

  • Required:

    Required

  • Scope:

    (this is something like “global” or “local”, not the scope of the option (server, instance, …)

Content

To reference an option, use {config:option}. It is not possible to override the link text. Except for server options (default), you must specify the scope.

migration.incremental.memory.iterations

test1

maas.api.key

The index is here: Configuration options