Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

dirtree

The dirtree function builds an array of directories from a full directory path or an array of full directory paths. The array can then be used to ensure all the required directories in a path are managed by puppet.
Project URLRSS FeedReport issues

836,724 downloads

835,518 latest version

3.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.1
released Oct 11th 2013

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'AlexCline-dirtree', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add AlexCline-dirtree
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install AlexCline-dirtree --version 0.2.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: windows, directory, linux, resource, dependency, tree

Documentation

AlexCline/dirtree — version 0.2.1 Oct 11th 2013

dirtree

This module provides the dirtree function.

The dirtree function accepts a string containing an absolute directory path and will return an array of the tree containing all the directories of that path.

The first parameter can also be an array of absolute directory paths, which will be transformed into an array of all trees containing all directories in the paths.

An optional second parameter can be supplied that contains a path to exclude from the resulting array.

Best efforts have been made to make this function compatible with both Windows and Linux systems.

Examples

dirtree('/usr/share/puppet')
Will return: ['/usr', '/usr/share', '/usr/share/puppet']

dirtree('C:\\windows\\system32\\drivers')
Will return: ["C:\\windows", "C:\\windows\\system32", "C:\\windows\\system32\\drivers"]

dirtree(['/usr/share/puppet', '/var/lib/puppet/ssl', '/var/lib/puppet/modules'])
Will return: ['/usr', '/usr/share', '/usr/share/puppet',
              '/var', '/var/lib', '/var/lib/puppet', '/var/lib/puppet/ssl',
              '/var/lib/puppet/modules']

dirtree('/usr/share/puppet', '/usr')
Will return: ['/usr/share', '/usr/share/puppet']

dirtree('C:\\windows\\system32\\drivers', 'C:\\windows')
Will return: ['C:\\windows\\system32', 'C:\\windows\\system32\\drivers']

You can use the dirtree function in a class to enumerate all required directories if needed.

class dirtree {
  # rubysitedir = /usr/lib/ruby/site_ruby/1.8
  $dirtree = dirtree("/var/lib/puppet/ssl", '/var/lib')

  # $dirtree = ['/usr/lib/puppet', '/var/lib/puppet/ssl']
  ensure_resource('file', $dirtree, {'ensure' => 'directory'})
}

With the puppetlabs-stdlib 1.4.0 module, the ensure_resource function accepts an array, which will create new resources with the names specified if they don't already exist.

Changes

dirtree v0.2.1

  • Added the ability to pass an array of paths. Thanks to Ben Ford

dirtree v0.2.0

  • Added optional second parameter specifying portion of the path to exclude.

Support

Please file tickets and issues using GitHub Issues

License

Copyright 2013 Alex Cline alex.cline@gmail.com

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.