Add base instances for instance config inheritance

Instances can be marked as a base with instance.is_base and other
instances inherit config values from it through instance.base_id.
The controller copies base values into inheriting configs and keeps
track of inherited fields in the hidden instance.inherited_fields, so
hosts receive resolved configs and need no changes. Setting a field
stops inheriting it, `instance config inherit` undoes that.

Bases cannot be assigned to a host, are hidden from `instance list`
unless --bases is given, and cannot be deleted or unmarked while
other instances inherit from them. Chains of bases are allowed and
cycles are rejected.

Part of #200

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-02 11:54:21 +00:00
1 parent 024d7b427a
commit 01cf789f5d
16 files changed
+769 -26

No files matched your search

+22
View File
@@ -521,6 +521,28 @@ This allows you to prevent certain instances from being started when using the b
Defaults to false.
### instance.is_base
If enabled this instance is a base other instances can inherit config values from.
Base instances cannot be assigned to a host and therefore never start.
Hidden from `instance list` in clusterioctl unless `--bases` is passed.
An instance cannot stop being a base while other instances inherit from it.
Defaults to false.
### instance.base_id
ID of the base instance to inherit config values from.
Inherited fields take their value from the base and follow it when it changes, setting a field on this instance stops inheriting it.
When set on an existing instance only fields with the same value as the base become inherited.
`instance.name`, `instance.is_base`, `instance.base_id` and hidden fields are never inherited.
A base may itself inherit from another base, but not from itself through a chain of bases.
The fields currently inherited are stored in the hidden `instance.inherited_fields` field.
Defaults to null meaning no base.
### factorio.version
Version of Factorio to use for this instance.