Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCUMENT-856

Usage warning should be included re: recurse parameter for file type

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved
    • Normal
    • Resolution: Fixed
    • None
    • Needs Assessment

    Description

      The Puppet file type (https://puppet.com/docs/puppet/5.5/types/file.html) offers a 'recurse' parameter which allows all the sub-directories and files to be managed as well. This is sometimes used to recursively manage large number of files to set / change permissions, etc. Depending on the size of the directories, this can have serious performance implications and should be noted as such in the documentation to help avoid encountering performance issues with heavy usage of the recurse parameter. 

      Maybe something like:

      Please be advised that using the recurse parameter is designed to manage single or a small number of targeted files. Enabling the recurse parameter on directories containing large amounts of files will have an impact on the performance of each agent run. If you need to manage file attributes for a large amount of files, please consider using alternative methods such as the chmod_r, chown_r or recursive_file_permissions module(s) on the Forge. 

      Attachments

        Issue Links

          Activity

            People

              jean Jean Bond
              joel.weierman Joel Weierman
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Zendesk Support