|
1 | 1 | # Describes the format for available pyscript services
|
2 | 2 |
|
3 | 3 | reload:
|
4 |
| - description: Reload all available pyscripts and restart triggers |
| 4 | + name: Reload pyscript |
| 5 | + description: Reloads all available pyscripts and restart triggers |
5 | 6 | fields:
|
6 | 7 | global_ctx:
|
7 |
| - description: only reload this specific global context (file or app) |
| 8 | + name: Global Context |
| 9 | + description: Only reload this specific global context (file or app) |
8 | 10 | example: file.example
|
| 11 | + required: false |
| 12 | + selector: |
| 13 | + text: |
9 | 14 |
|
10 | 15 | jupyter_kernel_start:
|
11 |
| - description: Start a jupyter kernel for interactive use; called by Jupyter front end |
| 16 | + name: Start Jupyter kernel |
| 17 | + description: Starts a jupyter kernel for interactive use; Called by Jupyter front end and should generally not be used by users |
12 | 18 | fields:
|
13 | 19 | shell_port:
|
14 |
| - description: shell port number |
| 20 | + name: Shell Port Number |
| 21 | + description: Shell port number |
15 | 22 | example: 63599
|
| 23 | + required: false |
| 24 | + selector: |
| 25 | + number: |
| 26 | + min: 10240 |
| 27 | + max: 65535 |
16 | 28 | iopub_port:
|
17 |
| - description: iopub port number |
| 29 | + name: IOPub Port Number |
| 30 | + description: IOPub port number |
18 | 31 | example: 63598
|
| 32 | + required: false |
| 33 | + selector: |
| 34 | + number: |
| 35 | + min: 10240 |
| 36 | + max: 65535 |
19 | 37 | stdin_port:
|
20 |
| - description: stdin port number |
| 38 | + name: Stdin Port Number |
| 39 | + description: Stdin port number |
21 | 40 | example: 63597
|
| 41 | + required: false |
| 42 | + selector: |
| 43 | + number: |
| 44 | + min: 10240 |
| 45 | + max: 65535 |
22 | 46 | control_port:
|
23 |
| - description: control port number |
| 47 | + name: Control Port Number |
| 48 | + description: Control port number |
24 | 49 | example: 63596
|
| 50 | + required: false |
| 51 | + selector: |
| 52 | + number: |
| 53 | + min: 10240 |
| 54 | + max: 65535 |
25 | 55 | hb_port:
|
26 |
| - description: heartbeat port number |
| 56 | + name: Heartbeat Port Number |
| 57 | + description: Heartbeat port number |
27 | 58 | example: 63595
|
| 59 | + required: false |
| 60 | + selector: |
| 61 | + number: |
| 62 | + min: 10240 |
| 63 | + max: 65535 |
28 | 64 | ip:
|
29 |
| - description: ip address to connect to jupyter front end |
| 65 | + name: IP Address |
| 66 | + description: IP address to connect to Jupyter front end |
30 | 67 | example: 127.0.0.1
|
| 68 | + default: 127.0.0.1 |
| 69 | + required: false |
| 70 | + selector: |
| 71 | + text: |
31 | 72 | key:
|
32 |
| - description: security key for signing |
| 73 | + name: Security Key |
| 74 | + description: Used for signing |
33 | 75 | example: 012345678-9abcdef023456789abcdef
|
| 76 | + required: true |
| 77 | + selector: |
| 78 | + text: |
34 | 79 | transport:
|
35 |
| - description: type of transport |
| 80 | + name: Transport Type |
| 81 | + description: Transport type |
36 | 82 | example: tcp
|
| 83 | + default: tcp |
| 84 | + required: false |
| 85 | + selector: |
| 86 | + select: |
| 87 | + options: |
| 88 | + - tcp |
| 89 | + - udp |
37 | 90 | signature_scheme:
|
38 |
| - description: signing algorithm |
| 91 | + name: Signing Algorithm |
| 92 | + description: Signing algorithm |
39 | 93 | example: hmac-sha256
|
| 94 | + required: false |
| 95 | + default: hmac-sha256 |
| 96 | + selector: |
| 97 | + select: |
| 98 | + options: |
| 99 | + - hmac-sha256 |
40 | 100 | kernel_name:
|
41 |
| - description: name of kernel |
| 101 | + name: Name of Kernel |
| 102 | + description: Kernel name |
42 | 103 | example: pyscript
|
| 104 | + required: true |
| 105 | + default: pyscript |
| 106 | + selector: |
| 107 | + text: |
0 commit comments