k1s-core 1.0.0a3__tar.gz

k1s_core-1.0.0a3/LICENSE

@@ -0,0 +1,201 @@
+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 2026 k1s contributors
+
+   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.

k1s_core-1.0.0a3/PKG-INFO

@@ -0,0 +1,465 @@
+Metadata-Version: 2.4
+Name: k1s-core
+Version: 1.0.0a3
+Summary: Core Python runtime and compatibility CLIs for k1s
+Author: k1s contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/the-cm-collective/k1s
+Project-URL: Repository, https://github.com/the-cm-collective/k1s
+Project-URL: Documentation, https://github.com/the-cm-collective/k1s/tree/main/docs
+Project-URL: Issues, https://github.com/the-cm-collective/k1s/issues
+Project-URL: Changelog, https://github.com/the-cm-collective/k1s/blob/main/CHANGELOG.md
+Keywords: containers,distributed-systems,orchestration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.9
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: docker>=7.1
+Requires-Dist: requests>=2.32
+Requires-Dist: psycopg[binary]>=3.1
+Requires-Dist: croniter>=2.0
+Requires-Dist: grpcio>=1.60
+Requires-Dist: protobuf>=4.25
+Requires-Dist: nats-py>=2.7
+Requires-Dist: nkeys>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: matplotlib>=3.9; extra == "dev"
+Requires-Dist: Pillow>=10.4; extra == "dev"
+Requires-Dist: pre-commit>=3.8; extra == "dev"
+Requires-Dist: jsonschema>=4.22; extra == "dev"
+Requires-Dist: huggingface_hub>=0.30; extra == "dev"
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0; extra == "watch"
+Dynamic: license-file
+
+<p align="center">
+  <img src="media/style/web-logos/k1s-killa-bee-refresh-0526.png" alt="k1s logo" width="260" />
+</p>
+
+# k1s Minimal Application Engine
+
+k1s is a small, readable, Kubernetes-like orchestration engine built for distributed compute across messy reality: NAT/CGNAT, roaming nodes, intermittent links, heterogeneous sites, and federated clouds.
+
+The goal is to make private, self-hosted, federated compute feasible without surrendering control to a single vendor or central authority. k1s is privacy-first, consent-first, and secure-by-default while staying understandable end-to-end (`spec -> reconcile -> runtime -> networking`).
+
+k1s borrows Kubernetes mental models and API shapes where useful, but it is not a full Kubernetes clone. The focus is a compact surface area with a lightweight control plane and lower resource requirements.
+
+Project principles and non-goals: `TENETS.md`. Cognitive-substrate philosophy and safeguards: `docs/design/project-philosophy.md`, `docs/design/cognitive-welfare-and-continuity.md`.
+
+## Status & Production Use
+
+k1s is entering its 1.0 alpha line and remains actively evolving. The current
+candidate establishes a tested compatibility boundary for the distribution,
+imports, commands, and core installed contracts while runtime and fabric
+surfaces continue through explicit qualification gates.
+
+Production guidance:
+- Recommended now: labs, staging, and controlled production pilots with explicit operator ownership.
+- Not yet recommended: broad multi-tenant or compliance-critical environments that require full Kubernetes semantics.
+- Always run environment-specific security review, failure drills, and rollout validation before promotion.
+
+## Current Release-Line Highlights
+
+- High-availability control-plane support across controller authority, shared mutation fencing/CAS, and HA-safe API-shim reads: `docs/roadmap/high-availability-control-plane.md`, `docs/ops/ha-cluster-bring-up.md`
+- HA operator tooling and validation automation for retained, live-helper, and drill lanes: `docs/ops/validated-procedures.md`, `docs/ops/ha-closeout.md`
+- Hardened benchmark reruns and retained publishing for rootless, rootful, k1nd, k3d, and CRI lanes: `docs/benchmarks/memory.md`, `docs/ops/validated-procedures.md`
+- Stronger local environment/bootstrap helpers, including `env-doctor`, controller env export helpers, and repo-local Nix shells: `scripts/dev/env_doctor.sh`, `scripts/ae-env.sh`, `flake.nix`
+
+## Documentation
+
+- Start here onboarding: `docs/getting-started/start-here.md`
+- High-level overview and getting started: `docs/getting-started/overview.md`
+- Technical architecture and reference: `docs/reference/architecture.md`
+- Project philosophy and cognitive safeguards: `docs/design/project-philosophy.md`, `docs/design/cognitive-welfare-and-continuity.md`
+- Current inference-fabric behavior: `docs/reference/inference-fabric.md`
+- Distributed compute fabric roadmap: `docs/roadmap/distributed-compute-fabric.md`, `docs/roadmap/status.md`
+- Fabric deployment and control-plane design: `docs/design/fabric-deployment-topology.md`, `docs/design/fabric-control-plane.md`
+- Multi-node architecture and lab: `docs/adr/0007-multinode-architecture-scope.md`, `docs/guides/multinode-lab.md`
+- Runtime profile targets (including strict CRI aliases): `docs/guides/runtime-profiles.md`
+- CRI/containerd workflows and registry-first image prep: `docs/reference/cri-containerd.md`
+- API compatibility and shim status: `docs/reference/apishim-compatibility-matrix.md`, `docs/reference/apishim-roadmap.md`
+- HTTP API reference and UI docs: `docs/reference/http-api.md`
+- Configs & Secrets: `docs/reference/configs-secrets.md`
+- Ingress and TLS reference: `docs/reference/ingress.md`
+- Ingress deep validation lanes: `docs/guides/ingress-capability-test-sequence.md`
+- Operations runbook: `docs/ops/runbook.md`
+- Benchmarks and validated procedures: `docs/benchmarks/memory.md`, `docs/ops/validated-procedures.md`
+- Demo modes and examples: `docs/guides/demos-examples.md`
+- End-to-end walkthrough: `docs/guides/e2e.md`
+- CI examples: `docs/ops/ci-gh-actions.md`
+- Python distribution identity and release compatibility:
+  `docs/reference/python-distribution.md`
+- Stable and experimental public contracts: `docs/reference/public-contracts.md`
+- Experimental metadata-safe WorkerBee profile evidence contract:
+  `docs/reference/workerbee-profile-adapter.md`
+
+## Integrated Dashboard & Interactive Playground
+
+Dashboard:
+![Dashboard](media/docs.home.arpa_8443_dashboard.png)
+
+Playground:
+![Playground](media/docs.home.arpa_8443_playground.html.png)
+
+## Quickstart
+
+1) Install (editable for dev):
+
+```
+python -m pip install -e .[dev]
+```
+
+Published Python artifacts use the distribution name `k1s-core`. The runtime
+package remains importable as `ae`, and the `k1s` and historical `ae*` command
+entry points remain available. See `docs/reference/python-distribution.md` and
+`docs/reference/public-contracts.md` for the 1.0-alpha compatibility policy.
+
+Optional: add file-watching support for instant reconciles on spec changes:
+
+```
+python -m pip install -e .[watch]
+```
+
+Optional NixOS/dev-shell path (additive; Debian/Ubuntu flow above is unchanged):
+
+```
+direnv allow
+# or:
+nix develop
+
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -e .[dev]
+make env-doctor
+```
+
+Use `nix develop .#cri` when you want the CRI/containerd-oriented shell. The flake
+fills in userland tooling such as `podman-compose`. Host runtimes still remain
+host-managed (`podman`/`docker`, `containerd`), but `make dev-local` can now
+manage local demo DNS/TLS state directly on Debian/RHEL and through the NixOS
+bridge helper on NixOS. Run `make env-doctor` to check whether the bridge is
+installed/imported and whether `docs/api/dash/blue/green.home.arpa` resolve
+where the demo expects.
+
+One-time NixOS bridge bootstrap:
+
+```bash
+sudo install -D -m 0644 ops/nixos/k1s-local-dev-bridge.nix /etc/nixos/nixos/modules/k1s-local-dev-bridge.nix
+# import ./nixos/modules/k1s-local-dev-bridge.nix from your host config
+sudo nixos-rebuild switch --impure --flake /etc/nixos#$(hostname -s)
+```
+
+2) Run dev fixtures (optional):
+
+```
+docker compose -f ops/dev/docker-compose.yaml up -d
+```
+
+Podman registry cache note (demo helpers): if you use Podman with the local pull‑through cache, add an insecure registry entry for `localhost:5001`/`localhost:5002` (or set `AE_USE_REGISTRY_CACHE=0`) to avoid HTTPS pull errors and Docker Hub rate‑limit stalls.
+
+3) Start the controller loop:
+
+```
+python -m ae.controller --loop --specs specs/ --metrics-port 9108 --watch
+```
+
+Strict CRI quickstart (recommended for containerd lanes):
+
+```
+make k1s-core-cri
+# optional pairings:
+make k1s-edge-cri
+make k1s-edge-core-cri
+```
+
+4) Apply a sample app and inspect:
+
+```
+python -m ae.cli apply -f specs/examples/echo.yaml
+python -m ae.cli status echo --wide --events
+python -m ae.cli logs echo --tail 50
+python -m ae.cli shell echo
+python -m ae.cli exec echo -- -- sh -c 'echo hello from main'
+```
+
+Namespace targeting:
+```
+ae apply -n demo -f specs/examples/echo.yaml
+ae apply -n demo --force-namespace -f specs/examples/echo.yaml
+AE_NAMESPACE=demo ae status echo
+ae shell demo/echo
+```
+Note: `ae shell` defaults to `sh`; use `-- bash` only when the image includes it.
+
+Kubectl-like aliases via `k1s`:
+
+```
+k1s get apps
+k1s describe app/echo
+k1s logs app/echo --follow --tail 100
+```
+
+Installed profile inspection is deterministic and non-mutating. It lists the
+public role catalog, checks static installation facts, and produces a
+declarative plan without starting a runtime or preparing the host.
+
+```
+k1s profile list
+k1s profile doctor core
+k1s profile plan edge-gateway --output json
+```
+
+The production `edge-gateway` role never includes the development worker stub.
+Legacy `edge` and `edge-core` aliases remain development-only. Existing
+`profile start|status|stop|restart` actions retain their checkout-local
+compatibility behavior pending later stateful lifecycle work. See
+`docs/reference/profile-lifecycle.md` for the exact role, alias, schema, and
+exit-code contracts.
+
+The installed `k1s-core` package also contains a versioned, metadata-safe
+WorkerBee profile evidence adapter. It projects already selected JSON results;
+it adds no command, starts nothing, emits no raw log or connection value, and
+remains `source-validated/unqualified`. Exact WorkerBee rebind and combined
+disposable-guest qualification remain required before RC promotion. See
+`docs/reference/workerbee-profile-adapter.md`.
+
+API endpoints (when started with `--metrics-port`): see `docs/reference/http-api.md`.
+
+Multi-container tips:
+- Add sidecars under `spec.containers` and init containers under `spec.initContainers`.
+- Use `ae logs <app> --container <name>` and `ae exec <app> --container <name> -- <cmd>` to target a specific container.
+- Config/Secret file projections are mounted at `/var/run/ae/config/<app>`; sidecars can add custom `projectionMounts` to bind specific subpaths to custom mount points.
+- Namespace targeting: add `-n <ns>`/`--namespace` or use `ns/app` (or `ns--app`) when apps live outside `default`.
+
+Multi-node lab (controller + agents + overlay Service VIPs):
+- Controller: `AE_ENABLE_SERVICE_PROXY=1 AE_SERVICE_PROVIDER=overlay AE_AGENT_API_TOKEN=changeme python -m ae.controller --loop --specs specs/ --metrics-port 9108`
+- Worker agent on another host: `AE_CONTROLLER_URL=http://<controller>:9110 AE_AGENT_TOKEN=$AE_AGENT_API_TOKEN python -m ae.node --runtime-backend podman --port 9109 --ensure-pod-net`
+- Apply the multi-node sample: `python -m ae.cli apply -f specs/examples/echo-multinode.yaml`
+- Inspect nodes/placement: `ae nodes list`, `ae status echo-mn --wide --events`
+- Full walkthrough: `docs/guides/multinode-lab.md`
+
+Kubernetes API shim (kubectl/helm):
+- Start shim (Postgres or SQLite): `AE_APISHIM_TOKEN=devtoken python -m ae.apishim serve --host 127.0.0.1 --port 8445`
+- Point kubectl: `kubectl --server=http://127.0.0.1:8445 --token $AE_APISHIM_TOKEN get pods`
+- Port-forward and apply work for Deployments/Services/Ingress/HPA/StatefulSet/DaemonSet/Job/CronJob.
+- Compatibility matrix and open gaps: `docs/reference/apishim-compatibility-matrix.md`, `docs/reference/apishim-roadmap.md`.
+
+Inference fabric (experimental):
+- Apply a cell manifest: `ae cell apply -f specs/examples/inference/cell-bc-pp2-ray.yaml`
+- Inspect cell state: `ae cell status cell-bc-pp2-ray --json`
+- Inspect fabric sessions: `ae fabric sessions --json`
+- Current behavior and limits: `docs/reference/inference-fabric.md`
+- Hardware baseline and cluster prep: `docs/reference/ai-max-395-hardware-baseline.md`, `docs/ops/ai-max-395-cluster-prep.md`
+- Formal design and roadmap: `docs/design/fabric-deployment-topology.md`, `docs/design/fabric-control-plane.md`, `docs/roadmap/distributed-compute-fabric.md`
+- Formal target shape: AI Max+ 395-first execution cells behind a provider-facing HA edge, with an exact public node baseline today and Hyperon entering later as an advisory planning layer
+
+## Kubernetes Alignment Matrix (Operator View)
+
+Legend: Green = aligned/supported; Yellow = partial/best-effort; Red = out-of-scope; N/A = not applicable.
+
+Columns: Runtime = k1s engine behavior; Shim = Kubernetes API shim (kubectl/helm); Export = `ae export-k8s` YAML.
+
+Matrix source: `docs/site/k8s_status.json`.
+
+| Area | Capability | Runtime | Shim | Export | Operator notes |
+| --- | --- | --- | --- | --- | --- |
+| API & tooling | kubectl get/apply/watch | N/A | Green | N/A | CI smoke gates cover apply/watch and OpenAPI drift. |
+| API & tooling | SSA + JSON Merge Patch | N/A | Green | N/A | `managedFields` + conflict detection supported. |
+| API & tooling | OpenAPI v2/v3 | N/A | Green | N/A | v3 mirrors v2; schemas validated in CI. |
+| Workloads | Deployment/ReplicaSet/Pod semantics | Green | Green | Green | status/conditions + logs/exec/port-forward. |
+| Workloads | StatefulSet/DaemonSet/Job/CronJob semantics | Yellow | Yellow | Green | stored + best-effort status; emulated as Deployment-like apps. |
+| Workloads | HPA v2 | Green | Green | Green | backed by k1s autoscaling with status/currentMetrics. |
+| Networking | Service (ClusterIP/NodePort/LB status) | Green | Green | Green | VIP/overlay-aware; EndpointSlice projection. |
+| Networking | Ingress v1 (basic) | Green | Green | Green | no regex/canary/advanced annotations. |
+| Networking | NetworkPolicy enforcement | Red | Red | Yellow | export emits NP; enforcement depends on CNI (k3s default flannel doesn't enforce). |
+| Security/Auth | Tokens + RBAC | N/A | Green | Green | RBAC enforced in shim; export emits Role/RoleBinding presets. |
+| Security/Auth | ServiceAccount tokens | N/A | Green | Green | shim issues SA tokens; exporter emits SA + bindings. |
+| Security/Auth | PodSecurity admission/webhooks | Red | Red | Yellow | exporter can emit PSA namespace labels only. |
+| Storage | PV/PVC/StorageClass/CSI semantics | Red | Red | Yellow | exporter can emit PVCs/volumeClaimTemplates only. |
+| Observability | Logs/exec/port-forward | Green | Green | N/A | pod + service port-forward supported in shim. |
+| Observability | Events API | Green | Green | N/A | controller/agent events surfaced to `/api/v1/events`. |
+| Observability | metrics.k8s.io / aggregated APIs | Red | Red | N/A | out-of-scope. |
+| Scheduling | nodeSelector/taints/tolerations/topology spread | Green | Green | Green | honored by scheduler; passed through on export. |
+| Nodes | Inventory/cordon/drain | Green | Yellow | N/A | `ae nodes` supports cordon/drain; shim projects Nodes but no kubelet. |
+| Operator workflow | Helm install/upgrade/uninstall (stateless charts) | N/A | Yellow | N/A | good for Deploy/Service/Ingress + RBAC/HPA/PDB; operators/controllers out-of-scope. |
+| Operator workflow | Rollout control (pause/resume/canary ramp) | Green | N/A | N/A | k1s-native rollout policy with canary weights. |
+
+### k1s-specific operator features (not part of upstream Kubernetes; not available in k3s by default)
+
+- `ae k8s-check` portability checks and `ae k8s-report` compliance JSON embedded in docs.
+- `ae export-k8s` presets (`web-hardened`, `web-strict`) + strict validation for portable YAML.
+- Caddy site-fragment ingress with `ae tls` helpers for k8s-style TLS secrets.
+- `ae plan` placement hints and `ae nodes` inventory/cordon/drain workflows.
+- Rollout policy with canary weights + auto-ramp persisted in state.
+- Built-in `/dashboard`, `/nodes`, and enriched `/metrics` endpoints.
+
+### Quick token generation with expiration
+- Generate API tokens that expire in 24 hours and write them to a file of exports you can `source`:
+  - `python -m ae.cli api tokens --generate --ttl-hours 24 -o .env.api`
+
+## Makefile Helper Commands
+
+Run with `make <target>`. You can override defaults via `VAR=value make <target>`.
+
+Setup and quality:
+- `make install`: install dev dependencies (`pip -e .[dev]`).
+- `make watch`: install file-watching extras (`pip -e .[watch]`).
+- `make test`: run unit tests (`pytest -q`).
+- `make lint`: run `ruff check` + `mypy src/ae`.
+- `make env-doctor`: report shell-provided tools, compose availability, host sockets/services, and local DNS/TLS bridge status.
+- `make dev-local-clean`: remove helper-managed local DNS/TLS state.
+- `make wheel`: build a wheel into `dist/`.
+
+Local dev and samples:
+- `make dev-up` / `make dev-down`: start/stop dev Docker Compose stack.
+- `make down`: stop all dev/demo stacks (best-effort).
+- `make loop`: controller reconcile loop (watch mode).
+- `make run`: single reconcile pass.
+- `make dev-min` / `make dev-etcd` / `make k1s-core` / `make k1s-edge`: runtime profiles with empty specs.
+- `make k1s-core-cri` / `make k1s-edge-cri` / `make k1s-core-edge-cri` / `make k1s-edge-core-cri`: strict CRI profile aliases.
+- `make edge-site-cri SITE_ID=<site> EDGE_PORT=<port> EDGE_HTTP_PORT=<port>`: strict CRI multi-site edge helper.
+- `make apply-sample`: apply `specs/examples/echo.yaml`.
+- `make status-sample`: status for `echo`.
+- `make logs-sample`: logs for `echo`.
+- `make k8s-smoke`: export + validate sample Kubernetes YAML (no cluster required).
+- `make start-here`: build docs and open `docs/site/start-here.html`.
+- `make haproxy-update`: regenerate HAProxy config from controller API.
+- `make haproxy-watch`: watch/reload HAProxy config from controller API.
+- `make install-systemd` / `make uninstall-systemd`: install/remove systemd units.
+- `make install-docs-service` / `make uninstall-docs-service`: install/remove docs service.
+- `make secrets-seal-demo`: run the sealed-secret demo helper.
+
+Docs, labs, and playground:
+- `make docs`: combine snapshots (if present), regenerate charts, build docs.
+- `make docs-export`: build non-interactive HTML into `docs/export` (`DOCS_OUT_DIR=` override).
+- `make docs-wiki-export`: export wiki-friendly Markdown into `docs/wiki` (`WIKI_OUT=` override).
+- `make docs-watch`: rebuild docs when `combined/combined.csv` changes.
+- `make docs-local-ignore`: locally hide `docs/site` changes from git status.
+- `make docs-local-track`: re-enable tracking for `docs/site` updates before committing.
+- `make labs-up` / `make labs-down`: dev labs stack (docs + controller via compose).
+- `make labs-aio-up` / `make labs-aio-down`: all-in-one labs stack.
+- `make labs-k3d-up` / `make labs-k3d-down`: bring up/down local k3d cluster for labs.
+- `make labs-apishim-env`: print apishim tokens from `state/profiles/dev-etcd/apishim.env`.
+- `make apishim-smoke`: quick API shim health check on port 8445.
+- `make shim-helm-demo`: run the helm shim demo helper.
+
+Demo workflows:
+- `make demo`: run the playground labs demo (`--labs --labs-token`; podman backend, plaintext secrets allowed).
+- `make demo-help`: show demo script help.
+- `make demo-down`: tear down demo stacks.
+- `make reg-cache-reset`: clear local registry cache used by demos.
+- `make demo-hardened`: run hardened demo flow.
+- `make demo-reset`: reset demo/labs state and prune volumes.
+- `make dashboard-reload`: reload controller under the dashboard supervisor.
+- `make dashboard-restart`: restart the supervisor and reload.
+
+Integration and e2e:
+- `make integ-test`: integration tests (`pytest -q tests/integration/`).
+- `make e2e` / `make e2e-multiport`: run the multiport e2e script.
+
+Benchmarks (memory + runtime tooling):
+- `make bench-mem-k1s`: snapshot k1s memory.
+- `make bench-mem-k3s`: snapshot k3s memory.
+- `make bench-mem-debug`: quick debug benchmark pass.
+- `make bench-mem-agg`: aggregate latest snapshot under a label.
+- `make bench-mem-matrix-k1s`: run k1s replica matrix snapshots.
+- `make bench-mem-combine`: combine snapshots into `combined/*`.
+- `make bench-mem-verify`: verify a snapshot and print per-container split.
+- `make bench-k3s-up` / `make bench-k3s-down`: manage a k3s bench cluster.
+- `make bench-mem-matrix-k3s`: run k3s replica matrix snapshots.
+- `make bench-mem-rollout-k1s`: run k1s rollout snapshots.
+- `make bench-mem-rollout-k3s`: run k3s rollout snapshots.
+- `make bench-mem-plot`: render benchmark charts.
+- `make bench-mem-e2e-k3s-sudo`: full k3s e2e (matrix + rollout + charts) with sudo.
+- `make bench-mem-e2e-k1s`: full k1s e2e (matrix + rollout + charts).
+- `make bench-mem-e2e-k1s-sudo`: k1s e2e with sudo snapshots.
+- `make bench-mem-e2e-k1nd`: k1nd (k1s-in-Docker) e2e.
+- `make bench-mem-e2e-k1nd-sudo`: k1nd e2e with sudo snapshots.
+- `make bench-mem-e2e-k1nd-quick`: fast k1nd profile.
+- `make bench-mem-e2e-k1nd-resume-rollout`: resume only the rollout phase.
+- `make bench-mem-e2e-k1nd-down`: k1nd e2e then tear down compose.
+- `make bench-mem-e2e-all`: run all baseline suites.
+- `make bench-mem-e2e-minimal`: minimal baseline suite.
+- `make bench-watch-runtime`: live runtime debug snapshotter.
+- `make bench-mem-e2e-baselines`: run baseline suite matrix.
+- `make bench-mem-e2e-baselines-sudo`: baseline suite with sudo.
+- `make bench-mem-docs`: combine + plot + rebuild docs.
+- `make bench-retained-rebuild PROFILE=final STAMP=<fresh-stamp> DELETE_DROPPED=1`: rebuild retained benchmark artifacts from one validated rerun stamp plus the frozen legacy reference.
+- `make bench-fix-perms`: normalize artifact permissions.
+- `make bench-mem-backfill`: backfill missing summary.json + rebuild docs.
+- `make bench-engines-clear`: stop/remove all containers (dangerous).
+- `make bench-state-clean`: remove benchmark-only state (`state/bench-*`).
+- `make dev-state-clean`: wipe full `state/` (requires `CONFIRM=1`).
+- `make bench-mem-backfill-oci`: add OCI runtime metadata and recompute charts.
+- `make bench-mem-backfill-oci-latest`: backfill OCI metadata for latest label only.
+- `make bench-mem-finalize-sudo`: legacy finalize helper for mixed-ownership cleanup; retained publishing should use `bench-retained-rebuild`.
+- `make bench-mem-e2e-k3s`: full k3s e2e (matrix + rollout + charts).
+- `make bench-mem-idle-k1s`: idle baseline snapshot for k1s.
+- `make bench-mem-idle-k3s`: idle baseline snapshot for k3s.
+
+Images and containers:
+- `make image-docker`: build controller image with Dockerfile.
+- `make image-podman`: build controller image with Containerfile.
+- `make push-docker` / `make push-podman`: push controller image.
+- `make docker-build-controller`: build controller image (ops/images/controller.Dockerfile).
+- `make docker-run-controller`: run controller container with specs/state mounts.
+
+## Kubernetes Export Quickstart
+
+- Render the echo example to Kubernetes YAML and validate:
+  - `python -m ae.cli export-k8s -f specs/examples/echo.yaml --namespace demo --ingress-class traefik --validate > k8s.yaml`
+- Include ConfigMap/Secret objects, envFrom, and file projections (mounted at `/var/run/ae/config`):
+  - `python -m ae.cli export-k8s -f specs/examples/envfrom-and-projection.yaml --namespace demo --emit-configs --emit-secrets --validate > k8s.yaml`
+- Harden NetworkPolicy quickly:
+  - `python -m ae.cli export-k8s -f specs/examples/echo.yaml --namespace demo --np-preset web --validate > k8s.yaml`
+  - `python -m ae.cli export-k8s -f specs/examples/echo.yaml --namespace demo --np-preset backend --validate > k8s.yaml`
+- See `docs/reference/k8s-export.md` for supported fields: startupProbe, image pull options, env/envFrom, projected volumes, PDB/HPA, pod-level security, and more.
+
+## Remote CLI (over LAN)
+
+You can point the CLI at a controller running on another machine.
+
+Controller (on the host):
+
+```
+export AE_API_MUTATIONS=1
+export AE_API_READ_TOKEN=readtoken
+export AE_API_SCALER_TOKEN=scaletoken
+export AE_API_ADMIN_TOKEN=admintoken
+python -m ae.controller --loop --specs specs/ --metrics-port 9108 --watch
+```
+
+Client (from another machine):
+
+```
+# Reads
+ae --server http://<controller-ip>:9108 --token readtoken status
+ae --server http://<controller-ip>:9108 --token readtoken events echo --limit 20
+
+# Mutations
+ae --server http://<controller-ip>:9108 --token scaletoken scale echo --replicas 2
+ae --server http://<controller-ip>:9108 --token admintoken delete echo --purge
+```
+
+See `docs/ops/runbook.md` → “Remote CLI over LAN” for details and curl examples.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See `LICENSE` for full terms, including the patent grant and redistribution requirements.