Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

file_upload

small modules to install file_upload and custom modules
Project URLRSS FeedReport issues

47,756 downloads

45,918 latest version

4.6 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.1.2 (latest)
  • 0.1.0
released Jan 30th 2018
This version is compatible with:
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'icann-file_upload', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add icann-file_upload
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install icann-file_upload --version 0.1.2

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

Documentation

icann/file_upload — version 0.1.2 Jan 30th 2018

Build Status Puppet Forge Puppet Forge Downloads

file_upload

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with file_upload
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module installs provides mnages cron jobs to copy files to an ofline location

Setup

What file_upload affects

  • installs an upload script
  • manages cron jobs to upload files

Setup Requirements

  • puppetlabs-stdlib 4.12.0
  • icann-tea 0.2.4
  • icann-logrotate v1.4.0-ICANN-1

Beginning with file_upload

just add the file_upload class. This just installes the script required by file_upload::upload

class {'::file_upload' }

Usage

Add an upload job

You can pass URI's which will be handed to puppet and passed to a file type source parameter.

class {'::file_upload' 
  uploads => { 
    'test' => {
      destination_host => 'upload.example.com',
      destination_path => '/srv/upload',
      ssh_key_source   => 'puppet:///modules/module_files/id_rsa',
      ssh_user         => 'upload',

    }
  }
}

of with hiera

file_upload::uploads:
  test:
    destination_host: 'upload.example.com'
    destination_path: '/srv/upload'
    ssh_key_source: 'puppet:///modules/module_files/id_rsa'
    ssh_user: upload

Reference

Classes

Public Classes

Private Classes

Class: file_upload

Main class, includes all other classes

Parameters
  • upload_script (Tea::Puppetsource, Default: '/usr/local/bin/file_upload.sh'): Where to install the upload script
  • modules (Hash[file_upload::upload], Default: {}): A Hash of file_upload::upload objects to be passtd to create_resources()

Defines

Define: file_upload::upload

Used to create upload jobs

Parameters
  • ensure (Enum['present', 'absent'], Default: present): Enable or disable this upload task
  • key_dir (Tea::Absolutepath, Default: '/root/.ssh'): Where to stor the ssh key used for updates
  • clean_know_hosts (Boolean, Default: false): whether to remove entries from the know hosts entry. WARNING enableing this function makes uploads open to MITM attacks
  • delete (Boolean, Default: false): delete extraneous files from dest dirs
  • remove_source_files (Boolean, Default: false): This tells rsync to remove from the sending side the files (meaning non-directories) that are a part of the transfer and have been successfully duplicated on the receiving side.
  • patters (Array[String], Default: ['.pcap.bz2', '.pcap.xz']): Array of bash globs used to recursevly search the source folder for files to sync
  • bwlimit (Integer[0,10000], Default: 100): bandwith in kbps to limit the transfer to transfer
  • destination_host (Variant[Tea::Fqdn, Tea::Ip_address]: The host to send the files to
  • destination_path (Tea::Absolutepath): The destination path to send files to
  • ssh_key_source (Tea::Puppetsource): This will be bassed to a file type and used as the source attribute for the ssh key to use for transfers
  • ssh_user (String): The user to use to set oup an ssh connection to the destination host
  • log_file (Tea::Absolutepath, Default: "/var/log/file_upload-${name}.log"): location of the logfile
  • logrotate_enable (Boolean, Default: true): whether to enable logrotate
  • logrotate_rotate (Integer[1,100], Default: 5): maximum amount of rotated files to keep
  • location_size (Strind, Default: 100M): Rotate the log files when it reaches this size
  • data (Tea::Absolutepath, Default: '/opt/pcap'): the source directory to copy files from

Limitations

This module is tested on Ubuntu 12.04, and 14.04 and FreeBSD 10