1STAP-JUPYTER-*(1)           General Commands Manual          STAP-JUPYTER-*(1)
2
3
4

NAME

6       stap-jupyter-install   - locally install isystemtap
7
8       stap-jupyter-container - manage an isystemtap container image
9
10
11

SYNOPSIS

13       stap-jupyter-install [--remove] [--container-install PREFIX]
14
15       stap-jupyter-container  [--repo REPOSITORY] [--image IMAGE] [--tag TAG]
16       [--keyname KEYNAME] --{run, pull, build, publish, remove}
17
18

DESCRIPTION

20       ISystemtap is an interactive  jupyter  interface  for  the  incremental
21       writing and running of Systemtap scripts.
22
23       The  stap-jupyter-install  program  can  be used to locally install the
24       ISystemtap jupyter kernel, language-server and jupyter-lab extension in
25       ~/.systemtap/jupyter.   Once  installed,  the  kernel  can be used with
26       jupyter-lab.
27
28       Alternatively the stap-jupyter-container program can  be  used  to  run
29       ISystemtap  within  a  container,  preventing  the  need  for any local
30       jupyter kernel installation.
31
32

INSTALL OPTIONS

34       The following options are supported by stap-jupyter-install. Any  other
35       option prints a short help message.
36
37       --remove
38              Uninstall the local ISystemtap files.
39
40       --container-install PREFIX
41              [Intended For Maintainers Only] This is used to specify the PRE‐
42              FIX of the install directory for stap. It is called  within  the
43              container build process, and should not be used otherwise.
44

CONTAINER OPTIONS

46       The  following  options  are  supported  by stap-jupyter-container. Any
47       other option prints a short help message.
48
49       --repo REPOSITORY
50              Specify which repository to use, defaults to "quay.io".
51
52       --image IMAGE
53              Specify the image name. Defaults to "systemtap/isystemtap"
54
55       --tag TAG
56              Specify the image tag. Defaults to "latest"
57
58       --keyname KEYNAME
59              In order for the container to run stap it needs to  ssh  to  the
60              host.  It requires an ssh key pair, and is specified by KEYNAME,
61              which is by default "id_rsa".
62
63

CONTAINER COMMANDS

65       The following commands are recognized by stap-jupyter-container. One of
66       the following is required.
67
68       --run
69               Run the image. Pulls if not done already.
70
71       --pull
72               Pulls the image.
73
74       --build
75               Builds a local copy of the image. The repo will be "localhost".
76              See podman images.
77
78       --remove
79               Removes the image.
80
81       --publish
82               [Intended For Maintainers Only] This is  used  to  publish  the
83              built     image.    It    requires    write    permissions    to
84              https://quay.io/systemtap/isystemtap.
85
86

SEE ALSO

88       stap(1),
89       podman(1)
90       ssh(1)
91
92

BUGS

94       Use the Bugzilla link of the project web  page  or  our  mailing  list.
95       http://sourceware.org/systemtap/,<systemtap@sourceware.org>.
96
97
98
99                                                             STAP-JUPYTER-*(1)
Impressum