near-architecture

Releases (10)

• 0.9.1.0 indexed
• 0.9.0.0 unindexed
• 0.8.0.0 unindexed
• 0.7.0.0 unindexed
• 0.6.0.0 unindexed
• 0.5.0.0 unindexed
• 0.4.0.0 unindexed
• 0.3.0.0 unindexed
• 0.2.0.0 unindexed
• 0.1.0.0 unindexed

Definitions (130)

arc.bend

• type NodeRole---- vocabulary ---- UserDevice: a user's own device.
• type PhysicalDevice
• type Vendor
• type Org
• type PersonThe agreement between the organization and its people: who they are (identities in the org's directory domain), what each is granted per scope (actions; none means no access), and budgets.
• type Grant
• type Budget
• type Agreement
• type Host
• type Node
• type ContainerKindWhat a container is.
• type OwnerWhether the project builds and runs it, or uses it as it is.
• type ExposureWho can reach it: its own machine (127.0.0.1), the local network, the overlay, the device it is on, anyone.
• type CapWhat a container provides.
• type Lang
• type Container
• type Part
• type LinkA talks-to edge between two containers or parts, by key.
• type System
• def org---- access ----
• def nodes
• def containers
• def parts
• def links
• def nkey
• def ckey
• def con
• def caps
• def pkey
• def pin
• def pon
• def nkeys
• def ckeys
• def pkeys
• def keysKeys links may name: containers and parts.
• def is_server---- predicates on the vocabulary ----
• def is_outside
• def is_device
• def is_overlay
• def one_if
• def overlay_nodes.go
• def overlay_nodesPrivate access is represented by exactly one Overlay node.
• def is_client
• def is_data_api
• def is_ours
• def is_local
• def is_tailnet
• def is_rust
• def str_eq---- keys, like foreign keys ----
• def has
• def owned_device
• def host_in_inventory
• def node_owned
• def owned_nodes.go
• def owned_nodesEvery server and user device is in the owner's inventory or on its vendor's cloud.
• def pick_str
• def distinct_keysNo key names two things.
• def all_inEvery key in `xs` names something in `ks`.
• def part_ins
• def part_ons
• def container_ons
• def link_ends
• def well_formedThe system is well formed: node keys and container/part keys are unique, every container is on a node, every part in a container, and every link joins two things that exist.
• def part_home---- looking things up ----
• def homeThe container a key belongs to: itself, or the one its part sits in.
• def none
• def pick_c
• def containerThe container with key `k` (an empty one when `k` is unknown; well_formed rules that out).
• def pick_r
• def node_role
• def part_node
• def node_ofThe node a container or part runs on, and its role.
• def role_of
• def container_exposure
• def exposure_of
• def private_ok---- where it runs ---- On a server, everything is reachable only from the server itself or over the overlay.
• def all_private
• def servers_private
• def devices_via_network.goA device reaches a server over the overlay only when the destination is exposed to the tailnet.
• def devices_via_network
• def device_reachesA server container needs overlay exposure exactly when a device-origin link reaches it.
• def exposure_for_reach
• def exposure_follows_reach.go
• def exposure_follows_reach
• def is_cap---- what it is: minimality, every capability provided exactly once ----
• def count_in
• def direct
• def tailnet_hosting.go
• def tailnet_hostingHow many containers host the app at Tailnet exposure.
• def providedHow many containers provide `want`.
• def cons_if---- observability: everything we run reports to the observability provider ----
• def providersKeys of the containers that provide `want`.
• def part_containerThe container a link end belongs to: a part's container, else the key itself.
• def reports_toSome link from container `k` (or one of its parts) reaches one of `obs`.
• def observed.go
• def observedEvery container we build (ours, with source) links to a container providing Observability.
• def tailnet_data_apis.go
• def tailnet_data_apisThe data APIs the overlay reaches: the client's data API.
• def own_data_apis.go
• def own_data_apisThe system's own data APIs: those not on someone else's servers.