Reference#

What is the exact key, the exact shape, the exact command. These pages are lookup material; the how-to guides link here for every value they mention.

CLI Reference

Every osprey command, its options, and its exit codes.

CLI Reference
Configuration

Paged by the file you have open: profile.yml, config.yml, the environment variables, and a scenario file.

Configuration
Contracts

The JSON and tool shapes services exchange: health reports, connectors, the Python executor, ARIEL, Channel Finder, the facility graph, and six more.

Contracts
osprey-connectors API

The Python API of the connectors package: the connector contracts, the factory, the errors, and the write-safety records.

osprey-connectors API
Ports

Every host port a deployment publishes, as an offset from deployment.port_base – and which setting wins when two disagree.

Ports