nvflare.lighter.constants module

class AdminRole

Bases: object

LEAD = 'lead'

MEMBER = 'member'

ORG_ADMIN = 'org_admin'

PROJECT_ADMIN = 'project_admin'

class CertFileBasename

Bases: object

CLIENT = 'client'

OVERSEER = 'overseer'

SERVER = 'server'

class CommConfigArg

Bases: object

CONN_GEN = 'conn_gen'

CONN_SEC = 'conn_sec'

HOST = 'host'

PORT = 'port'

SCHEME = 'scheme'

class ConnSecurity

Bases: object

CLEAR = 'clear'

MTLS = 'mtls'

TLS = 'tls'

class CtxKey

Bases: WorkDir, PropKey

BUILD_ERROR = '__build_error__'

CLIENT_MAP = 'client_map'

LAST_PROD_STAGE = 'last_prod_stage'

LOGGER = '__logger__'

PROJECT = '__project__'

PROVISION_MODE = '__provision_model__'

RELAY_MAP = 'relay_map'

ROOT_CERT = 'root_cert'

ROOT_PRI_KEY = 'root_pri_key'

SERVER_NAME = 'server_name'

TEMPLATE = '__template__'

TEMP_FILES_LOADED = '__temp_files_loaded__'

class OverseerRole

Bases: object

ADMIN = 'admin'

CLIENT = 'client'

SERVER = 'server'

class ParticipantType

Bases: object

ADMIN = 'admin'

CLIENT = 'client'

OVERSEER = 'overseer'

RELAY = 'relay'

SERVER = 'server'

class PropKey

Bases: object

ADMIN_PORT = 'admin_port'

ALLOW_ERROR_SENDING = 'allow_error_sending'

API_ROOT = 'api_root'

API_VERSION = 'api_version'

AUTHZ_SECTION_KEY = '__authz_section_key__'

CAPACITY = 'capacity'

COMM_CONFIG_ARGS = '__comm_config_args__'

CONNECT_TO = 'connect_to'

CONN_SECURITY = 'connection_security'

CUSTOM_CA_CERT = 'custom_ca_cert'

DEFAULT_HOST = 'default_host'

DESCRIPTION = 'description'

FED_LEARN_PORT = 'fed_learn_port'

FQCN = '__fqcn__'

FQSN = '__fqsn__'

GPU_MEM = 'mem_per_gpu_in_GiB'

HOST = 'host'

HOST_NAMES = 'host_names'

IS_LEAF = '__is_leaf__'

LISTENING_HOST = 'listening_host'

NAME = 'name'

NUM_GPUS = 'num_of_gpus'

ORG = 'org'

OVERSEER_END_POINT = 'overseer_end_point'

PARENT = 'parent'

PORT = 'port'

PROTOCOL = 'protocol'

ROLE = 'role'

RUN_IN_DOCKER = 'run_in_docker'

SCHEME = 'scheme'

TYPE = 'type'

class ProvFileName

Bases: object

AUTHORIZATION_JSON_DEFAULT = 'authorization.json.default'

AWS_START_SH = 'aws_start.sh'

AZURE_START_SH = 'azure_start.sh'

CHART_YAML = 'Chart.yaml'

CLIENT_CONTEXT_TENSEAL = 'client_context.tenseal'

COMM_CONFIG = 'comm_config.json'

COMPOSE_BUILD_DIR = 'nvflare_compose'

COMPOSE_YAML = 'compose.yaml'

CUSTOM_CA_CERT_FILE_NAME = 'customRootCA.pem'

DEPLOYMENT_OVERSEER_YAML = 'deployment_overseer.yaml'

DOCKERFILE = 'Dockerfile'

DOCKER_BUILD_SH = 'docker_build.sh'

DOCKER_LAUNCHER_SH = 'docker_launcher.sh'

DOCKER_SH = 'docker.sh'

ENV = '.env'

FED_ADMIN_JSON = 'fed_admin.json'

FED_CLIENT_JSON = 'fed_client.json'

FED_RELAY_JSON = 'fed_relay.json'

FED_SERVER_JSON = 'fed_server.json'

FL_ADMIN_SH = 'fl_admin.sh'

