docs.fermihdi.io — configuration.md

/ › hd › 2.0.5 › md › sdk

Download configuration.mdView raw

HD SDK — Configuration

The SDK is a client library, not a service, and it has very little configuration of its own. Almost everything it needs — the proxy or DMS URL, the network interfaces, the dataset schema — is passed explicitly by the application that links it, as constructor arguments or method calls. See Getting started for the full list of what you pass and when.

What the SDK reads from the environment

Exactly two variables, and only to select the network stack:

Variable Effect
FERMIHDI_NETWORK_STACK Names the stack the engine should use. Defaults to posix.
FERMIHDI_FORCE_POSIX 1 or true selects the POSIX stack even where kernel-bypass is available.

The SDK does not read environment variables for anything else — not the proxy URL, not network interfaces, not the dataset schema, not a bootstrap token. If you pass an empty string for a network interface it binds to all interfaces (0.0.0.0) rather than consulting the environment; see Interfaces are yours to supply.

What is not the SDK's concern

A bootstrap token, a DMS registration token, and a client's own certificate material are arguments to register_with_dms() (or, for a token, whatever your application already holds) — the SDK stores what registration returns and uses it for later control-plane calls, but it has no configuration file or schema of its own to hold them in. If your application reads its own configuration from environment variables, a file, or a service like the DMS southbound API, that is your application's design, not something the SDK imposes or participates in.

Where to go next

Download configuration.mdView raw