flashnode 0.2.0__tar.gz

flashnode-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

flashnode-0.2.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: flashnode
+Version: 0.2.0
+Summary: Open host agent for the FlashML fragmented-compute network: join, benchmark, execute sandboxed ML tasks, earn contribution credits.
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Zolli-Labs/flashnode
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flashruntime<0.4,>=0.3
+Requires-Dist: psutil>=5.9
+Requires-Dist: websockets>=12
+Requires-Dist: cryptography>=42
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# FlashNode
+
+> **The open host agent of the FlashML system.** Install FlashNode on a
+> machine you own, and it can safely execute distributed ML tasks for the
+> FlashML network — earning contribution credits for verified useful work.
+
+FlashNode is one of three components in the FlashML system by
+[Zolli Labs](https://github.com/Zolli-Labs):
+
+- **flashnode** (this repo) — open host agent installed by resource
+  contributors. Because it runs on someone else's machine and executes
+  third-party workloads, it must be inspectable, minimal, and explicit about
+  permissions — which is why it is open source.
+- **[flashruntime](https://github.com/Zolli-Labs/flashruntime)** — the open
+  workload protocol and execution layer.
+- **flashml-cloud** (private) — the managed control plane and dashboard.
+
+Read [`docs/SYSTEM_OVERVIEW.md`](docs/SYSTEM_OVERVIEW.md) for the full
+product architecture, and [`AGENTS.md`](AGENTS.md) if you are an AI coding
+agent working in this repo.
+
+## Status
+
+**Pre-release; the device executor works today** (July 2026). A machine
+with this agent can join a FlashRuntime coordinator over outbound HTTP,
+pull leased tasks, execute them, relay training checkpoints, and commit
+verified results. Two profiles:
+
+- **Device profile** (`flashnode work`) — the pull-based executor for
+  laptops/workstations. Implemented.
+- **Kubernetes profile** (`flashnode agent`) — per-node telemetry reporter
+  inside managed pools (DaemonSet); KubeRay owns workload pods there.
+  Implemented.
+
+## What it does today
+
+```bash
+pip install -e .                      # plus: pip install -e ../flashruntime
+flashnode work --coordinator http://<coordinator>:8100
+# optional hardening / pool config:
+#   FLASHNODE_JOIN_CODE=...          join-code-gated pools
+#   --runner docker + FLASHNODE_ALLOWED_IMAGES=img:tag,...   container tier
+#   FLASHNODE_WORKDIR=$HOME/.cache/flashnode   (macOS + colima: VM-visible workdirs)
+#   FLASHNODE_WORKDIR=C:\Users\<you>\.flashnode  (Windows: must be under a
+#                                                 directory Docker Desktop shares)
+```
+
+If the coordinator enforces per-machine authentication
+(`FLASHML_NODE_TOKENS` set server-side), save the bearer token you were
+given before running `work`:
+
+```bash
+flashnode login --coordinator http://<coordinator>:8100 --token <token>
+flashnode work --coordinator http://<coordinator>:8100   # reads the saved token automatically
+flashnode logout --coordinator http://<coordinator>:8100 # forget it locally (does not revoke server-side)
+```
+
+`login`/`logout` write to a per-coordinator credential store at
+`~/.flashnode/credentials.json` (override with `FLASHNODE_CREDENTIALS`),
+keyed by coordinator URL so one machine can hold separate tokens for
+separate pools. The file is written with mode `0600` on every save. A
+missing or unparseable file is treated as "no saved token" rather than a
+crash. `CoordinatorClient` sends the saved token as a bearer header on
+every request to that coordinator once it's saved — there is nothing else
+to configure. Token issuance is still manual and out-of-band today (the
+coordinator operator hands you the token; there is no self-service signup
+or browser device flow yet), and `flashnode logout` only removes the local
+copy — the operator revokes access by removing your token from the
+coordinator's configuration.
+
+- Stable node identity; registers with capabilities (CPU, RAM, arch, GPU)
+  and **re-registers automatically** if the coordinator restarts.
+- **Outbound-only** HTTP — no inbound ports, no router configuration.
+- Claims task leases, renews them with attempt heartbeats, and stops work
+  the moment a lease is refused (the coordinator's idempotent commit
+  rejects late duplicates regardless — defense in depth).
+- Two execution tiers behind one interface: `SubprocessRunner`
+  (allowlisted Python modules, wall-clock timeout, **scrubbed
+  environment** — agent secrets never reach task code) and `DockerRunner`
+  (allowlisted images, `--network none`, cpu/memory limits, read-only
+  rootfs, uid mapping).
+- Downloads shared input artifacts; uploads outputs with sha256 for the
+  coordinator's commit-time validation.
+- **Checkpoint courier**: tasks stay network-isolated, so the agent
+  fetches the task's latest valid checkpoint before a run (resume) and
+  ships each new checkpoint file during it — a task killed on this
+  machine resumes from its checkpoint on another.
+
+Still to come: Ed25519-signed identity, admission benchmarks (`benchmark/`),
+richer telemetry (`telemetry/`), gVisor/Kata isolation tiers, and the
+`join`/`status`/`leave` UX.
+
+## Security contract
+
+- Outbound-only control connection; no inbound SSH or public ports.
+- Signed node identity; short-lived session credentials.
+- Allowlisted or signed workload images only.
+- Non-root execution; no host Docker socket, device passthrough, or
+  privileged mode.
+- The agent shows exactly which limits and permissions apply to a workload
+  before executing it.
+- Complete event logging of task assignment, image digest, permissions, and
+  artifact commits.
+
+Supported host class (initial): x86-64 Linux, macOS (Docker Desktop or
+Colima), or Windows (Docker Desktop with the **WSL2 backend**), Python
+3.10+, ≥4 CPU cores, ≥8 GB RAM, stable outbound internet.
+
+**Windows note:** `flashnode work` used to crash immediately on Windows
+(`os.getuid`/`os.getgid` don't exist there). It now omits `--user` on
+Windows instead, relying on the curated images' own non-root `USER`
+declaration for non-root execution — see
+[`docs/guides/donate-a-machine.md`](https://github.com/Zolli-Labs/flashruntime/blob/main/docs/guides/donate-a-machine.md#platform-support)
+in flashruntime for the full picture, including honest caveats: **Windows
+support is constructed-argv-verified (tests fake the platform), not yet
+execution-verified against a real Windows machine.**
+
+## Package layout
+
+Working today:
+
+```
+flashnode/
+├── agent/       # CLI (`work`, `agent`), K8s-profile daemon, kube helper
+├── identity/    # stable node ID (Ed25519 signing: planned); credentials.py
+│                #   is the per-coordinator bearer-token store behind
+│                #   `flashnode login`/`logout`
+├── inventory/   # capability discovery (psutil + K8s allocatable)
+└── executor/    # the device work cycle:
+    ├── client.py         # stdlib outbound HTTP: leases, artifacts, checkpoints
+    ├── runner.py         # Tier 1: allowlisted subprocess, scrubbed env
+    ├── docker_runner.py  # Tier 2: allowlisted containers, network-none
+    └── loop.py           # claim → run (heartbeating) → relay ckpts → commit
+```
+
+Scaffolds awaiting their vertical slice: `benchmark/` (admission probes),
+`telemetry/` (rich metrics), `artifacts/` (local caching), `config/`
+(host-owner policy).
+
+## License
+
+[Apache-2.0](LICENSE). Contributions via Developer Certificate of Origin
+(`git commit -s`).

flashnode-0.2.0/README.md

@@ -0,0 +1,143 @@
+# FlashNode
+
+> **The open host agent of the FlashML system.** Install FlashNode on a
+> machine you own, and it can safely execute distributed ML tasks for the
+> FlashML network — earning contribution credits for verified useful work.
+
+FlashNode is one of three components in the FlashML system by
+[Zolli Labs](https://github.com/Zolli-Labs):
+
+- **flashnode** (this repo) — open host agent installed by resource
+  contributors. Because it runs on someone else's machine and executes
+  third-party workloads, it must be inspectable, minimal, and explicit about
+  permissions — which is why it is open source.
+- **[flashruntime](https://github.com/Zolli-Labs/flashruntime)** — the open
+  workload protocol and execution layer.
+- **flashml-cloud** (private) — the managed control plane and dashboard.
+
+Read [`docs/SYSTEM_OVERVIEW.md`](docs/SYSTEM_OVERVIEW.md) for the full
+product architecture, and [`AGENTS.md`](AGENTS.md) if you are an AI coding
+agent working in this repo.
+
+## Status
+
+**Pre-release; the device executor works today** (July 2026). A machine
+with this agent can join a FlashRuntime coordinator over outbound HTTP,
+pull leased tasks, execute them, relay training checkpoints, and commit
+verified results. Two profiles:
+
+- **Device profile** (`flashnode work`) — the pull-based executor for
+  laptops/workstations. Implemented.
+- **Kubernetes profile** (`flashnode agent`) — per-node telemetry reporter
+  inside managed pools (DaemonSet); KubeRay owns workload pods there.
+  Implemented.
+
+## What it does today
+
+```bash
+pip install -e .                      # plus: pip install -e ../flashruntime
+flashnode work --coordinator http://<coordinator>:8100
+# optional hardening / pool config:
+#   FLASHNODE_JOIN_CODE=...          join-code-gated pools
+#   --runner docker + FLASHNODE_ALLOWED_IMAGES=img:tag,...   container tier
+#   FLASHNODE_WORKDIR=$HOME/.cache/flashnode   (macOS + colima: VM-visible workdirs)
+#   FLASHNODE_WORKDIR=C:\Users\<you>\.flashnode  (Windows: must be under a
+#                                                 directory Docker Desktop shares)
+```
+
+If the coordinator enforces per-machine authentication
+(`FLASHML_NODE_TOKENS` set server-side), save the bearer token you were
+given before running `work`:
+
+```bash
+flashnode login --coordinator http://<coordinator>:8100 --token <token>
+flashnode work --coordinator http://<coordinator>:8100   # reads the saved token automatically
+flashnode logout --coordinator http://<coordinator>:8100 # forget it locally (does not revoke server-side)
+```
+
+`login`/`logout` write to a per-coordinator credential store at
+`~/.flashnode/credentials.json` (override with `FLASHNODE_CREDENTIALS`),
+keyed by coordinator URL so one machine can hold separate tokens for
+separate pools. The file is written with mode `0600` on every save. A
+missing or unparseable file is treated as "no saved token" rather than a
+crash. `CoordinatorClient` sends the saved token as a bearer header on
+every request to that coordinator once it's saved — there is nothing else
+to configure. Token issuance is still manual and out-of-band today (the
+coordinator operator hands you the token; there is no self-service signup
+or browser device flow yet), and `flashnode logout` only removes the local
+copy — the operator revokes access by removing your token from the
+coordinator's configuration.
+
+- Stable node identity; registers with capabilities (CPU, RAM, arch, GPU)
+  and **re-registers automatically** if the coordinator restarts.
+- **Outbound-only** HTTP — no inbound ports, no router configuration.
+- Claims task leases, renews them with attempt heartbeats, and stops work
+  the moment a lease is refused (the coordinator's idempotent commit
+  rejects late duplicates regardless — defense in depth).
+- Two execution tiers behind one interface: `SubprocessRunner`
+  (allowlisted Python modules, wall-clock timeout, **scrubbed
+  environment** — agent secrets never reach task code) and `DockerRunner`
+  (allowlisted images, `--network none`, cpu/memory limits, read-only
+  rootfs, uid mapping).
+- Downloads shared input artifacts; uploads outputs with sha256 for the
+  coordinator's commit-time validation.
+- **Checkpoint courier**: tasks stay network-isolated, so the agent
+  fetches the task's latest valid checkpoint before a run (resume) and
+  ships each new checkpoint file during it — a task killed on this
+  machine resumes from its checkpoint on another.
+
+Still to come: Ed25519-signed identity, admission benchmarks (`benchmark/`),
+richer telemetry (`telemetry/`), gVisor/Kata isolation tiers, and the
+`join`/`status`/`leave` UX.
+
+## Security contract
+
+- Outbound-only control connection; no inbound SSH or public ports.
+- Signed node identity; short-lived session credentials.
+- Allowlisted or signed workload images only.
+- Non-root execution; no host Docker socket, device passthrough, or
+  privileged mode.
+- The agent shows exactly which limits and permissions apply to a workload
+  before executing it.
+- Complete event logging of task assignment, image digest, permissions, and
+  artifact commits.
+
+Supported host class (initial): x86-64 Linux, macOS (Docker Desktop or
+Colima), or Windows (Docker Desktop with the **WSL2 backend**), Python
+3.10+, ≥4 CPU cores, ≥8 GB RAM, stable outbound internet.
+
+**Windows note:** `flashnode work` used to crash immediately on Windows
+(`os.getuid`/`os.getgid` don't exist there). It now omits `--user` on
+Windows instead, relying on the curated images' own non-root `USER`
+declaration for non-root execution — see
+[`docs/guides/donate-a-machine.md`](https://github.com/Zolli-Labs/flashruntime/blob/main/docs/guides/donate-a-machine.md#platform-support)
+in flashruntime for the full picture, including honest caveats: **Windows
+support is constructed-argv-verified (tests fake the platform), not yet
+execution-verified against a real Windows machine.**
+
+## Package layout
+
+Working today:
+
+```
+flashnode/
+├── agent/       # CLI (`work`, `agent`), K8s-profile daemon, kube helper
+├── identity/    # stable node ID (Ed25519 signing: planned); credentials.py
+│                #   is the per-coordinator bearer-token store behind
+│                #   `flashnode login`/`logout`
+├── inventory/   # capability discovery (psutil + K8s allocatable)
+└── executor/    # the device work cycle:
+    ├── client.py         # stdlib outbound HTTP: leases, artifacts, checkpoints
+    ├── runner.py         # Tier 1: allowlisted subprocess, scrubbed env
+    ├── docker_runner.py  # Tier 2: allowlisted containers, network-none
+    └── loop.py           # claim → run (heartbeating) → relay ckpts → commit
+```
+
+Scaffolds awaiting their vertical slice: `benchmark/` (admission probes),
+`telemetry/` (rich metrics), `artifacts/` (local caching), `config/`
+(host-owner policy).
+
+## License
+
+[Apache-2.0](LICENSE). Contributions via Developer Certificate of Origin
+(`git commit -s`).

flashnode-0.2.0/flashnode/__init__.py

@@ -0,0 +1,7 @@
+"""FlashNode: the open host agent of the FlashML system.
+
+Installed by resource contributors to safely execute distributed ML tasks.
+See README.md and docs/SYSTEM_OVERVIEW.md.
+"""
+
+__version__ = "0.1.0"

flashnode-0.2.0/flashnode/agent/__init__.py

@@ -0,0 +1,6 @@
+"""Control connection and lifecycle.
+
+Maintains the outbound authenticated WebSocket to the control plane (no
+inbound ports required), handles registration, lease acceptance, heartbeat
+renewal, and graceful drain/shutdown.
+"""