Metadata-Version: 2.4
Name: podbench
Version: 0.20.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/epics-containers/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: rich
Requires-Dist: typer>=0.12
Dynamic: license-file

# podbench prototype

Podbench keeps two modes and a single seat shape:

- podbench attach POD lands an ephemeral container using the target
  container's UID, GID and seccomp profile when Kubernetes reports them.
  Non-root seats drop all capabilities; root seats request four SSH capabilities.
- podbench hotfix manages a source checkout on one persistent claim per
  single-replica workload.

The image contains a shell, Git, uv, gdb, strace and basic process tools.
Attach prints an SSH command carried by `kubectl exec` (no pod network).
Use `--verbose` to also print a raw exec fallback. Images pull by default.
Inside a seat, `podbench debug` shows the process tree and attaches GDB to the
selected process using its container filesystem. `podbench debug --python PID`
instead uses GDB to inject debugpy on port 5678; restart the hotfix child after
disconnecting to remove the injected debugger. From your workstation, run
`kubectl port-forward -n NAMESPACE pod/POD 5678:5678` and connect your IDE's
Python attach configuration to `127.0.0.1:5678`. Exec liveness probes remain
held during the debug session; restart clears the hold.
`podbench status` shows attached seats and hotfix state together.
Main publishes `ghcr.io/epics-containers/podbench:prototype-attach-hotfix`;
override that with `--image` or `PODBENCH_IMAGE`. Use `attach --new` to pick up
a rebuilt image when a seat already exists.
Run `podbench doctor` to check local and cluster prerequisites; `--fix` only
creates the SSH config directory and installs that Include safely.

## Get connected

Install the workstation CLI from main:

    uv tool install git+https://github.com/epics-containers/podbench@main

You need `kubectl` configured for your cluster and an SSH key pair (by default `~/.ssh/id_ed25519`;
use `--identity` to select another).

    podbench doctor --fix -n NAMESPACE
    podbench attach POD --target CONTAINER -n NAMESPACE

Run the printed SSH command, or select its host alias in VS Code Remote-SSH.
Aliases pin the context and kubeconfig paths used at attach time.
`--target` defaults to the pod's first container. Hotfix commands call the same
option `--container`; use it consistently for pods with multiple containers.

## VS Code

    podbench ide vscode POD -n NAMESPACE [--target CONTAINER]

Run on your workstation with `code`, `kubectl` and SSH. Run `podbench doctor --fix`
once to install its SSH Include; IDE launch checks this before changing the pod.
The command opens a normal Remote-SSH workspace, installs Python/C++ debug
extensions in the seat, and generates an attach launcher for each readable
application process. Hotfix code at `/podbench/app` is already in the workspace;
generated files stay in the seat's home, outside your checkout. Rerun after an
application restart to refresh PIDs. Python is injected only when you start its
debug launcher, copied from the seat image (or the hotfix environment) into the
target's `/tmp`; restart the hotfix child afterwards to remove the debugger.
Normal ptrace/Yama restrictions still apply.

For agent-driven desktop testing from this checkout (Node 22+):

    podbench ide vscode POD -n t11-beamline --context default --code "$PWD/tools/vscode-code"
    node tools/vscode-ui.mjs windows
    export PODBENCH_VSCODE_WINDOW=WINDOW_ID
    node tools/vscode-ui.mjs snapshot
    node tools/vscode-ui.mjs key Ctrl+Shift+p
    node tools/vscode-ui.mjs text 'View: Show Run and Debug'
    node tools/vscode-ui.mjs key Enter

`tools/vscode-code` keeps its profile in ignored `tmp/vscode` and exposes the
desktop renderer on localhost port 9222. Override with `PODBENCH_VSCODE_DATA`
and `PODBENCH_VSCODE_PORT`. The driver also supports `click` (CSS selector),
`eval` (renderer JavaScript), `text`, debugger keys F5/F9/F10/F11, and
`screenshot /tmp/ide.png`; run `help` for details. Select an exact window ID
after each launch/reload; never assume the active window is the target.
Read the resulting UI after every action: a successful key dispatch does not
prove the command ran. Handle workspace trust for the selected T11 checkout,
then verify Remote-SSH, remote extensions, and Run and Debug are available.
The automation port grants IDE control; keep it local and close the dedicated
instance when finished. Local extensions use VS Code's normal extension directory.

The live pod gains **4 CPU / 8 GiB of limit headroom**, with **2 CPU / 4 GiB
of additional requests** (Guaranteed pods reserve the full limit). Reconnecting
does not repeatedly increase these values. This requires in-place resize support,
`patch pods/resize`, `patch pods`, and `list limitranges`; launch waits for actual
allocation and stops if the cluster cannot provide it. Only controller-owned
pods are supported: Argo CD keeps reconciling the unchanged workload template,
while the extra budget lasts until the pod is replaced. No Argo settings change.
Use `--no-headroom` to use the existing budget without resize calls or annotations.

Git name/email are copied to the seat; private keys and credential helpers stay
local. Add `--forward-agent` to forward a loaded SSH agent for Git operations.
Reading and debugging need only SSH authentication. IDE connections use a separate
`.ide` alias, so ordinary attach cannot change their forwarding settings.
Forwarding lasts while the SSH connection is alive; any process running as the
seat's UID can use that agent. VS Code must use your normal `~/.ssh/config`.

## Hotfix lifecycle

1. Enable hotfix wiring in an epics-containers service chart, then review and
   deploy the Git diff:

       podbench hotfix enable SERVICE_DIRECTORY -n NAMESPACE

   This requires a live workload and derives the release, pod, container,
   security identity, entrypoint and values layout. IOC and services-template
   BlueAPI charts are wired automatically; options override those defaults.

2. For other charts, print the dependency and values for manual application:

       podbench hotfix values --app RELEASE --from-pod POD -n NAMESPACE

   For wrapper charts, use `--values-prefix KEY` to nest the workload settings
   under their chart key. The claim settings remain at the top level. Use
   `--entrypoint` to select code under `/podbench/app` when the original command
   still points to the image's installed application.

3. Initialize its claim:

       podbench hotfix init POD --repo URL -n NAMESPACE

   Python projects are synced with uv and gain debugpy for on-demand injection.
   Other repositories are cloned without a dependency-install step. The claim
   directory must be empty apart from `lost+found`: init refuses to replace
   a checkout. After a failed init, inspect and back up its contents before
   clearing the directory and retrying.

   Generated values keep liveness probes but extend non-exec probe failure
   thresholds for the two-minute restart window.

4. Edit /podbench/app in the seat and relaunch:

       podbench hotfix restart POD -n NAMESPACE
       podbench hotfix status -n NAMESPACE

   Add `--reinstall` to restart after changing Python dependencies. This requires
   a running seat attached to the same application container.

5. Remove the generated workload values, redeploy, then retire the PVC:

       podbench hotfix retire PVC --delete-claim -n NAMESPACE

This is a rapid-iteration prototype. Root and unknown-identity targets use the
same seat spec and may not provide useful ptrace access.
Hotfix initialization also installs a small `LD_PRELOAD` shim so dynamically
linked application processes opt into Yama debugging without `SYS_PTRACE`.
