- URL:
- https://<notebookserveradmin>/notebooks/runtimes/register
- Methods:
POST- Required Capability:
- Administrator
- Version Introduced:
- 10.7.1
Description
If you created a custom notebook runtime to expand the capabilities and resources of the runtimes provided by Esri, use this operation to register the custom runtime with the site. Notebook runtimes use Docker images. See Extend a notebook runtime.
Request parameters
| Parameter | Details |
|---|---|
(Required) | A string to represent the new runtime, such as |
(Required) | The Docker image reference in the format |
(Required) | The version of the Esri-provided runtime used as the base Docker image. |
(Optional) | The only valid value is |
(Optional) | Full (nontruncated) ID for the new Docker image, when it was built. |
(Required) | Set this value to Values: |
(Required) | The maximum number of CPU units to be used for each container. |
(Required) | The maximum amount of memory to be used for each container. |
(Required) | The unit specified by the |
(Optional) | The maximum amount of swap memory available for each container if it reaches the |
(Optional) | The unit specified by the |
(Optional) | The amount of shared memory available for each container. |
(Optional) | The unit specified by the |
(Optional) | Only applies to GPU runtimes in Linux environments. |
(Optional) | Only applies to GPU runtimes in Linux environments. |
(Optional) | The full path to a |
(Optional) | If true, a manifest is automatically generated for the notebook runtime. If the manifestFile parameter is provided, this setting is ignored. Values: |
(Optional) | The default response format. The default response format is Values: |
Example usage
POST /<context>/admin/notebooks/runtimes/register HTTP/2
Host: notebookserver.example.com
Content-Type: multipart/form-data; boundary=----boundary
Content-Length: []
------boundary
Content-Disposition: form-data; name="name"
Notebook Custom Runtime Python 3
------boundary
Content-Disposition: form-data; name="imageId"
1a0d115fe38be3533e4242f926e0f3c356b25bfe2ab0867a26d0f259128d4b86
------boundary
Content-Disposition: form-data; name="containerType"
docker
------boundary
Content-Disposition: form-data; name="imagePullString"
------boundary
Content-Disposition: form-data; name="requiresAdvancedPrivileges"
true
------boundary
Content-Disposition: form-data; name="maxCpu"
2.0
------boundary
Content-Disposition: form-data; name="maxMemory"
6.0
------boundary
Content-Disposition: form-data; name="maxMemoryUnit"
g
------boundary
Content-Disposition: form-data; name="maxSwapMemory"
------boundary
Content-Disposition: form-data; name="maxSwapMemoryUnit"
g
------boundary
Content-Disposition: form-data; name="sharedMemory"
------boundary
Content-Disposition: form-data; name="sharedMemoryUnit"
m
------boundary
Content-Disposition: form-data; name="dockerRuntime"
------boundary
Content-Disposition: form-data; name="manifestFile"; filename=""
Content-Type: application/octet-stream
------boundary
Content-Disposition: form-data; name="createManifestFileHidden"
false
------boundary
Content-Disposition: form-data; name="f"
pjson
------boundary
Content-Disposition: form-data; name="token"
token
------boundary--JSON Response syntax
{
"notebookRuntime": {
"imageId": "<runtime imageId>",
"containerType": "<containerType>",
"maxCpu": '<maxCpu cores>',
"version": "<runtime version>",
"maxMemory": '<maxMemory>',
"esriProvidedRuntime": ,
"name": "<runtime name>",
"maxMemoryUnit": "<memory unit>",
"maxSwapMemory": '<max Swap Memory>',
"maxSwapMemoryUnit": "maxSwapMemoryUnit",
"id": "runtime id",
"requiresAdvancedPrivileges": true|false ,
"sharedMemorySizeUnit": "sharedMemorySizeUnit",
"sharedMemorySize": '<sharedMemorySize>'
},
"status": "success"
}JSON Response example
{
"notebookRuntime": {
"imageId": "1a0d115fe38be3533e4242f926e0f3c356b25bfe2ab0867a26d0f259128d4b86",
"containerType": "docker",
"maxCpu": 2,
"version": "5.0",
"maxMemory": 6,
"esriProvidedRuntime": false,
"name": "Notebook Custom Runtime Python 3",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"id": "08c6c325-a81f-40b4-8205-b883980f1e2e",
"requiresAdvancedPrivileges": true,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 2048
},
"status": "success"
}