icann-dns / puppet-ditl

module to manage ditl uploads

ditl

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 ditl
   • What ditl affects
   • Setup requirements
   • Beginning with ditl
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
   • Classes
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

This module installs ditl and can also manage the custom scripts, host script and custom modules directories

Setup

What ditl affects

• installs ssh key to the root user
• install a bash script to upload pcaps
• install a cron job to upload pcaps

Setup Requirements

• puppetlabs-stdlib 4.12.0
• icann-tea 0.2.4

Beginning with ditl

just add the ditl class and pass the two mandatory parameters upload_key_source and upload_user

class {'::ditl' 
  upload_key_source => 'puppet:///modules/module_files/upload_key_rsa',
  upload_user       => 'ditl-user',
}

Usage

Update pattern

DITL will normaly have a start and stop time, we use the pattern barameter to bass a bash glob matching the pattern for the period. for instance if the period starts on 2016-05-03 and ends 2016-05-06 then we would have the following

class {'::ditl' 
  upload_key_source => 'puppet:///modules/module_files/upload_key_rsa',
  upload_user       => 'ditl-user',
  pattern           => '2016050{3..8}*.{bz2,xz}'
}

of with hiera

ditl::upload_key_source: 'puppet:///modules/module_files/upload_key_rsa',
ditl::upload_user: 'ditl-user',
ditl::pattern: '2016050{3..8}*.{bz2,xz}'

Reference

Classes

Public Classes

• ditl

Private Classes

• ditl::params

Class: ditl

Main class, includes all other classes

Parameters

• upload_key_source (Tea::Puppetsource, Default: undef): This is a string which will be passed the file type source paramter to be treated as a ssh private key to use for uploads top ditl
• upload_user (String, Default: undef): The remote username to use for uploads
• enabled (Boolean Default: true): Whether to enable this module
• pcap_dir (Tea::Absolutepath, Default: '/opt/pcap'): The location of pcap files toupload
• upload_host (Tea::Fqdn, Default: capture.ditl.dns-oarc.net): The host to upload DITL data to
• upload_key_file (Tea::Absolutepath, Default: /root/.ssh/oarc_id_dsa): The location to stor the rsa private key
• clean_known_hosts (Boolean Default: false): WARNING changing this value is a security risk effectivly meaning that the upload script will trust any host fingerprint its given and therefore open to MITM attacks. Only change this value if you know what you are doing

Limitations

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