Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

RSS

arcgis-desktop (10) Versions 4.0.0

Installs and configures ArcGIS Desktop and ArcGIS License Manager

Policyfile
Berkshelf
Knife
cookbook 'arcgis-desktop', '~> 4.0.0', :supermarket
cookbook 'arcgis-desktop', '~> 4.0.0'
knife supermarket install arcgis-desktop
knife supermarket download arcgis-desktop
README
Dependencies
Changelog
Quality 33%

layout: default
title: "arcgis-desktop cookbook"
category: cookbooks
item: arcgis-desktop
version: 4.0.0

latest: true

arcgis-desktop cookbook

This cookbook installs and configures ArcGIS Desktop and ArcGIS License Manager.

Supported ArcGIS software

  • ArcGIS Desktop (Windows only)

    • 10.4
    • 10.4.1
    • 10.5
    • 10.5.1
    • 10.6
    • 10.6.1
    • 10.7
    • 10.7.1
    • 10.8
    • 10.8.1
    • 10.8.2
  • ArcGIS License Manager

    • 2018.0
    • 2018.1
    • 2019.0
    • 2019.1
    • 2019.2
    • 2020.0
    • 2020.1
    • 2021.0
    • 2021.1
    • 2022.0

Platforms

  • Windows 10
  • Windows Server 2012 (R2)
  • Windows Server 2016
  • Windows Server 2019
  • Windows Server 2022
  • Ubuntu 16.04, 18.04
  • Rhel 6.5, 7.0

ArcGIS Desktop is supported only on Windows platforms.

Dependencies

The following cookbooks are required:

  • windows
  • arcgis-repository

Attributes

  • node['arcgis']['version'] = ArcGIS Desktop version. Default value is 10.8.1.
  • node['arcgis']['desktop']['setup_archive'] = The location of ArcGIS Desktop setup archive. Default value depends on node['arcgis']['version'] attribute value.
  • node['arcgis']['desktop']['setup'] = The location of ArcGIS Desktop setup executable. Default location is %USERPROFILE%\Documents\ArcGIS10.8.1\Desktop\Setup.exe.
  • node['arcgis']['desktop']['lp-setup'] = The location of language pack for ArcGIS Desktop. Default location is C:\ArcGIS\DesktopLP\SetupFiles\setup.msi.
  • node['arcgis']['desktop']['install_dir'] = ArcGIS Desktop installation directory. By default, ArcGIS Desktop is installed to %ProgramFiles(x86)%\ArcGIS.
  • node['arcgis']['desktop']['install_features'] = Comma-separated list of ArcGIS Desktop features to install. Default value is ALL.
  • node['arcgis']['desktop']['authorization_file'] = ArcGIS Desktop authorization file path. Default location and file name are C:\\Temp\\license.prvc.
  • node['arcgis']['desktop']['authorization_file_version'] = ArcGIS Desktop authorization file version. Default value is 10.8.
  • node['arcgis']['desktop']['esri_license_host'] = Hostname of ArcGIS License Manager. Default hostname is %COMPUTERNAME%.
  • node['arcgis']['desktop']['software_class'] = ArcGIS Desktop software class <Viewer|Editor|Professional>. Default value is Viewer.
  • node['arcgis']['desktop']['seat_preference'] = ArcGIS Desktop license seat preference <Fixed|Float>. Default value is Fixed.
  • node['arcgis']['licensemanager']['version'] = ArcGIS License Manager version. Default value is 2022.0.
  • node['arcgis']['licensemanager']['setup_archive'] = The location of ArcGIS License Manager setup archive. Default value depends on node['arcgis']['version'] attribute value.
  • node['arcgis']['licensemanager']['setup'] = The location of ArcGIS License Manager setup executable. Default location is %USERPROFILE%\Documents\ArcGIS License Manager 2022.0\LicenseManager\Setup.exe on Windows, and /opt/arcgis/2022.0/LicenseManager_Linux/Setup on Linux.
  • node['arcgis']['licensemanager']['lp-setup'] = The location of language pack for ArcGIS License Manager. Default location is C:\ArcGIS\LicenseManager\SetupFiles\setup.msi.
  • node['arcgis']['licensemanager']['install_dir'] = ArcGIS License Manager installation directory. By default, the license manager is installed to %ProgramFiles(x86)%\ArcGIS on Windows and / on Linux.

Recipes

default

Installs and configures ArcGIS Desktop.

Attributes used by the recipe:

{
  "arcgis": {
    "version": "10.8.2",
    "desktop": {
      "setup": "C:\\ArcGIS\\10.8.2\\Desktop\\Setup.exe",
      "install_dir": "C:\\Program Files (x86)\\ArcGIS",
      "authorization_file": "C:\\ArcGIS\\10.8\\Authorization_Files\\DTBasic.prvc",
      "authorization_file_version": "10.8",
      "install_features": "ALL",
      "software_class": "Viewer",
      "seat_preference": "Fixed",
      "desktop_config": true,
      "modifyflexdacl": false
    },
    "python": {
      "install_dir": "C:\\Python27"
    }
  },
  "run_list":[
    "recipe[arcgis-desktop]"
  ]
}

Software authorization for ArcGIS Desktop is only supported by the cookbook when the "seat_preference" attribute value is "Fixed".

Chef cookbook ms_dotnet could be used to install the .Net Framework version required by ArcGIS for Desktop.

For example:

{
  "ms_dotnet" : {
    "v4" : {
      "version" : "4.5.1"
    }
  },
  "run_list":[
    "recipe[ms_dotnet::ms_dotnet4]"
  ]
}

licensemanager

