Reference on Itara

Glossary

Mon, 01 Jan 0001 00:00:00 +0000

Clear, shared vocabulary matters: if people can talk about the project fluently, the ideas travel. If the words are missing or inconsistent, the point gets lost. This is the reference for that vocabulary.

Agent

See Wiring Agent.

Authentication

Verifying that a caller’s claimed identity (see Identity) is genuine, at the topology layer.

Authentication is connection-level and pluggable: an implementation receives whatever identity signal is available for a connection and either produces a verified identity or rejects the call outright. Used without qualification, this term refers to authenticating a calling node, not an end user or account.

API Documentation

Mon, 01 Jan 0001 00:00:00 +0000

Full class and method documentation is generated directly from source and hosted by each language ecosystem’s own standard tooling — not duplicated here, so it never drifts out of sync with what’s actually published.

Java

itara-core and itara-agent on javadoc.io

Rust

Rust crates are not yet published to crates.io. Once they are, generated documentation will be available automatically at docs.rs under the published crate name.

Wiring Configuration

Mon, 01 Jan 0001 00:00:00 +0000

The wiring configuration is the YAML file that describes the topology of an Itara deployment: which nodes exist, and how they’re connected to one another (or to the outside world).

This document describes the file format itself — the schema, the required and optional fields, and what makes a document valid.

Top-level structure

nodes:
 - id: "gatewayNode"
 component: "gateway"
 - id: "calculatorNode"
 component: "calculator"
 
connections:
 - id: "gateway-to-calculator"
 caller:
 nodeId: "gatewayNode"
 callee:
 nodeId: "calculatorNode"
 transport:
 id: http
 params:
 host: "${CALC_HOST:-localhost}"
 port: "${CALC_PORT:-8081}"
 serializer:
 id: json

Field	Type	Required	Description
`nodes`	list of Node	No (defaults to empty)	Every node in the topology.
`connections`	list of Connection	No (defaults to empty)	Every connection between nodes.

An empty or comment-only file is valid and parses to an empty configuration (no nodes, no connections).

Metadata Format

Mon, 01 Jan 0001 00:00:00 +0000

A .itara file is a small TOML document shipped alongside every build artifact (a component, an API, a transport, a serializer, an observer, etc). It declares what the artifact is — its identity, the versions it was built against, and (depending on its kind) a handful of kind-specific declarations that other tooling and the agent itself use to wire things up safely.

Unlike the wiring configuration, which is one file describing an entire deployment topology, a .itara file describes exactly one artifact.