data_fragments

Construct data files from multiple fragments.

Project URL RSS Feed Report issues

Module Stats

45,215 downloads

45,215 latest version

4.3 quality score

Version information

released Jul 19th 2017

This version is compatible with:

Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 4.7.0 < 5.0.0
, , , , , , , , , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'WhatsARanjit-data_fragments', '0.1.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add WhatsARanjit-data_fragments

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install WhatsARanjit-data_fragments --version 0.1.0

Documentation

WhatsARanjit/data_fragments — version 0.1.0 Jul 19th 2017

data_fragments

Overview
Easy example
Usage
Types

Overview

The data_fragments module lets you construct data files from multiple ordered fragments of data

Easy example

To start using data_fragments you need to create:

A data_file resource for the final file.
One or more data_fragments.

A minimal example might be:

data_file { '/tmp/file':
  ensure => present,
  tag    => 'demo',
}

data_fragment { 'tmpfile':
  target  => '/tmp/file',
  content => 'test contents',
  order   => '01'
  tag     => 'demo',
}

Usage

Check the examples directory for example uses of json, json-pretty, and yaml.

Types

Type: `data_file`

`backup`

Data type: String, Boolean.

Specifies whether (and how) to back up the destination file before overwriting it. Your value gets passed on to Puppet's native file resource for execution. Valid options: true, false, or a string representing either a target filebucket or a filename extension beginning with ".".

Default value: 'puppet'.

`ensure`

Data type: String.

Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and negates the effect of any other parameters. Valid options: 'present' and 'absent'.

Default value: 'present'.

`ensure_newline`

Data type: Boolean.

Specifies whether to add a line break at the end of each fragment that doesn't already end in one. Valid options: true and false.

Default value: false.

`group`

Data type: String, Integer.

Specifies a permissions group for the destination file. Valid options: a string containing a group name.

Default value: undef.

`mode`

Data type: String.

Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation.

Default value: '0644'.

`order`

Data type: String.

Specifies a method for sorting your fragments by name within the destination file. Valid options: 'alpha' (e.g., '1, 10, 2') or 'numeric' (e.g., '1, 2, 10').

You can override this setting for individual fragments by adjusting the order parameter in their data_fragment declarations.

Default value: 'numeric'.

`owner`

Data type: String, Integer.

Specifies the owner of the destination file. Valid options: a string containing a username.

Default value: undef.

`path`

Data type: String.

Specifies a destination file for the combined fragments. Valid options: a string containing an absolute path. Default value: the title of your declared resource.

Default value: namevar.

`replace`

Data type: Boolean.

Specifies whether to overwrite the destination file if it already exists. Valid options: true and false.

Default value: true.

`tag`

Data type: String.

Required. Specifies a unique tag reference to collect all data_fragments with the same tag.

`validate_cmd`

Data type: String

Specifies a validation command to apply to the destination file. Requires Puppet version 3.5 or newer. Valid options: a string to be passed to a file resource.

Default value: undef.

`format`

Data type: String

Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-pretty'.

Default value: plain.

`force`

Data type: Boolean

Specifies whether to merge data structures, keeping the values with higher order. Valid options: true and false.

Default value: false.

Type: `data_fragment`

`content`

Data type: String.

Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter. Valid options: a string.

Default value: undef.

`order`

Data type: String, Integer.

Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. Valid options: a string (recommended) or an integer.

Default value: '10'.

`source`

Data type: String.

Specifies a file to read into the content of the fragment. Note: You must supply either a content parameter or a source parameter. Valid options: a string or an array, containing one or more Puppet URLs.

Default value: undef.

`tag`

Data type: String.

Required. Specifies a unique tag to be used by data_file to reference and collect content.

`target`

Data type: String.

Required. Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent data_file resource.

Types in this module release

data_file

Gets all the file fragments and puts these into the target file. This will mostly be used with exported resources.

example:
  Data_fragment <<| tag == 'unique_tag' |>>

  data_file { '/tmp/file':
    tag            => 'unique_tag', # Mandatory
    path           => '/tmp/file',  # Optional. If given it overrides the resource name
    owner          => 'root',       # Optional. Default to undef
    group          => 'root',       # Optional. Default to undef
    mode           => '0644'        # Optional. Default to undef
    order          => 'numeric'     # Optional, Default to 'numeric'
    ensure_newline => false         # Optional, Defaults to false
  }

Parameters
backup	Controls the filebucketing behavior of the final file and see File type reference for its use.
ensure
ensure_newline	Whether to ensure there is a newline after each fragment.
force	Forcibly merge duplicate keys keeping values of the highest order.
format	What data type to merge the fragments as.
group	Desired file group.
mode	Desired file mode.
order	Controls the ordering of fragments. Can be set to alpha or numeric.
owner	Desired file owner.
path	The output file
replace	Whether to replace a file that already exists on the local system.
selinux_ignore_defaults
selrange
selrole
seltype
seluser
show_diff
tag	Tag reference to collect all data_fragment's with the same tag
validate_cmd	Validates file.

data_fragment

Create a data_fragment to be used by a data_file. the data_fragment type creates a file fragment to be collected based on the tag. The example is based on exported resources.

Example:
@@data_fragment { "uniqe_name_${::fqdn}":
  tag => 'unique_name',
  order => 10, # Optional. Default to 10
  content => 'some content' # OR
  content => template('template.erb') # OR
  source  => 'puppet:///path/to/file'
}

Parameters
content	Content
name	Unique name
order	Order
source	Source
tag	Tag name to be used by data_file to collect all data_fragments by tag name
target	Target


                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   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.

Modules

Discover

Contribute

Resources

About Forge

Getting Started

data_fragments

Version information

This version is compatible with:

Start using this module

Documentation

data_fragments

Table of Contents

Overview

Easy example

Usage

Types

Type: data_file

backup

ensure

ensure_newline

group

mode

order

owner

path

replace

tag

validate_cmd

format

force

Type: data_fragment

content

order

source

tag

target

Types in this module release

data_file

data_fragment

Dependencies

Type: `data_file`

`backup`

`ensure`

`ensure_newline`

`group`

`mode`

`order`

`owner`

`path`

`replace`

`tag`

`validate_cmd`

`format`

`force`

Type: `data_fragment`

`content`

`order`

`source`

`tag`

`target`