Skip to main content

ClusterController

Struct ClusterController 

Source
pub struct ClusterController {
    pub host: String,
    pub port: u16,
    pub path: String,
    pub docker: Option<String>,
    pub arch: Option<String>,
    pub data_path: Option<String>,
    pub join: Option<ClusterJoin>,
}
Expand description

Controller-side cluster config. Holds the rendezvous bind point and pre-flight build context. The controller is the orchestrator host fdl-cli runs on; it is NOT a NCCL rank itself.

Rejected fields (via deny_unknown_fields): ranks, local_devices, ssh* (controller is local to fdl-cli), per-controller env (use cluster-scope env: instead) — and any mistyped key.

Fields§

§host: String

Bind address. Used as the rendezvous endpoint workers dial. What was cluster.controller.host in the pre-Refactor-2 schema.

§port: u16

Bind port. What was cluster.controller.port in the pre-Refactor-2 schema. Defaults to DEFAULT_CONTROLLER_PORT when omitted.

§path: String

Controller’s view of the shared project root. Used by the pre- flight build phase to drive cargo invocations from the controller’s filesystem perspective; the remote-side path (each worker’s ClusterWorker::path) is used at runtime via SSH.

On homogeneous-mount rigs the controller’s view equals every worker’s view; on heterogeneous rigs (different mount points per host), the controller’s value diverges (e.g. the controller sees /opt/flodl while a VM worker sees /mnt/flodl).

§docker: Option<String>

Docker compose service the controller runs the pre-flight build inside (e.g. cuda, dev). Optional; affects build context only.

§arch: Option<String>

libtorch variant subpath under <path>/libtorch/ for the pre-flight build (e.g. precompiled/cu128, builds/sm61-sm120). When unset, fdl-cli falls back to the controller’s project-root .active file.

§data_path: Option<String>

Shared-storage path visible to the controller. flodl assumes a shared filesystem reachable at the same logical path on every node — training data, model checkpoints, and per-rank logs all live here. When absent, the convention default DEFAULT_DATA_PATH applies.

§join: Option<ClusterJoin>

Join-window quorum knobs (dial-in membership). fdl-cli carries the block through the launcher envelope verbatim; flodl owns validation and the capacity-derived defaults.

Implementations§

Source§

impl ClusterController

Source

pub fn effective_data_path(&self) -> &str

Effective shared-data path: data_path if set, else DEFAULT_DATA_PATH.

Trait Implementations§

Source§

impl Clone for ClusterController

Source§

fn clone(&self) -> ClusterController

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClusterController

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClusterController

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ClusterController

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.