stroblmeandClaude Opus 5
d01a8dad37
Follows the portal: the noun is "instance" everywhere the app says it — UI strings, CLI output, error details, docs and comments. The wire keys (`instance_id`, `instance_token`) and the hub route this calls move with it. An existing cloud.json is adopted rather than refused: without the key alias the dataclass fails to parse, which the caller swallows and reads as "never enrolled" instead of "reconnect". `instance_key` on a node type becomes `target_key`. It means the outside thing a node points at, which is a different sense of the word, and keeping both would put two meanings of "instance" in one codebase. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015YrQnKV3bnQd4K342y8tKj
39 lines
2.3 KiB
Plaintext
39 lines
2.3 KiB
Plaintext
# Fluksio
|
|
|
|
> Fluksio is a node-based automation engine. A flow is a graph of small
|
|
> functions wired by message name, kept running by one resident engine. The
|
|
> same engine serves two shapes of work: live flows that never end (buildings,
|
|
> labs, homelabs) and batch runs that finish and leave a record (experiments,
|
|
> ML pipelines, CI-style jobs). Self-hosted by default; an optional portal
|
|
> exists only to reach an instance that has no inbound route.
|
|
|
|
## Getting started
|
|
- [Pick your starting point](/getting-started/): the two setup paths and how to choose
|
|
- [Data science](/getting-started/data-science/): pip install, wrap a training script, runs and sweeps
|
|
- [Facility automation](/getting-started/facility-automation/): Docker stack, MQTT to dashboard, InfluxDB, workers
|
|
|
|
## Concepts
|
|
- [Flows, nodes and messages](/concepts/flows/): the graph comes from message names, not drawn wires
|
|
- [Where a node's values come from](/concepts/values/): ports, settings, flow inputs
|
|
- [Keeping state in a flow](/concepts/state/): a message a node both reads and writes
|
|
- [Runs: pipelines that finish](/concepts/runs/): batch mode, metrics, artifacts, sweeps, durability
|
|
|
|
## The interface
|
|
- [The dashboard app](/interface/): the shell, Home, health and activity
|
|
- [The flow editor](/interface/flow-editor/): canvas, node panel, dock, shortcuts, drafts
|
|
- [Dashboards and panels](/interface/dashboards/): widgets, typed bindings, wall screens
|
|
- [Secrets, modules and alerts](/interface/operations/): credentials, packages, failure routing
|
|
- [Accounts and the portal](/interface/portal/): enrolment, remote users, revoking
|
|
|
|
## Code and the CLI
|
|
- [The fluksio command](/code/cli/): serve, enroll, worker, and the data directory
|
|
- [Writing node code](/code/nodes/): process(), generators, fluksio.emit, artifacts
|
|
- [The HTTP API](/code/api/): auth, flows, messages, runs, observability, websocket
|
|
- [Remote workers](/code/workers/): fluksio-worker, device labels, artifacts across hosts
|
|
- [Agents over MCP](/code/agents/): the tool list and the security model
|
|
|
|
## Reference
|
|
- [Node types](/reference/node-types/): every built-in type and its settings
|
|
- [Payload types](/reference/payload-types/): float, int, str, bool, json, record, list, series, artifact
|
|
- [Configuration](/reference/configuration/): every environment variable
|