cookbook 'arcgis-geoevent', '= 4.2.0'
arcgis-geoevent (14) Versions 4.2.0 Follow2
Installs and configures ArcGIS GeoEvent Server
cookbook 'arcgis-geoevent', '= 4.2.0', :supermarket
knife supermarket install arcgis-geoevent
knife supermarket download arcgis-geoevent
layout: default
title: "arcgis-geoevent cookbook"
category: cookbooks
item: arcgis-geoevent
version: 4.2.0
latest: true
arcgis-geoevent cookbook
This cookbook installs and configures ArcGIS GeoEvent Server.
Supported ArcGIS versions
- 10.8
- 10.8.1
- 10.9
- 10.9.1
- 11.0
- 11.1
- 11.2
Supported ArcGIS software
- ArcGIS GeoEvent Server
Platforms
- Windows 8 (8.1)
- Windows 10
- Windows Server 2012 (R2)
- Windows Server 2016
- Windows Server 2019
- Windows Server 2022
- Ubuntu Server 18.04 and 20.04 LTS
- Red Hat Enterprise Linux Server 8
- SUSE Linux Enterprise Server 15
- Oracle Linux 8
Dependencies
The following cookbooks are required:
- arcgis-enterprise
- arcgis-repository
Attributes
-
node['arcgis']['geoevent']['authorization_file']
= ArcGIS GeoEvent Server authorization file path. -
node['arcgis']['geoevent']['authorization_file_version']
= ArcGIS GeoEvent Server authorization file version. Default value isnode['arcgis']['server']['authorization_file_version']
. -
node['arcgis']['geoevent']['setup_archive']
= Path to the ArcGIS GeoEvent Server setup archive. Default value depends onnode['arcgis']['version']
attribute value. -
node['arcgis']['geoevent']['setup']
= The location of the ArcGIS GeoEvent Server setup executable. Default location is%USERPROFILE%\Documents\ArcGIS11.2\ArcGISGeoEventServer\Setup.exe
on Windows and/opt/arcgis/11.2/geoevent/Setup.sh
on Linux. -
node['arcgis']['geoevent']['setup_options']
= Additional ArcGIS GeoEvent Server setup command line options. Default options are''
. -
node['arcgis']['geoevent']['configure_autostart']
= If set to true, on Linux the GeoEvent Server is configured to start with the operating system. Default value istrue
. -
node['arcgis']['geoevent']['ports']
= Ports to open for GeoEvent. Default depends onnode['arcgis']['version']
. -
node['arcgis']['geoevent']['patches]
= File names of ArcGIS GeoEvent Server patches to install. Default value is[]
.
Recipes
admin_reset
Administratively resets GeoEvent Server.
Deletes the Apache ZooKeeper files (to administratively clear the GeoEvent Server configuration), the product’s runtime files (to force the system framework to be rebuilt), and removes previously received event messages (by deleting Kafka topic queues from disk). This is how system administrators reset a GeoEvent Server instance to look like the product has just been installed.
If you have custom components in the C:\Program Files\ArcGIS\Server\GeoEvent\deploy folder, move these from the \deploy folder to a local temporary folder, while GeoEvent Server is running, to prevent the component from being restored (from the distributed configuration store) when GeoEvent Server is restarted. Also, make sure you have a copy of the most recent XML export of your GeoEvent Server configuration if you want to save the elements you have created.
Attributes used by the recipe:
{ "arcgis": { "version": "11.2", "run_as_user": "arcgis", "server": { "install_dir": "C:\\Program Files\\ArcGIS\\Server" } }, "run_list": [ "recipe[arcgis-geoevent::admin_reset]" ] }
default
Installs and configures ArcGIS GeoEvent Server.
Attributes used by the recipe:
{ "arcgis": { "version": "11.2", "run_as_user": "arcgis", "run_as_password": "<password>", "server": { "install_dir": "C:\\Program Files\\ArcGIS", }, "geoevent": { "setup": "C:\\ArcGIS\\11.2\\GeoEvent\\Setup.exe", "authorization_file": "C:\\ArcGIS\\11.2\\Authorization_Files\\GeoEvent.prvc", "authorization_file_version": "11.2" } }, "run_list": [ "recipe[arcgis-geoevent]" ] }
install_patches
Installs patches for ArcGIS GeoEvent Server. The recipe installs patches from the patches folder specified by the arcgis.geoevent.patches attribute. The patch names may contain a wildcard '*'. For example, "GeoEvent_10_9_1_*.msp" specifies all .msp patches that start with "GeoEvent_10_9_1_".
Attributes used by the recipe:
{ "arcgis" : { "repository" : { "patches" : "%USERPROFILE%\\Software\\Esri\\patches" }, "geoevent": { "patches": ["patch1.msp", "patch2.msp"] } }, "run_list": [ "recipe[arcgis-geoevent::install_patches]" ] }
lp-install
Installs the language pack for ArcGIS GeoEvent Server.
Attributes used by the recipe:
{ "arcgis": { "version": "11.2", "geoevent": { "lp-setup": "C:\\ArcGIS\\11.2\\GeoEvent\\Japanese\\Setup.exe" } }, "run_list":[ "recipe[arcgis-geoevent::lp-install]" ] }
uninstall
Uninstalls ArcGIS GeoEvent Server.
Attributes used by the recipe:
{ "arcgis": { "version": "11.2", "run_as_user": "arcgis", "server": { "install_dir": "C:\\Program Files\\ArcGIS" } }, "run_list":[ "recipe[arcgis-geoevent::uninstall]" ] }
The arcgis.run_as_user and install_dir attributes are ignored on Windows.
Dependent cookbooks
arcgis-enterprise ~> 4.2 |
arcgis-repository ~> 4.2 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
4.2.0 passed this metric
Contributing File Metric
4.2.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
Cookstyle Metric
4.2.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): arcgis-geoevent/resources/geoevent.rb: 1
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): arcgis-geoevent/providers/geoevent.rb: 20
Chef/Modernize/DefaultActionFromInitialize: The default action of a resource can be set with the "default_action" helper instead of using the initialize method. (https://docs.chef.io/workstation/cookstyle/chef_modernize_defaultactionfrominitialize): arcgis-geoevent/resources/geoevent.rb: 37
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 8
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 28
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 29
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 306
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 328
Chef/RedundantCode/LongDescriptionMetadata: The long_description metadata.rb method is not used and is unnecessary in cookbooks. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_longdescriptionmetadata): arcgis-geoevent/metadata.rb: 6
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 20
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 21
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 22
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 23
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 24
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 25
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 26
Chef/Sharing/InvalidLicenseString: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers. (https://docs.chef.io/workstation/cookstyle/chef_sharing_invalidlicensestring): arcgis-geoevent/metadata.rb: 4
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
4.2.0 passed this metric
Testing File Metric
4.2.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
4.2.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 include a tag that matches this cookbook version number
4.2.0 passed this metric
4.2.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
Cookstyle Metric
4.2.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): arcgis-geoevent/resources/geoevent.rb: 1
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): arcgis-geoevent/providers/geoevent.rb: 20
Chef/Modernize/DefaultActionFromInitialize: The default action of a resource can be set with the "default_action" helper instead of using the initialize method. (https://docs.chef.io/workstation/cookstyle/chef_modernize_defaultactionfrominitialize): arcgis-geoevent/resources/geoevent.rb: 37
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 8
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 28
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 29
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 306
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 328
Chef/RedundantCode/LongDescriptionMetadata: The long_description metadata.rb method is not used and is unnecessary in cookbooks. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_longdescriptionmetadata): arcgis-geoevent/metadata.rb: 6
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 20
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 21
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 22
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 23
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 24
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 25
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 26
Chef/Sharing/InvalidLicenseString: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers. (https://docs.chef.io/workstation/cookstyle/chef_sharing_invalidlicensestring): arcgis-geoevent/metadata.rb: 4
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
4.2.0 passed this metric
Testing File Metric
4.2.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
4.2.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 include a tag that matches this cookbook version number
4.2.0 failed this metric
Chef/Deprecations/UseInlineResourcesDefined: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_useinlineresourcesdefined): arcgis-geoevent/providers/geoevent.rb: 20
Chef/Modernize/DefaultActionFromInitialize: The default action of a resource can be set with the "default_action" helper instead of using the initialize method. (https://docs.chef.io/workstation/cookstyle/chef_modernize_defaultactionfrominitialize): arcgis-geoevent/resources/geoevent.rb: 37
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 8
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 28
Chef/Modernize/RespondToInMetadata: It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later (https://docs.chef.io/workstation/cookstyle/chef_modernize_respondtoinmetadata): arcgis-geoevent/metadata.rb: 29
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 306
Chef/Modernize/UseChefLanguageSystemdHelper: Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd. (https://docs.chef.io/workstation/cookstyle/chef_modernize_usecheflanguagesystemdhelper): arcgis-geoevent/providers/geoevent.rb: 328
Chef/RedundantCode/LongDescriptionMetadata: The long_description metadata.rb method is not used and is unnecessary in cookbooks. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_longdescriptionmetadata): arcgis-geoevent/metadata.rb: 6
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 20
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 21
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 22
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 23
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 24
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 25
Chef/RedundantCode/RecipeMetadata: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead. (https://docs.chef.io/workstation/cookstyle/chef_redundantcode_recipemetadata): arcgis-geoevent/metadata.rb: 26
Chef/Sharing/InvalidLicenseString: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers. (https://docs.chef.io/workstation/cookstyle/chef_sharing_invalidlicensestring): arcgis-geoevent/metadata.rb: 4
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
4.2.0 passed this metric
Testing File Metric
4.2.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
4.2.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 include a tag that matches this cookbook version number
4.2.0 failed this metric
4.2.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 include a tag that matches this cookbook version number