Installs and configures ArcGIS License Manager.

Attributes used by the recipe:

{
  "arcgis": {
    "run_as_user": "arcgis",
    "repository": {
       "archives": "C:\\Software\\Esri",
       "setups": "C:\\Software\\Setups" 
    },
    "licensemanager": {
      "version": "2022.0",
      "setup": "C:\\Software\\Setups\\License Manager 2022.0\\LicenseManager\\Setup.exe",
      "install_dir": "C:\\Program Files (x86)\\ArcGIS"
    }
  },
  "run_list":[
    "recipe[arcgis-desktop::licensemanager]"
  ]
}

:grey_exclamation: run_as_user attribute is ignored on Windows.

lp-install

Installs and configures language packs for ArcGIS Desktop and ArcGIS License Manager.

Attributes used by the recipe:
JSON
{
"arcgis": {
"version": "10.8.2",
"desktop": {
"lp-setup": "C:\\ArcGIS\\10.8.2\\Desktop\\Japanese\\Setup.exe"
},
"licensemanager": {
"lp-setup": "C:\\ArcGIS\\10.8.2\\LicenseManager\\Japanese\\Setup.exe"
}
},
"run_list":[
"recipe[arcgis-desktop::lp-install]"
]
}

:exclamation: Currently lp-install recipe is supported on Windows only.

uninstall

Uninstalls ArcGIS Desktop and ArcGIS License Manager of the specified ArcGIS version.

Attributes used by the recipe:

{
  "arcgis": {
    "version": "10.8.2",
    "run_as_user": "arcgis",
    "desktop": {
      "install_dir": "C:\\Program Files (x86)\\ArcGIS"
    },
    "licensemanager": {
      "install_dir": "C:\\Program Files (x86)\\ArcGIS"
    }
  },
  "run_list":[
    "recipe[arcgis-desktop::uninstall]"
  ]
}

The arcgis.run_as_user attribute is ignored on Windows.

Dependent cookbooks

arcgis-repository ~> 4.0
windows ~> 5.3
limits ~> 1.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

arcgis-desktop cookbook CHANGELOG

This file is used to list changes made in each version of the arcgis-desktop cookbook.

4.0.0

  • Added support for ArcGIS License Manager 2022.0

3.8.0

  • Added support for ArcGIS Desktop 10.8.2 and ArcGIS License Manager 2021.0/2021.1

3.7.0

  • Added support for ArcGIS License Manager 2020.1

3.6.1

  • Added support for Chef Client 15.

3.6.0

  • Added support for ArcGIS Desktop 10.8.1 and ArcGIS License Manager 2020.0.
  • Fixed software authorization issues with single use ArcGIS Desktop licenses.

3.5.0

  • Added support for ArcGIS 10.8.

3.4.0

  • Added support for ArcGIS 10.7.1.
  • Updated and locked versions of depenent cookbooks.

3.3.0

  • Added support for ArcGIS 10.7.
  • Added dependency on arcgis-repository cookbook to support global ArcGIS software repository in S3.

3.2.1

  • Added support for ArcGIS 10.6.1.
  • Add ec2 test kitchen
  • Split attributes into multiples files.
  • Update default attributes of desktop and licensemanager setups.
  • Remove unnecessary attributes.

3.2.0

  • Added support for ArcGIS 10.6.

3.1.0

  • Added support for ArcGIS 10.5.1.

3.0.0

  • Updated ArcGIS product names

2.3.1

  • Added support for ArcGIS 10.5.

2.3.0

  • Added support for ArcGIS 10.5 Beta.
  • Split from arcgis 2.2.1 cookbook.

Collaborator Number Metric
            

4.0.0 passed this metric

Contributing File Metric
            

4.0.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.0.0 failed this metric

Chef/Correctness/MetadataMissingVersion: metadata.rb should define a version for the cookbook. (https://docs.chef.io/workstation/cookstyle/chef_correctness_metadatamissingversion): arcgis-desktop/test/fixtures/cookbooks/download-setups-s3/metadata.rb: 1
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-desktop/resources/desktop.rb: 1
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-desktop/resources/licensemanager.rb: 1
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-desktop/resources/user.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-desktop/providers/desktop.rb: 19
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-desktop/providers/licensemanager.rb: 19
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-desktop/providers/user.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-desktop/resources/desktop.rb: 39
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-desktop/resources/licensemanager.rb: 31
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-desktop/resources/user.rb: 24
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-desktop/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-desktop/metadata.rb: 22
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-desktop/metadata.rb: 23
Chef/Modernize/SevenZipArchiveResource: Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive (https://docs.chef.io/workstation/cookstyle/chef_modernize_sevenziparchiveresource): arcgis-desktop/test/fixtures/cookbooks/download-setups-s3/recipes/auth_files.rb: 23
Chef/Modernize/SevenZipArchiveResource: Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive (https://docs.chef.io/workstation/cookstyle/chef_modernize_sevenziparchiveresource): arcgis-desktop/test/fixtures/cookbooks/download-setups-s3/recipes/desktop.rb: 15
Chef/Modernize/SevenZipArchiveResource: Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive (https://docs.chef.io/workstation/cookstyle/chef_modernize_sevenziparchiveresource): arcgis-desktop/test/fixtures/cookbooks/download-setups-s3/recipes/licensemanager.rb: 15
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-desktop/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-desktop/metadata.rb: 17
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-desktop/metadata.rb: 18
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-desktop/metadata.rb: 19
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-desktop/metadata.rb: 20
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-desktop/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.0.0 passed this metric

Testing File Metric
            

4.0.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.0.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