# stap-jupyter

## 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.
    
           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.
    


## INSTALL OPTIONS



           The following options are supported by stap-jupyter-install. Any
           other option prints a short help message.
    
           **--remove**
                  Uninstall the local ISystemtap files.
    
           **--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.
    


## 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".
    


## CONTAINER COMMANDS



           The following commands are recognized by stap-jupyter-container.
           One of the following is required.
    
           **--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.
    


## BUGS



           Use the Bugzilla link of the project web page or our mailing list.
           **http://sourceware.org/systemtap/ **,**< systemtap@sourceware.org>**.
    


* * *