The environment variables are passed to containers or added to the environment variable through profile or configuration files. The following environment variables are available to set and modify:
| Environment variable name | Description |
|---|---|
SWARM_LOOPBACK |
Used to bypass Swarm Learning to help you quickly develop, integrate, and test your model code with Swarm Learning package.If SWARM_LOOPBACK is set to 'True', then all Swarm functionality will be bypassed, except parameter validation. This can help you to verify and test integration of the model code with Swarm without spawning any Swarm Learning containers. |
LOGS_DIR |
Sets the directory for Swarm components log, it is set usually by Docker file. |
USR_DIR |
Sets the directory for Swarm components, it is set usually by Docker file. |
SN_ETH_PORT_EXT |
Sets an Ethernet port for Swarm Network node. |
SN_I_AM_SENTINEL |
Sets a Swarm Network node to become the Sentinel node, only when it is set to true. Default value: False |
SN_START_MINING |
Starts mining on non-sentinel nodes. (Optional) Default value: False |
SL_WAIT_FOR_FULL_QUORUM_SECONDS |
Sets the maximum time for an SL leader node to wait for full quorum after minPeers are ready for merge. This parameter lets you to maximize the number of peers participating in the merge process. Default value: 30 secs |
SWCI_TASK_MAX_WAIT_TIME |
Specifies a maximum timeout value for the completion of a task. This value must be set in minutes, and the default is 120 mins (2 hours). |
SWCI_MODE |
Enables SWCIs web interface instead of command line interface. Allowed values are CLI and WEB. Default value: CLI |
SWCI_STARTUP_SCRIPT |
This is a default start script of SWCI. |
SWCI_WEB_PORT |
Default port on which SWCI-WEB starts server. |
SWOP_PROFILE |
Indicates default profile for SWOP. |
SWOP_KEEP_CONTAINERS |
By default, SL and ML containers spawned by SWOP are removed. This option can be enabled to retain the stopped containers for debugging. Default value: False |
SWARM_ID_CACERT |
Indicates user CA certificates file. |
SWARM_ID_CAPATH |
Indicates user CA certificates directory. |
SWARM_ID_CERT |
Indicates user certificates file. |
SWARM_ID_KEY |
Indicates user SSH key file. |
SWARM_SPIFFE_WORKLOAD_API_SOCKET_PATH |
Used for acquiring a SPIFFE identity. It points to the UNIX domain socket on which the SPIFFE agent is serving the SPIFFE workload API. For more information, https://spiffe.io/ |