MiroirNode
miroir.home-operations.com / v1alpha1
apiVersion: miroir.home-operations.com/v1alpha1
kind: MiroirNode
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
MiroirNodeSpec is one storage node's desired topology: its named pools
plus node-level replication settings. Rendered by the Helm chart from
the release's `nodes` values; read by the controller for placement and
by the node's agent for backend selection.
address
string
Address optionally pins the node's DRBD replication endpoint to a
dedicated storage NIC/VLAN IP (IPv4 or IPv6); empty falls back to
the node's InternalIP. It applies to volumes created afterwards —
existing volumes keep the address persisted at creation. An explicit
empty string means unset (0.10 values files carry them).
maxLength:
45
autoEvict
boolean
AutoEvict, when explicitly false, exempts this node from auto-evict:
its legs are never re-placed while its heartbeat is stale (a node
with known long outages). Absent means eligible.
pools []object required
Pools lists this node's storage pools, one entry per pool. Every
node in the topology carries at least one.
minItems:
1maxItems:
32loopfile object
Loopfile makes this a loopfile pool.
baseDir
string required
BaseDir is the directory holding the sparse files, e.g.
"/var/lib/miroir". Must be reflink-capable (XFS reflink=1 or btrfs)
for CoW snapshots; the agent refuses the pool otherwise.
minLength:
1maxLength:
256lvmthin object
LVMThin makes this an lvmthin pool.
device
string
Device is the block device backing the pool's VG. Optional when the
VG already exists (a pre-provisioned or shared VG); required for the
agent to create it on first start.
maxLength:
256
poolSize
string
PoolSize bounds the thin pool (an lvm size spec, e.g. "400g");
empty claims all free VG space.
maxLength:
32
name
string required
Name is the pool name ("default" for the pre-multi-pool single
pool). It becomes an LVM VG name suffix, a metric label value, and a
StorageClass parameter, so it stays a short lowercase identifier.
pattern:
^[a-z0-9]([a-z0-9-]{0,30}[a-z0-9])?$zfs object
ZFS makes this a zfs pool.
compression
string
Compression is the compression property for newly created zvols;
"inherit" uses the parent dataset's setting. Existing zvols are not
mutated, and snapshot clones retain their source properties. Empty
means the default (lz4) — 0.10 values files carry explicit empty
strings, and the agent has always defaulted them.
pattern:
^(|inherit|on|off|lz4|lzjb|zle|gzip(-[1-9])?|zstd(-([1-9]|1[0-9]))?|zstd-fast(-(10|[1-9]|[2-9]0|100|500|1000))?)$
dataset
string required
Dataset is the parent dataset for zvols.
minLength:
1maxLength:
256
volBlockSize
string
VolBlockSize is the volblocksize property for newly created zvols.
Empty means the default (4K), for the same 0.10 compatibility reason
as Compression.
enum:
, 4K, 8K, 16K, 32K, 64K, 128K
zone
string
Zone is an optional failure domain (rack, host group, AZ). When set,
the controller spreads a volume's replicas across distinct zones;
empty means unconstrained.
maxLength:
63status object
MiroirNodeStatus is the pool capacity this node's agent publishes for
capacity-aware placement and overcommit guardrails.
conditions []object
Conditions follow the standard Kubernetes condition conventions;
PoolUsageHigh fires at the 80% data/metadata warn line (any pool).
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
drbdUtilsVersion
string
DRBDUtilsVersion is the drbd-utils userland version the agent
probed at startup (e.g. "9.34.3"). Unlike the kernel module the
utils ship in the agent image, so this varies per agent rollout
rather than per host.
drbdVersion
string
DRBDVersion is the DRBD kernel module version the agent probed at
startup (e.g. "9.3.2"); absent on nodes without the module. The
module ships with the host, not the agent image, so this is the
per-node view that makes mixed clusters visible mid-upgrade.
observedAt
string
ObservedAt is when these figures were last sampled; the controller
ignores stats older than a few poll intervals as unknown.
format:
date-timepools []object
Pools carries one capacity entry per storage pool on this node.
allocatedBytes
integer
AllocatedBytes is the pool capacity currently used (all tenants).
format:
int64
capacityBytes
integer
CapacityBytes is the total size of this node-local pool.
format:
int64
message
string
Message carries the last stats-sampling error for this pool, if
any — a pool whose backend cannot be read stays visible instead of
silently dropping out of the list.
metaUsedPercent
integer
MetaUsedPercent is the dm-thin metadata usage (lvmthin only; 0
otherwise), rounded — exhausting metadata wedges the pool
independently of data space.
format:
int32
name
string required
Name is the pool name from the node map.
No matches. Try .spec.address for an exact path