-
Notifications
You must be signed in to change notification settings - Fork 121
arcgis‐notebooks Cookbook Recipes
arcgis-notebooks cookbook is used to install and configure ArcGIS Notebooks.
Brief descriptions of arcgis-notebooks cookbook recipes along with cookbook attributes are available at README.md. This page provides more detailed descriptions of the recipes and specifies attributes used by each recipe.
Some cookbook attributes are not used directly by the recipes but used to set the default values for other attributes. For example, node['arcgis']['version'] attribute affects default values of node['arcgis']['...']['product_code'] attributes.
Calls arcgis-notebooks::server recipe.
Installs and starts Docker engine. The recipe is supported only on Linux platforms.
Attributes used by the recipe:
{
"run_list": [
"recipe[arcgis-notebooks::docker]"
]
}Federates ArcGIS Notebook Server with Portal for ArcGIS and enables NotebookServer role.
Attributes used by the recipe:
{
"arcgis": {
"portal": {
"wa_url": "https://portal.domain.com/portal",
"admin_username": "admin",
"admin_password": "admin123"
},
"notebook_server": {
"web_context_url": "https://domain.com/notebooks",
"private_url": "https://domain.com/notebooks",
"admin_username": "siteadmin",
"admin_password": "change.it"
}
},
"run_list": [
"recipe[arcgis-notebooks::federation]"
]
}Installs ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"notebook_server": {
"setup_archive": "/opt/software/esri/ArcGIS_Notebook_Server_Linux_108_173012.tar.gz",
"standard_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Standard_108_172942.tar.gz",
"advanced_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Advanced_108_172943.tar.gz",
"authorization_file": "/opt/software/esri/notebooksadvsvr_108.ecp",
"license_level": "advanced",
"install_dir": "/home/arcgis",
"server_directories_root": "/home/arcgis/notebookserver/usr/directories",
"config_store_connection_string": "/home/arcgis/notebookserver/usr/directories/config-store",
"workspace": "/home/arcgis/notebookserver/usr/directories/config-store",
"configure_autostart": true,
"install_system_requirements": true
}
},
"run_list": [
"recipe[arcgis-notebooks::install_server]"
]
}Installs ArcGIS Web Adaptor for ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"web_server": {
"webapp_dir": "/opt/tomcat_arcgis/webapps"
},
"web_adaptor": {
"install_dir": "/",
"setup_archive": "/opt/software/esri/Web_Adaptor_Java_Linux_108_172992.tar.gz"
},
"notebook_server": {
"wa_name": "notebooks"
}
},
"run_list": [
"recipe[arcgis-notebooks::install_server_wa]"
]
}Installs and configures ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"notebook_server": {
"setup_archive": "/opt/software/esri/ArcGIS_Notebook_Server_Linux_108_173012.tar.gz",
"standard_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Standard_108_172942.tar.gz",
"advanced_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Advanced_108_172943.tar.gz",
"authorization_file": "/opt/software/esri/notebooksadvsvr_108.ecp",
"license_level": "advanced",
"admin_username": "siteadmin",
"admin_password": "change.it",
"install_dir": "/home/arcgis",
"directories_root": "/home/arcgis/notebookserver/usr/directories",
"config_store_connection_string": "/home/arcgis/notebookserver/usr/config-store",
"workspace": "/home/arcgis/notebookserver/usr/arcgisworkspace",
"configure_autostart": true,
"install_system_requirements": true
}
},
"run_list": [
"recipe[arcgis-notebooks::server]"
]
}Joins additional machines to an ArcGIS Notebook Server site.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"notebook_server": {
"setup_archive": "/opt/software/esri/ArcGIS_Notebook_Server_Linux_108_173012.tar.gz",
"standard_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Standard_108_172942.tar.gz",
"advanced_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Advanced_108_172943.tar.gz",
"authorization_file": "/opt/software/esri/notebooksadvsvr_108.ecp",
"license_level": "advanced",
"admin_username": "suteadmin",
"admin_password": "change.it",
"install_dir": "/home/arcgis",
"primary_server_url": "https://domain.com:11443/arcgis/admin",
"admin_username": "admin",
"admin_password": "change.it",
"configure_autostart": true,
"install_system_requirements": true
}
},
"run_list": [
"recipe[arcgis-notebooks::server_node]"
]
}Installs and configures ArcGIS Web Adaptor for ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"web_server": {
"webapp_dir": "/opt/tomcat_arcgis/webapps"
},
"web_adaptor": {
"install_dir": "/",
"setup_archive": "/opt/software/esri/Web_Adaptor_Java_Linux_108_172992.tar.gz"
},
"notebook_server": {
"url": "https://hostname:11443",
"wa_name": "notebooks",
"wa_url": "https://hostname/notebooks",
"admin_username": "admin",
"admin_password": "change.it"
}
},
"run_list": [
"recipe[arcgis-notebooks::server_wa]"
]
}Uninstalls ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"notebook_server": {
"install_dir": "/home/arcgis"
}
},
"run_list": [
"recipe[arcgis-notebooks::uninstall_server]"
]
}Uninstalls ArcGIS Web Adaptor for ArcGIS Notebook Server.
Attributes used by the recipe:
{
"arcgis": {
"version": "10.8",
"run_as_user": "arcgis",
"web_server": {
"webapp_dir": "/opt/tomcat_arcgis/webapps"
},
"web_adaptor": {
"install_dir": "/"
},
"notebook_server": {
"wa_name": "notebooks"
}
},
"run_list": [
"recipe[arcgis-notebooks::uninstall_server_wa]"
]
}