Metadata-Version: 2.4
Name: podbench
Version: 0.4.0
Summary: debugging container for kubernetes pods
Author-email: Giles Knap <gilesknap@gmail.com>
License:                                  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.
        
Project-URL: GitHub, https://github.com/gilesknap/podbench
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12
Dynamic: license-file

[![CI](https://github.com/gilesknap/podbench/actions/workflows/ci.yml/badge.svg)](https://github.com/gilesknap/podbench/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/gilesknap/podbench/branch/main/graph/badge.svg)](https://codecov.io/gh/gilesknap/podbench)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

# podbench

**A development seat — editor, gdb, a Python inner loop — inside a Kubernetes
pod, reached over nothing but your kubeconfig.**

podbench launches a debug container into a running pod (or into a sacrificial
clone of one), tunnels ssh through `kubectl exec`, and hands you the config
stanza that VS Code Remote-SSH needs. There is no port-forward to babysit, no
pod IP to reach, no file sync and no traffic interception: the editor is already
inside the cluster.

```
              laptop
     VS Code · Remote-SSH · kubectl
                 |
                 |  ssh over kubectl exec (API server only)
                 |
  +--------------+--------------------------------------+
  |  pod                                                 |
  |                                                      |
  |  +----------------------+  +----------------------+  |
  |  | app container        |  | podbench             |  |
  |  |                      |  |                      |  |
  |  | workload process     |  | sshd · vscode-server |  |
  |  |   (maybe distroless) |  | gdb · git · uv       |  |
  |  | fs visible at        |  |                      |  |
  |  |   /proc/<pid>/root   |  |                      |  |
  |  +----------------------+  +----------------------+  |
  |                                                      |
  |  shared: PID namespace (via the target)              |
  |          network namespace (always)                  |
  +------------------------------------------------------+
```

Two artefacts: a debug **container image** (`ghcr.io/gilesknap/podbench`) and a
**launcher you never have to install** — `uvx podbench` runs it straight from
PyPI, uses your kubeconfig, and shells out to `kubectl` for everything it does
to a cluster.

| | Observe mode | Iterate mode | Hotfix mode |
|---|---|---|---|
| Command | `uvx podbench attach pod/foo` | `uvx podbench dev pod/foo` | `uvx podbench hotfix init pod/foo` |
| What it does | adds an ephemeral container to the **live** pod | authors a **sacrificial clone** with the app idled and podbench as a real sidecar | puts the app's venv on a claim, so an edit survives the restart — and the restart *is* the relaunch |
| Built for | distroless targets with no shell of their own; gdb against the running workload | edit → relaunch → see the change through the Service | an emergency fix that has to outlive the session, with provenance |
| Resources | shares the workload's limits, **cannot reserve its own** | has its own cpu, memory and ephemeral-storage requests | a ReadWriteOnce claim, mounted at the same path on both sides |
| Needs | nothing at deploy time | nothing at deploy time | **deploy-time chart cooperation**, and it is Python-only and single-replica-only |
| Risk to the workload | real — see below | none by default; the origin pod is never touched | it **rolls the workload**: that is how the fix takes |
| Explained in | [What `attach` does](docs/explanations/attach-flow.md) | [What `dev` does](docs/explanations/dev-flow.md) | [What `hotfix` does](docs/explanations/hotfix-flow.md) |

## Try it

```
$ uvx podbench doctor
$ uvx podbench attach pod/web-7d9f8c5b4-x2k9p -n demo
```

`doctor` checks the prerequisites, the cluster-side RBAC and the one-time ssh
`Include` line — the only thing podbench leaves behind — and names whatever is
missing; `--fix` adds the `Include`. `attach` then walks a capability ladder,
lands the best seat the cluster will admit, and runs its probe **inside the
container it just created**, so the report is measured rather than inferred from
the spec it asked for:

```
rung        full - uid 0, gid 0, CapEff 00000000a80c25fb
supports
  [x] live attach (gdb -p <pid>)
  [x] read-only inspect (/proc/<pid>/root, maps, environ)
      root, maps and environ readable
  [x] debug launched processes (podbench dbg --launch ./prog)
  [ ] iterate (edit, relaunch, verify through the Service)
  [x] ssh seat (Remote-SSH: editor, shell, git, sftp)
measured
  verdict     live attach available
  blocker     none

ssh config written to ~/.podbench/config.d/demo-web-7d9f8c5b4-x2k9p.conf
then:  ssh podbench-demo-web-7d9f8c5b4-x2k9p
```

Connect that alias with **Remote-SSH: Connect to Host…**, or let
`podbench vscode` do the whole thing — seat, pod sizing, debugpy and window — in
one command.

The other two modes are a table row away. For the inner loop, `podbench dev`
authors the dev pod and `podbench run` relaunches the app inside it: measured
end to end, **1.18 s** per edit → relaunch → verified-through-the-Service
cycle. When the fix has to survive the pod, `podbench hotfix` moves the venv
onto a claim so a restart no longer restores the image's code, and records
where the change came from.

> Only prereleases are published so far, so `uvx podbench` resolves the newest
> beta today. To run an unreleased checkout instead, put
> `--from git+https://github.com/gilesknap/podbench` in front of the verb.

## Read this before you attach to a live pod

Not fine print — each of these has bitten a spike on a real cluster.

* **A seat shares the pod's limits and cannot reserve its own — and it is a VS
  Code session, not the seat, that spends them.** An ephemeral container may not
  declare `resources` at all, so the seat lives in the pod's cgroup: exceed
  memory and the kernel OOM-kills something in it, exceed ephemeral storage and
  the kubelet evicts the whole pod. How much that matters is now measured rather
  than assumed. Ten live seats on a Diamond beamline (2026-08-19) cost
  **13–23 MiB** each, against **170–3858 MiB** of headroom per pod, three seats
  to a pod, no OOM anywhere — so `attach` reads *this* pod's headroom, prints it
  on the report's `memory` row, and warns only when it is genuinely thin. A
  **vscode-server** is the case that still bites: 1215 MiB live with a single
  extension, which does not fit in most of those pods, so `podbench vscode` is
  checked against the same number — and raises the target's limit in place to
  cover the shortfall, since it is about to spend it. `attach --resize MEMORY`
  is the same lever by hand, and `podbench dev` gives the seat limits of its
  own. One beamline at one
  moment: that falsifies "always warn", it does not prove no cluster is tight.
* **Being refused `SYS_PTRACE` is normal, not an error.** It is outside both the
  baseline and the restricted Pod Security Standards, so podbench walks a ladder
  with two valid rungs and lands the better one the cluster admits. Four
  unrelated subsystems deny attach with the same `EPERM`, so it probes and
  **names the blocker** instead of leaving you an errno.
* **Ephemeral containers are permanent.** They cannot be removed, restarted or
  edited, and a name once used is burnt for the life of the pod. So `attach`
  reconnects by default, nothing may live only in the writable layer, and
  `--new` is for when you mean it.
* **A dev pod never joins a Service by accident.** `podbench dev` drops the
  origin's selector labels unless you pass `--take-traffic`, and `--cutover`
  records the original selector for an exact restore.

The docs carry the reasoning and the measurements behind all four, and *What is
proven, and what is not* is candid about the gaps — every memory figure is still a lower
bound, and Hotfix mode has never been run against a cluster.

What            | Where
:---:           | :---:
Source          | <https://github.com/gilesknap/podbench>
Launcher        | <https://pypi.org/project/podbench> (prereleases only)
Image           | `ghcr.io/gilesknap/podbench`
Chart           | `oci://ghcr.io/gilesknap/charts/podbench`
Documentation   | <https://gilesknap.github.io/podbench>
Releases        | <https://github.com/gilesknap/podbench/releases>

<!-- README only content. Anything below this line won't be included in index.md -->

## Documentation

See <https://gilesknap.github.io/podbench> for the full documentation.

* Tutorials — [setup](docs/tutorials/setup.md),
  [your first session](docs/tutorials/first-session.md)
* How-to — [attach to a pod](docs/how-to/attach-to-a-pod.md),
  [debug with gdb](docs/how-to/debug-with-gdb.md),
  [iterate on Python](docs/how-to/iterate-on-python.md),
  [VS Code Remote-SSH](docs/how-to/vscode-remote-ssh.md),
  [the container image](docs/how-to/run-container.md)
* Reference — [CLI](docs/reference/cli.md), [glossary](docs/reference/glossary.md)
* Explanations — [architecture](docs/explanations/architecture.md),
  [security](docs/explanations/security.md),
  [what is proven, and what is not](docs/explanations/status.md),
  [design brief](docs/explanations/design-brief.md),
  [Phase 0 report](docs/explanations/spikes/phase0-report.md)
