Configuration Files

Configuration Files

All Brane configuration files are YAML and can be generated with branectl then customized manually. After editing, restart the node to apply changes.

node.yml

The primary configuration file for any node.

Central node:

node:
  kind: central
  hostname: central.example.com
paths:
  certs: ./config/certs
  infra: ./config/infra.yml
  proxy: ./config/proxy.yml
services:
  api:
    port: 50051
  drv:
    port: 50053
  plr:
    port: 50055
  prx:
    port: 50054

Worker node:

node:
  kind: worker
  hostname: worker-a.example.com
  location_id: hospital-a
paths:
  certs: ./config/certs
  backend: ./config/backend.yml
  proxy: ./config/proxy.yml
  policy_deliberation_secret: ./config/policy_deliberation_secret.json
  policy_expert_secret: ./config/policy_expert_secret.json
  policy_db: ./policies.db
services:
  job:
    port: 50052
  reg:
    port: 50056
  chk:
    port: 50057
  prx:
    port: 50054

infra.yml (Central Only)

Registers worker nodes in the instance.

locations:
  hospital-a:
    address: 10.0.1.1
  hospital-b:
    address: worker-b.example.com

backend.yml (Worker Only)

Defines how the worker executes containers.

backend:
  kind: local

proxy.yml

Configures network proxying. Default settings work for most deployments.

Certificate Files

File	Purpose	Share with
ca.pem	Root of trust for a domain	Central node
server.pem	Proves domain identity	Keep private
client-id.pem	Proves identity to another domain	Target domain

Central node certificate layout

config/certs/
  hospital-a/
    ca.pem       # Hospital A's CA certificate
  hospital-b/
    ca.pem       # Hospital B's CA certificate

Worker node certificate layout

config/certs/
  ca.pem            # This domain's CA
  server.pem        # This domain's server cert
  hospital-b/       # Peer certificates (optional)
    ca.pem
    client-id.pem

container.yml (Package Definition)

name: data_processor
version: 2.1.0
kind: ecu

dependencies:
  - python3
  - python3-pip

files:
  - src/processor.py

entrypoint:
  kind: task
  exec: src/processor.py

actions:
  'preprocess':
    command:
      args:
      - preprocess
    input:
    - name: dataset_path
      type: string
    output:
    - name: result_path
      type: string

I/O types

Type	Description
string	Text value
integer	Whole number
real	Floating point
boolean	True/false

How function calls work

1. Inputs are set as environment variables
2. command.args are passed as CLI arguments
3. Function prints output to stdout as YAML
4. YAML keys must match declared output names