GUNICORN_CONF_PY = 'gunicorn.conf.py'

HELM_CHART_DIR = 'nvflare_hc'

HELM_CHART_TEMPLATES_DIR = 'templates'

LAUNCHER_DOCKERFILE = 'Dockerfile.launcher'

LOG_CONFIG_DEFAULT = 'log_config.json.default'

PRIVACY_JSON_SAMPLE = 'privacy.json.sample'

PRIVILEGE_YML = 'privilege.yml'

README_TXT = 'readme.txt'

RELAY_RESOURCES_JSON = 'relay__resources.json'

REQUIREMENTS_TXT = 'requirements.txt'

RESOURCES_JSON_DEFAULT = 'resources.json.default'

SERVER_CONTEXT_TENSEAL = 'server_context.tenseal'

SERVICE_OVERSEER_YAML = 'service_overseer.yaml'

SIGNATURE_JSON = 'signature.json'

START_SH = 'start.sh'

STOP_FL_SH = 'stop_fl.sh'

SUB_START_SH = 'sub_start.sh'

SYSTEM_INFO_IPYNB = 'system_info.ipynb'

VALUES_YAML = 'values.yaml'

class ProvisionMode

Bases: object

NORMAL = 'normal'

POC = 'poc'

class TemplateSectionKey

Bases: object

ADMIN_README = 'readme_am'

ADM_NOTEBOOK = 'adm_notebook'

AWS_START_SH = 'aws_start_sh'

AZURE_START_CLN_HEADER_SH = 'azure_start_cln_header_sh'

AZURE_START_COMMON_SH = 'azure_start_common_sh'

AZURE_START_SVR_HEADER_SH = 'azure_start_svr_header_sh'

CC_AUTHZ = 'cc_authz'

CLIENT_README = 'readme_fc'

CLOUD_SCRIPT_HEADER = 'cloud_script_header'

COMM_CONFIG = 'comm_config'

COMPOSE_YAML = 'compose_yaml'

DEFAULT_AUTHZ = 'default_authz'

DOCKERFILE = 'dockerfile'

DOCKER_ADMIN_SH = 'docker_adm_sh'

DOCKER_BUILD_SH = 'docker_build_sh'

DOCKER_CLIENT_SH = 'docker_cln_sh'

DOCKER_LAUNCHER_CLIENT_SH = 'docker_launcher_cln_sh'

DOCKER_LAUNCHER_SERVER_SH = 'docker_launcher_svr_sh'

DOCKER_SERVER_SH = 'docker_svr_sh'

FED_ADMIN = 'fed_admin'

FED_CLIENT = 'fed_client'

FED_RELAY = 'fed_relay'

FED_SERVER = 'fed_server'

FL_ADMIN_SH = 'fl_admin_sh'

GUNICORN_CONF_PY = 'gunicorn_conf_py'

HELM_CHART_CHART = 'helm_chart_chart'

HELM_CHART_DEPLOYMENT_OVERSEER = 'helm_chart_deployment_overseer'

HELM_CHART_DEPLOYMENT_SERVER = 'helm_chart_deployment_server'

HELM_CHART_SERVICE_OVERSEER = 'helm_chart_service_overseer'

HELM_CHART_SERVICE_SERVER = 'helm_chart_service_server'

HELM_CHART_VALUES = 'helm_chart_values'

LAUNCHER_DOCKERFILE = 'launcher_dockerfile'

LOCAL_CLIENT_RESOURCES = 'local_client_resources'

LOCAL_SERVER_RESOURCES = 'local_server_resources'

LOG_CONFIG = 'log_config'

RELAY_RESOURCES_JSON = 'relay_resources_json'

SAMPLE_PRIVACY = 'sample_privacy'

SERVER_README = 'readme_fs'

START_CLIENT_SH = 'start_cln_sh'

START_OVERSEER_SH = 'start_ovsr_sh'

START_SERVER_SH = 'start_svr_sh'

STOP_FL_SH = 'stop_fl_sh'

SUB_START_SH = 'sub_start_sh'

class WorkDir

Bases: object

CURRENT_PROD_DIR = 'current_prod_dir'

STATE = 'state_dir'

WIP = 'wip_dir'

WORKSPACE = 'workspace'