RemoteEnvironment(key: str, orchestrator_ip: str, factories_ips: List[str], user: str, local_user: str, public_orchestrator_ip: Optional[str] = None, public_factories_ips: Optional[List[str]] = None, **kwargs)¶
This objects contains information about the cluster
This object will be available on the remote execution of the ClusterRunnable (as an attribute).
IMPORTANT: this object needs to be serializable, hence it Needs to be created using ‘compile’ method.
The key that communicates the cluster
The orchestrator visible IP for the factories (usually the private IP)
The list of factories IPs visible for other factories and orchestrator (usually private IPs)
The username of all machines. This implementations assumes same username for all machines
The username of the local process that launched the cluster
The public orchestrator IP, if available.
The public factories IPs, if available.
to_yaml(cls, representer: Any, node: Any, tag: str)¶
Use representer to create yaml representation of node
from_yaml(cls, constructor: Any, node: Any, factory_name: str)¶
Use constructor to create an instance of cls