Nebula
Control plane

LeaseInfo

Describes the current worker assignment for one container.

generated from the sources
public sealed class LeaseInfo

Describes the current worker assignment for one container.

Fields

Instance

public InstanceContainerInfo Instance;

ContainerId

public string ContainerId;

WorkerId

public string WorkerId;

Epoch

public ulong Epoch;

State

public string State;

UpdatedAt

public DateTime UpdatedAt;

HasBounds

public bool HasBounds;

Runtime containers (ContainerRegistry.RegisterRuntime) carry their box on the lease row, so every process can register the same box from the row alone. False for a baked or carried container.

ParentId

public string ParentId = "";

The parent container's id, or empty for a root of its scope (docs/container-tree.md D5). A child's Center is local to its parent's frame.

Center

public Double3 Center;

Box centre, in double: absolute for a root, local to the parent's frame for a child.

BoundsSize

public Vector3 BoundsSize;

Authority

public ContainerAuthority Authority;

Who simulates what is inside. On a runtime row ContainerAuthority.Inherited means the row only carries the box: the orchestrator never deals it and nobody reads an owner from it. On a carried container's row (label#netId) ContainerAuthority.Leased means the container was authored leased: the orchestrator re-deals it instead of letting it follow its carrier.

OwnPhysicsFrame

public bool OwnPhysicsFrame;

The container has its own physics frame (docs/container-tree.md §3).

FrameInterest

public FrameInterestMode FrameInterest;

How a framed container's contents are bucketed for interest.

FrameApproachMargin

public float FrameApproachMargin;

Metres from the box within which a client in the space around a frame with its own regions also looks into it (Container.FrameApproachMargin); 0 is off.

HasHint

public bool HasHint;

A balancing hint was set for this container while the mesh runs (IControlPlane.SetContainerHint). It travels beside the lease and is stored with it, so an orchestrator that restarts sees it again; when false the baked hint (Container.Hint) stands.

Hint

public ContainerHint Hint = ContainerHint.Default;

The runtime hint, when HasHint.

HasCapacity

public bool HasCapacity;

The orchestrator has published a capacity reading for this container (IControlPlane.SetContainerCapacity, docs/capacity-admission.md). False means no worker has reported cost for it lately, and an unknown container is never at capacity.

Saturation

public float Saturation;

The dominant cost component's share of its own budget, when HasCapacity. 1 = the whole budget.

Dominant

public CostComponent Dominant;

Which component Saturation is about.

AtCapacity

public bool AtCapacity;

Saturation reached NebulaConfig.CapacitySaturation. The orchestrator decides it, so every gateway of a mesh answers the same way without knowing the threshold.

SaturationCause

public SaturationCause SaturationCause;

Why the planner cannot relieve it by moving anything (SaturationReport.Cause), or Nebula.SaturationCause.None when the reading is cost telemetry alone.

Properties

BoundsCenter

public Vector3 BoundsCenter { get; set; }

Center narrowed to float, for callers that only ever held small boxes.

Bounds

public Bounds Bounds { get; }

The row's box as stored (absolute for a root, parent-local for a child), when HasBounds.

IsRoot

public bool IsRoot { get; }

Whether the row's box is a root of its scope.

Placement

public ContainerPlacement Placement { get; }

The row's placement, when HasBounds.

On this page