Skip to content
This repository was archived by the owner on Oct 1, 2020. It is now read-only.

Commit a9ca3fb

Browse files
GregSutcliffeGregSutcliffe
committed
Add dirvish module
1 parent 7b7ed01 commit a9ca3fb

File tree

15 files changed

+352
-0
lines changed

15 files changed

+352
-0
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.swp

‎modules/dirvish/Modulefile

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name 'gwmngilfen-dirvish'
2+
version '0.0.1'
3+
source 'UNKNOWN'
4+
author 'gwmngilfen'
5+
license 'Apache License, Version 2.0'
6+
summary 'UNKNOWN'
7+
description 'UNKNOWN'
8+
project_page 'UNKNOWN'
9+
10+
## Add dependencies, if any:
11+
dependency 'puppetlasbs/stdlib'

‎modules/dirvish/README

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
dirvish
2+
3+
Module for creating and managing a backup solution using Dirvish
4+
5+
Dependencies
6+
------------
7+
8+
* puppetlabs-stdlib
9+
10+
Parameters
11+
----------
12+
13+
[*backup_location*]
14+
The core path that the backups should live in. Defaults to "/srv/backups". The
15+
parent of this path should exist, or Puppet will be unable to create the dir.
16+
17+
Examples
18+
--------
19+
20+
class { dirvish:
21+
backup_location => '/backups'
22+
}
23+
24+
Copyright
25+
---------
26+
27+
Copyright 2013 Greg Sutcliffe
28+
29+
License
30+
-------
31+
32+
GPL3
33+
34+
Contact
35+
-------
36+
37+
Greg Sutcliffe <[email protected]>
38+
39+
Support
40+
-------
41+
42+
Please log tickets and issues at my [github page](https://github/GregSutcliffe/puppet-dirvish)

‎modules/dirvish/lib/puppet/parser/functions/ssh_keygen.rb

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Forked from https://github.com/fup/puppet-ssh @ 59684a8ae174
2+
#
3+
# Arguments
4+
# 0: The keyname (e.g. id_rsa)
5+
# 1: (optional) the keytype to read (public or private)
6+
#
7+
module Puppet::Parser::Functions
8+
newfunction(:ssh_keygen, :type => :rvalue) do |args|
9+
args[1].nil? ? request = :public : request = args[1].to_sym
10+
11+
config = {
12+
:ssh_dir => 'ssh',
13+
:ssh_comment => args[0].chomp,
14+
:ssh_key_type => 'rsa',
15+
16+
}
17+
18+
File.directory?('/etc/puppetlabs/puppet') ? config[:basedir] = '/etc/puppetlabs/puppet' : config[:basedir] = '/etc/puppet'
19+
20+
# Error Handling
21+
unless args.length >= 1 then
22+
raise Puppet::ParseError, "ssh_keygen(): wrong number of arguments (#{args.length}; must be > 1)"
23+
end
24+
25+
unless (request == :public || request == :private) then
26+
raise Puppet::ParseError, "ssh_keygen(): invalid key type (#{request}; must be 'public' or 'private')"
27+
end
28+
29+
# Make sure to write out a directory to init if necessary
30+
begin
31+
if !File.directory?("#{config[:basedir]}/#{config[:ssh_dir]}")
32+
Dir::mkdir("#{config[:basedir]}/#{config[:ssh_dir]}")
33+
end
34+
rescue => e
35+
raise Puppet::ParseError, "ssh_keygen(): Unable to setup ssh keystore directory (#{e})"
36+
end
37+
38+
# Do my keys exist? Well, keygen if they don't!
39+
begin
40+
unless File.exists?("#{config[:basedir]}/#{config[:ssh_dir]}/#{config[:ssh_comment]}") then
41+
%x[/usr/bin/ssh-keygen -t #{config[:ssh_key_type]} -P '' -f #{config[:basedir]}/#{config[:ssh_dir]}/#{config[:ssh_comment]}]
42+
end
43+
rescue => e
44+
raise Puppet::ParseError, "ssh_keygen(): Unable to generate ssh key (#{e})"
45+
end
46+
47+
# Return ssh key content based on request
48+
begin
49+
case request
50+
when :private
51+
return File.open("#{config[:basedir]}/#{config[:ssh_dir]}/#{config[:ssh_comment]}").read
52+
else
53+
pub_key = File.open("#{config[:basedir]}/#{config[:ssh_dir]}/#{config[:ssh_comment]}.pub").read
54+
return pub_key.scan(/^.* (.*) .*$/)[0][0]
55+
end
56+
rescue => e
57+
raise Puppet::ParseError, "ssh_keygen(): Unable to read ssh #{request.to_s} key (#{e})"
58+
end
59+
end
60+
end

‎modules/dirvish/manifests/client.pp

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Trivial class to include the dirvish keys on the clients
2+
#
3+
# Requires that /root/.ssh/authorized_keys is present
4+
#
5+
class dirvish::client (
6+
$pre_script = 'undef'
7+
) {
8+
9+
# Read the dirvish key from the puppetmaster
10+
$pub_key = ssh_keygen('dirvish_key','public')
11+
12+
file_line { 'dirvish_ssh_pubkey':
13+
ensure => present,
14+
path => '/root/.ssh/authorized_keys',
15+
line => "ssh-rsa ${pub_key} dirvish_key\n",
16+
}
17+
18+
$content = $pre_script ? {
19+
'undef' => template('dirvish/pre_client.sh.erb'),
20+
default => $pre_script,
21+
}
22+
23+
# Basic pre-run script
24+
file { '/etc/dirvish_pre_client':
25+
owner => 'root',
26+
group => 'root',
27+
mode => 0755,
28+
content => $content,
29+
}
30+
31+
# Dirvish depends on rsync
32+
package { 'rsync': ensure => installed }
33+
34+
}

‎modules/dirvish/manifests/config.pp

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
class dirvish::config {
2+
3+
# The main config file
4+
file { '/etc/dirvish/master.conf':
5+
owner => 'root',
6+
group => 'root',
7+
mode => '0644',
8+
content => template('dirvish/master.conf.erb')
9+
}
10+
11+
create_resources(dirvish::vault,$::dirvish::vaults)
12+
13+
}

‎modules/dirvish/manifests/init.pp

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
class dirvish(
2+
$backup_location = $dirvish::params::backup_location,
3+
$vaults = $dirvish::params::vaults
4+
) inherits dirvish::params {
5+
6+
anchor { 'dirvish::start': } ->
7+
class { 'dirvish::install': } ~>
8+
class { 'dirvish::config': } ~>
9+
class { 'dirvish::service': } ~>
10+
anchor { 'dirvish::end': }
11+
12+
}

‎modules/dirvish/manifests/install.pp

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
class dirvish::install {
2+
3+
package { 'dirvish': ensure => installed }
4+
5+
file { $::dirvish::backup_location:
6+
ensure => directory,
7+
owner => 'root',
8+
group => 'root',
9+
mode => 0755,
10+
}
11+
12+
file { "${::dirvish::backup_location}/ssh":
13+
ensure => directory,
14+
owner => 'root',
15+
group => 'root',
16+
mode => 0700,
17+
}
18+
19+
# This clever function creates SSH keys on the puppetmaster and allows them to
20+
# be read back and passed to the puppet clients
21+
22+
# Read the dirvish SSH key (and create it if necessary)
23+
24+
$pub_key = ssh_keygen('dirvish_key','public')
25+
$priv_key = ssh_keygen('dirvish_key','private')
26+
27+
file { "${::dirvish::backup_location}/ssh/dirvish_key":
28+
owner => 'root',
29+
group => 'root',
30+
mode => 0400,
31+
content => "${priv_key}",
32+
}
33+
34+
file { "${::dirvish::backup_location}/ssh/dirvish_key.pub":
35+
owner => 'root',
36+
group => 'root',
37+
mode => 0644,
38+
content => "ssh-rsa ${pub_key} dirvish_key\n",
39+
}
40+
41+
}

‎modules/dirvish/manifests/params.pp

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
class dirvish::params {
2+
3+
# The place to store the backups
4+
$backup_location = "/srv/backups"
5+
6+
# The backups to perform. This is an example.
7+
$vaults = {
8+
test => {
9+
client => 'myclient',
10+
tree => '/etc',
11+
excludes => [
12+
'*hosts*',
13+
'/etc/puppet'
14+
]
15+
}
16+
}
17+
18+
}

‎modules/dirvish/manifests/service.pp

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
class dirvish::service {
2+
3+
# Dirvish runs from a cronjob
4+
cron { 'dirvish':
5+
command => '/etc/dirvish/dirvish-cronjob',
6+
user => root,
7+
hour => '2',
8+
minute => '45'
9+
}
10+
11+
}

‎modules/dirvish/manifests/vault.pp

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
define dirvish::vault(
2+
$client,
3+
$tree,
4+
$excludes = [],
5+
) {
6+
7+
file { "${::dirvish::backup_location}/${name}":
8+
ensure => directory,
9+
owner => 'root',
10+
group => 'root',
11+
mode => 0644,
12+
}
13+
->
14+
file { "${::dirvish::backup_location}/${name}/dirvish":
15+
ensure => directory,
16+
owner => 'root',
17+
group => 'root',
18+
mode => 0644,
19+
}
20+
->
21+
file { "${::dirvish::backup_location}/${name}/dirvish/default.conf":
22+
ensure => present,
23+
owner => 'root',
24+
group => 'root',
25+
mode => 0644,
26+
content => template('dirvish/vault.erb')
27+
}
28+
~>
29+
# Initialize the vault. This could take a while, so we disable the timeout.
30+
# By using both creates and refreshonly, we hopefully avoid re-running this
31+
# when the 'initial' image rotates out
32+
exec { "Initialize Dirvish Vault: ${name}":
33+
timeout => 0,
34+
command => "/usr/sbin/dirvish --init --vault ${name} --image initial",
35+
refreshonly => true,
36+
creates => "${::dirvish::backup_location}/${name}/initial",
37+
require => File['/etc/dirvish/master.conf'],
38+
}
39+
40+
41+
}

‎modules/dirvish/metadata.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "gwmngilfen-dirvish",
3+
"version": "0.0.1",
4+
"source": "UNKNOWN",
5+
"author": "gwmngilfen",
6+
"license": "Apache License, Version 2.0",
7+
"summary": "UNKNOWN",
8+
"description": "UNKNOWN",
9+
"project_page": "UNKNOWN",
10+
"dependencies": [
11+
{
12+
"name": "puppetlasbs/stdlib"
13+
}
14+
],
15+
"types": [
16+
17+
],
18+
"checksums": {
19+
"Modulefile": "493e513efdb8d9827c02f5a27c94d1dd",
20+
"README": "3bddea73d6f0704ec1c8ee6c317852b2",
21+
"manifests/config.pp": "0047069e8d2e37086a555504e68de200",
22+
"manifests/init.pp": "f2db347eace25388dc0d9df8af4df4f0",
23+
"manifests/install.pp": "ccd8f1ef90dcf2b58f6993588a7c3007",
24+
"manifests/params.pp": "d4eafe0cb718c59a46e319bb927e1215",
25+
"manifests/service.pp": "3f19c780022c16b7a0b6b1b0bf5087d3"
26+
}
27+
}

‎modules/dirvish/templates/master.conf.erb

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
bank:
2+
<%= scope.lookupvar('::dirvish::backup_location') %>
3+
4+
exclude:
5+
lost+found/
6+
*~
7+
.nfs*
8+
9+
expire-default: +15 days
10+
11+
Runall:
12+
<% scope.lookupvar('::dirvish::vaults').keys.each do |vault| -%>
13+
<%= vault %>
14+
<% end -%>

‎modules/dirvish/templates/pre_client.sh.erb

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/bash
2+
3+
# Puppet-created script run by the dirvish server before the backup is run
4+
# This is the default script which does nothing
5+
6+
true

‎modules/dirvish/templates/vault.erb

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
client: <%= client %>
2+
tree: <%= tree %>
3+
4+
xdev: true
5+
index: gzip
6+
image-default: %Y%m%d
7+
8+
rsh: ssh -oStrictHostKeyChecking=no -i<%= scope.lookupvar('::dirvish::backup_location') %>/ssh/dirvish_key
9+
10+
# This script is created on all dirvish::client machines
11+
pre-client: /etc/dirvish_pre_client
12+
13+
expire-rule:
14+
mday { 1 } +6 months
15+
16+
expire-default: +30 days
17+
18+
<% unless excludes.empty? -%>
19+
exclude:
20+
<%= excludes.join("\n ") %>
21+
<% end -%>

0 commit comments

Comments
 (0)