Inputs & config

Connectors are never configured by flags or files. Inputs and config arrive on Execute and through environment variables injected by the worker.

Reading inputs in `Execute`

Your adapter receives inputs map[string]any directly as an argument. Read values from it — do not read INPUT_* yourself unless you need the env defaults.

func (a *MyAdapter) Execute(ctx context.Context, inputs map[string]any, out chan<- connector.Finding) error {
    target, _ := inputs["target"].(string)
    // ...
}

The `INPUT_*` defaults

env.LoadInputs() reads every INPUT_* environment variable and returns them as a map. Keys are lowercased with the prefix stripped.

Env var	Becomes
`INPUT_TARGET`	`inputs["target"]`
`INPUT_SOME_KEY`	`inputs["some_key"]`

import "github.com/oasm-platform/oasm-connectors/sdk/env"

defaults := env.LoadInputs()

Precedence: per-job inputs provided by the worker override INPUT_* environment defaults. The inputs map your adapter receives already has both merged, with the worker winning.

The runtime merges the two sources before calling your adapter, so you rarely need env.LoadInputs() in production code. It is useful when running the connector manually outside a worker.

The config profile (`OASM_CONFIG`)

configSchema values are delivered as a JSON string in the OASM_CONFIG environment variable. Read it at execution time, not at startup.

A container reused for a second job gets its OASM_CONFIG replaced around each execution. Reading it in main or a package-level init gives you stale config — always read it inside Execute.

type Config struct {
    Severity []string `json:"severity"`
    RateLimit *int    `json:"rateLimit"`
}

func parseConfig(raw string) (Config, error) {
    if strings.TrimSpace(raw) == "" {
        return Config{}, nil
    }
    var cfg Config
    if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
        return Config{}, err
    }
    return cfg, nil
}

func (a *MyAdapter) Execute(ctx context.Context, inputs map[string]any, out chan<- connector.Finding) error {
    cfg, err := parseConfig(os.Getenv("OASM_CONFIG"))
    if err != nil {
        return fmt.Errorf("fatal: invalid OASM_CONFIG: %w", err)
    }
    _ = cfg
    // ...
}

Use pointers for optional numeric or boolean fields so you can tell “absent” from a zero value, and fall back to the manifest’s default when a field is nil.

Environment variables

Variable	Purpose
`INPUT_*`	Per-run input defaults. `INPUT_TARGET` → `inputs["target"]`.
`OASM_CONFIG`	The job’s config profile as JSON. Read at execution time.
`LOG_LEVEL` / `OASM_LOG_LEVEL`	Set to `debug` for verbose traces (per-result lines, emitted-finding previews). INFO and above are always on.
`OASM_LOG_COLOR`	`always` forces ANSI colour, `never` strips it. Unset means colour only on a terminal.

Connection variables (WORKER_GRPC_ADDR, WORKER_TOKEN, mTLS paths) are injected by the worker and consumed entirely by the SDK. Your adapter never reads or sets them.

manifest.yaml

Declare inputsSchema and configSchema.

Adapter

Where inputs and config are consumed.

Get started

Reference

Build & ship

Inputs & config

Reading inputs in `Execute`

The `INPUT_*` defaults

The config profile (`OASM_CONFIG`)

Environment variables

manifest.yaml

Adapter

​Reading inputs in Execute

​The INPUT_* defaults

​The config profile (OASM_CONFIG)

​Environment variables

​Related

manifest.yaml

Adapter

Reading inputs in `Execute`

The `INPUT_*` defaults

The config profile (`OASM_CONFIG`)

Environment variables

Related