STAP-JUPYTER-*(1)

📦 version 5.6, in arch rolling, fedora 43, fedora 44

🦋 STAP-JUPYTER-* 💅

ok bestie so this is the General Commands Manual page for the stap-jupyter-* girlies, and it covers TWO whole commands — we're getting a two-for-one deal, no cap. 💖

✨ NAME ✨

  • stap-jupyter-install — locally install isystemtap 🧚
  • stap-jupyter-container — manage an isystemtap container image 🫶

🌸 SYNOPSIS 🌸

stap-jupyter-install [--remove] [--container-install PREFIX]

stap-jupyter-container [--repo REPOSITORY] [--image IMAGE] [--tag TAG]
[--keyname KEYNAME] --{run, pull, build, publish, remove}

💜 DESCRIPTION 💜

ISystemtap is an interactive jupyter interface for the incremental writing and running of Systemtap scripts. like, you write a little, you run a little, you vibe. iconic behavior honestly. ✨

The stap-jupyter-install program can be used to locally install the ISystemtap jupyter kernel, language-server and jupyter-lab extension in ~/.systemtap/jupyter. Once installed, the kernel can be used with jupyter-lab. 🎀

Alternatively the stap-jupyter-container program can be used to run ISystemtap within a container, preventing the need for any local jupyter kernel installation. so like, if you don't wanna commit to the whole local-install thing, the container's got you. main character energy. 👑

🎀 INSTALL OPTIONS 🎀

The following options are supported by stap-jupyter-install. Any other option prints a short help message. (it's giving "I don't know her" but polite 💀)

  • --remove — Uninstall the local ISystemtap files. bye bye bestie, it's not you it's the disk space 😭
  • --container-install PREFIX — [Intended For Maintainers Only] This is used to specify the PREFIX of the install directory for stap. It is called within the container build process, and should not be used otherwise.
fr fr, that last one is a maintainers-only situation. if you're not building the container, don't touch it. stay in your lane bestie 🚧

💅 CONTAINER OPTIONS 💅

The following options are supported by stap-jupyter-container. Any other option prints a short help message.

  • --repo REPOSITORY — Specify which repository to use, defaults to "quay.io". 🏠
  • --image IMAGE — Specify the image name. Defaults to "systemtap/isystemtap". 🖼️
  • --tag TAG — Specify the image tag. Defaults to "latest". 🏷️
  • --keyname KEYNAME — In order for the container to run stap it needs to ssh to the host. It requires an ssh key pair, and is specified by KEYNAME, which is by default "id_rsa". 🔑 like yes, it needs to ssh home to run stap, that's just the arrangement.

⭐ CONTAINER COMMANDS ⭐

The following commands are recognized by stap-jupyter-container. One of the following is required. pick your fighter, but you MUST pick one. 💖

  • --run — Run the image. Pulls if not done already. 🏃♀️
  • --pull — Pulls the image. 🫳
  • --build — Builds a local copy of the image. The repo will be "localhost". See podman images. 🔨
  • --remove — Removes the image. 💀
  • --publish — [Intended For Maintainers Only] This is used to publish the built image. It requires write permissions to https://quay.io/systemtap/isystemtap.
okay so --publish is the other maintainer-only one. write permissions to that quay.io link are NOT a casual thing, so unless that's literally your job, hands off 🙈

🌈 SEE ALSO 🌈

go read those too, they're the supporting cast and they ate 💖

💀 BUGS 💀

Use the Bugzilla link of the project web page or our mailing list.

http://sourceware.org/systemtap/, <systemtap@sourceware.org>

like if something's broken, tell the people, don't just suffer in silence bestie 🫶

and that's the whole page, you're so welcome ✨ this was STAP-JUPYTER-*(1) from the General Commands Manual, signed off the way the original does it — just the good old STAP-JUPYTER-*(1) down at the bottom, no extra version or date drama. mwah 💅💖

📦 where this page comes from