cookbook 'arcgis-notebooks', '= 3.6.0'
arcgis-notebooks (14) Versions 3.6.0 Follow1
Installs/Configures ArcGIS Notebook Server
cookbook 'arcgis-notebooks', '= 3.6.0', :supermarket
knife supermarket install arcgis-notebooks
knife supermarket download arcgis-notebooks
arcgis-notebooks cookbook
This cookbook installs and configures ArcGIS Notebook Server.
Requirements
Supported ArcGIS Notebook Server versions
- 10.7.1
- 10.8
- 10.8.1
Supported ArcGIS software
- ArcGIS Notebook Server
Platforms
- Ubuntu 16.04, 18.04
- Rhel 6.5, 7.0
Dependencies
The following cookbooks are required:
- arcgis-enterprise
- arcgis-repository
- docker
Attributes
-
node['arcgis']['notebook_server']['url']
= ArcGIS Notebook Server URL. Default URL ishttps://<FQDN of the machine>:11443
. -
node['arcgis']['notebook_server']['wa_name']
= Name of ArcGIS Web Adaptor used for ArcGIS Notebook Server. Default name isnotebooks
. -
node['arcgis']['notebook_server']['wa_url']
= URL of the Web Adaptor used for ArcGIS Notebook Server. Default URL ishttps://<FQDN of the machine>/<Notebook Server Web Adaptor name>
. -
node['arcgis']['notebook_server']['domain_name']
= ArcGIS Notebook Server site domain name. Default domain is FQDN of the machine. -
node['arcgis']['notebook_server']['private_url']
= Private URL of ArcGIS Notebook Server. Default URL ishttps://<FQDN of the machine>:11443/arcgis
. -
node['arcgis']['notebook_server']['web_context_url']
= Web Context URL of ArcGIS Notebook Server. Default URL ishttps://<FQDN of the machine>/<Notebook Server Web Adaptor name>
. -
node['arcgis']['notebook_server']['authorization_file']
= ArcGIS Notebook Server authorization file path. -
node['arcgis']['notebook_server']['authorization_file_version']
= ArcGIS Notebook Server authorization file version. Default value isnode['arcgis']['server']['authorization_file_version']
. -
node['arcgis']['notebook_server']['license_level']
= License level of ArcGIS Notebook Server. Allowed values arestandard
andadvanced
. Default license level isstandard
. -
node['arcgis']['notebook_server']['install_dir']
= ArcGIS Notebook Server installation directory. By default, ArcGIS Notebook Server is installed to%ProgramW6432%\ArcGIS\NotebookServer
on Windows machines and to/home/arcgis
on Linux machines. -
node['arcgis']['notebook_server']['directories_root']
= The root ArcGIS Notebook Server server directory location. The default value isC:\arcgisnotebookserver\directories
on Windows and/<ArcGIS Notebook Server install directory>/notebookserver/usr/directories
on Linux. -
node['arcgis']['notebook_server']['config_store_connection_string']
= The configuration store location for the ArcGIS Notebook Server site. By default, the configuration store is created in the local directoryC:\arcgisnotebookserver\config-store
on Windows and/<ArcGIS Notebook Server install directory>/usr/config-store
on Linux. -
node['arcgis']['notebook_server']['workspace']
= The workspace directory location. This must be a local path; if the site will have additional machines joined to it, a replication method must be set up between the workspace directories of each machine. By default the workspace directory is set toC:\arcgisnotebookserver\arcgisworkspace
on Windows and to/<ArcGIS Notebook Server install directory>/usr/arcgisworkspace
on Linux. -
node['arcgis']['notebook_server']['setup_archive']
= Path to ArcGIS Notebook Server setup archive. Default value depends onnode['arcgis']['version']
attribute value. -
node['arcgis']['notebook_server']['setup']
= The location of ArcGIS Notebook Server setup executable. Default location is%USERPROFILE%\Documents\ArcGIS10.8\NotebookServer\Setup.exe
on Windows and/opt/arcgis/10.8/NotebookServer_Linux/Setup
on Linux. -
node['arcgis']['notebook_server']['standard_images']
= Standard Docker container images for notebooks. Default value depends onnode['arcgis']['version']
attribute value. -
node['arcgis']['notebook_server']['advanced_images']
= Advanced Docker container images for notebooks. Default value depends onnode['arcgis']['version']
attribute value. -
node['arcgis']['notebook_server']['configure_autostart']
= If set to true, on Linux the Notebook Server is configured to start with the operating system. Default value istrue
. -
node['arcgis']['notebook_server']['admin_username']
= Primary ArcGIS Notebook Server administrator user name. Default user name isadmin
. -
node['arcgis']['notebook_server']['admin_password']
= Primary ArcGIS Notebook Server administrator password. Default value ischange.it
. -
node['arcgis']['notebook_server']['primary_server_url']
= The URL of the existing ArcGIS Notebook Server site to join, in the formathttps://notebookserver.domain.com:11443/arcgis/admin
. Default URLnil
. -
node['arcgis']['notebook_server']['install_system_requirements']
= Enable system-level configuration for ArcGIS Notebook Server. Default value istrue
. -
node['arcgis']['notebook_server']['ports']
= Ports to open for Notebook Servier in Windows firewall. Default is11443
.
Recipes
arcgis-notebooks::default
Installs and configures ArcGIS Notebook Server.
arcgis-notebooks::docker
Installs Docker engine.
arcgis-notebooks::federation
Federates ArcGIS Notebook Server with Portal for ArcGIS and enables NotebookServer role.
arcgis-notebooks::install_server
Installs ArcGIS Notebook Server.
arcgis-notebooks::install_server_wa
Installs ArcGIS Web Adaptor for ArcGIS Notebook Server.
arcgis-notebooks::server
Installs and configures ArcGIS Notebook Server.
arcgis-notebooks::server_node
Joins additional machines to an ArcGIS Notebook Server site.
arcgis-notebooks::server_wa
Installs and configures ArcGIS Web Adaptor for ArcGIS Notebook Server.
arcgis-notebooks::uninstall_server
Uninstalls ArcGIS Notebook Server.
arcgis-notebooks::uninstall_server_wa
Uninstalls ArcGIS Web Adaptor for ArcGIS Notebook Server.
arcgis-notebooks::unregister_machine
Unregisters server machine from the ArcGIS Notebook Server site.
Usage
Example JSON for linux deployments:
{ "arcgis": { "version": "10.7.1", "run_as_user": "arcgis", "notebook_server": { "setup_archive": "/opt/software/esri/ArcGIS_Notebook_Server_Linux_1071_169927.tar.gz", "standard_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Standard_1071_169736.tar.gz", "advanced_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Advanced_1071_169738.tar.gz", "authorization_file": "/opt/software/esri/notebooksadvsvr_107.ecp", "license_level": "advanced", "admin_username": "admin", "admin_password": "change.it", "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-enterprise::system]", "recipe[arcgis-notebooks::docker]", "recipe[arcgis-notebooks::server]" ] }
{ "arcgis": { "version": "10.7.1", "run_as_user": "arcgis", "notebook_server": { "setup_archive": "/opt/software/esri/ArcGIS_Notebook_Server_Linux_1071_169927.tar.gz", "standard_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Standard_1071_169736.tar.gz", "advanced_images": "/opt/software/esri/ArcGIS_Notebook_Docker_Advanced_1071_169738.tar.gz", "authorization_file": "/opt/software/esri/notebooksadvsvr_107.ecp", "license_level": "advanced", "primary_server_url": "https://notebookserver.domain.com:11443/arcgis/admin", "admin_username": "admin", "admin_password": "change.it", "configure_autostart": true, "install_system_requirements": true } }, "run_list": [ "recipe[arcgis-enterprise::system]", "recipe[arcgis-notebooks::docker]", "recipe[arcgis-notebooks::server_node]" ] }
See wiki pages for more information about using ArcGIS cookbooks.
Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Contributing
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Licensing
Copyright 2020 Esri
Licensed under the Apache License, Version 2.0 (the "License");
You may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
A copy of the license is available in the repository's License.txt file.
[](Esri Tags: ArcGIS Enterprise Notebook Server Chef Cookbook)
[](Esri Language: Ruby)
Dependent cookbooks
arcgis-enterprise ~> 3.6 |
arcgis-repository ~> 3.6 |
docker ~> 4.9 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
arcgis-notebooks CHANGELOG
This file is used to list changes made in each version of the arcgis-notebooks cookbook.
3.6.0
- Added support for ArcGIS Notebook Server 10.8.1.
- Added unregister_machine recipe.
3.5.0
- Initial release of the cookbook.
Collaborator Number Metric
3.6.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
3.6.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
3.6.0 failed this metric
FC074: LWRP should use DSL to define resource's default action: arcgis-notebooks/resources/server.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: arcgis-notebooks/resources/server.rb:161
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:24
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:25
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:26
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:27
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:28
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:29
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:30
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:31
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:32
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:33
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:34
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:35
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:36
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:37
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:38
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:39
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:40
FC092: Custom resources should not define actions: arcgis-notebooks/resources/server.rb:20
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
3.6.0 passed this metric
Testing File Metric
3.6.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.6.0 passed this metric
3.6.0 failed this metric
3.6.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
3.6.0 failed this metric
FC074: LWRP should use DSL to define resource's default action: arcgis-notebooks/resources/server.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: arcgis-notebooks/resources/server.rb:161
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:24
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:25
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:26
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:27
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:28
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:29
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:30
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:31
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:32
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:33
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:34
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:35
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:36
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:37
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:38
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:39
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:40
FC092: Custom resources should not define actions: arcgis-notebooks/resources/server.rb:20
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
3.6.0 passed this metric
Testing File Metric
3.6.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.6.0 passed this metric
3.6.0 failed this metric
FC085: Resource using new_resource.updated_by_last_action to converge resource: arcgis-notebooks/resources/server.rb:161
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:24
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:25
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:26
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:27
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:28
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:29
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:30
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:31
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:32
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:33
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:34
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:35
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:36
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:37
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:38
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:39
FC091: Use property not attribute in custom resources: arcgis-notebooks/resources/server.rb:40
FC092: Custom resources should not define actions: arcgis-notebooks/resources/server.rb:20
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
3.6.0 passed this metric
Testing File Metric
3.6.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.6.0 passed this metric
3.6.0 failed this metric
3.6.0 passed this metric