Clarified user parameter names (client_user, server_user)

Author: tedivm

manifests/backup.pp

@@ -8,7 +8,7 @@
     source_path => $source_path,
     host        => $host,
     server      => $::rsnapshot::client::server,
-    user        => $::rsnapshot::client::user,
+    client_user => $::rsnapshot::client::client_user,
     options     => $options
   }
 

manifests/client.pp

@@ -42,8 +42,8 @@
   $excludes = {},
   $include_files = {},
   $exclude_files = {},
-  $user = $rsnapshot::params::client_user,
-  $remote_user = $rsnapshot::params::server_user,
+  $client_user = $rsnapshot::params::client_user,
+  $server_user = $rsnapshot::params::server_user,
   $backup_hourly_cron = $rsnapshot::params::backup_hourly_cron,
   $backup_time_minute = $rsnapshot::params::backup_time_minute,
   $backup_time_hour = $rsnapshot::params::backup_time_hour,
@@ -72,9 +72,9 @@
   $wrapper_path_normalized = regsubst($wrapper_path, '\/$', '')
 
   # Add User
-  class { 'rsnapshot::client::user' :
-    local_user   => $user,
-    remote_user  => "${remote_user}@${server}",
+  class { 'rsnapshot::client::client_user' :
+    local_user   => $client_user,
+    remote_user  => "${server_user}@${server}",
     server       => $server,
     use_sudo     => $use_sudo,
     push_ssh_key => $push_ssh_key,
@@ -91,7 +91,7 @@
   # Export client object to get picked up by the server.
   @@rsnapshot::server::config { $::fqdn:
     server              => $server,
-    user                => $user,
+    client_user         => $client_user,
     directories         => $directories,
     includes            => $includes,
     excludes            => $excludes,

manifests/client/user.pp

@@ -1,6 +1,6 @@
 class rsnapshot::client::user (
-  $local_user = '',
-  $remote_user = '',
+  $client_user = '',
+  $server_user = '',
   $server = '',
   $use_sudo = true,
   $push_ssh_key = true,
@@ -21,28 +21,28 @@
 
 
   # Setup Group
-  group { $local_user :
+  group { $client_user :
     ensure         => present,
   } ->
 
   # Setup User
-  user { $local_user :
+  user { $client_user :
     ensure         => present,
-    home           => "/home/${local_user}",
+    home           => "/home/${client_user}",
     managehome     => true,
     purge_ssh_keys => true,
     shell          => '/bin/bash',
-    gid            => $local_user,
+    gid            => $client_user,
     password       => '*'
   }
 
   ## Get Key for remote backup user
   if $push_ssh_key {
     $backup_server_ip = inline_template("<% _erbout.concat(Resolv::DNS.open.getaddress('${server}').to_s) %>")
-    sshkeys::set_authorized_key { "${remote_user} to ${local_user}":
-      local_user  => $local_user,
-      remote_user => $remote_user,
-      require     => User[$local_user],
+    sshkeys::set_authorized_key { "${server_user} to ${client_user}":
+      local_user  => $client_user,
+      remote_user => $server_user,
+      require     => User[$client_user],
       options     => [
         "command=\"${allowed_command}\"",
         'no-port-forwarding',
@@ -58,8 +58,8 @@
   if $use_sudo {
     sudo::conf { 'backup_user':
       priority => 99,
-      content  => "${local_user} ALL= NOPASSWD: ${wrapper_path}/rsync_sender.sh",
-      require  => User[$local_user]
+      content  => "${client_user} ALL= NOPASSWD: ${wrapper_path}/rsync_sender.sh",
+      require  => User[$client_user]
     }
   }
 }

manifests/server.pp

@@ -40,7 +40,7 @@
   $backup_path = $rsnapshot::params::server_backup_path,
   $log_path = $rsnapshot::params::server_log_path,
   $lock_path = $rsnapshot::params::lock_path,
-  $user = $rsnapshot::params::server_user,
+  $server_user = $rsnapshot::params::server_user,
   $no_create_root = $rsnapshot::params::no_create_root,
   $verbose = $rsnapshot::params::verbose,
   $log_level = $rsnapshot::params::log_level,
@@ -57,22 +57,22 @@
   # Add logging folder
   file { $log_path :
     ensure => directory,
-    owner  => $user,
-    group  => $user
+    owner  => $server_user,
+    group  => $server_user
   }
 
   # Add config path
   file { $config_path :
     ensure => directory,
-    owner  => $user,
-    group  => $user
+    owner  => $server_user,
+    group  => $server_user
   }->
 
   # Add logging folder
   file { $backup_path :
     ensure => directory,
-    owner  => $user,
-    group  => $user
+    owner  => $server_user,
+    group  => $server_user
   }->
 
 
@@ -81,7 +81,7 @@
     log_path               => $::rsnapshot::server::log_path,
     lock_path              => $::rsnapshot::server::lock_path,
     backup_path            => $::rsnapshot::server::backup_path,
-    remote_user            => $::rsnapshot::server::user,
+    server_user            => $server_user,
     no_create_root         => $::rsnapshot::server::no_create_root,
     verbose                => $::rsnapshot::server::verbose,
     loglevel               => $::rsnapshot::server::loglevel,

manifests/server/backup_config.pp

@@ -3,7 +3,7 @@
   $source_path,
   $host,
   $server,
-  $user = $rsnapshot::params::client_backup_user,
+  $client_user = $rsnapshot::params::client_backup_user,
   $options = {},
   ) {
   assert_private()

manifests/server/config.pp

@@ -4,8 +4,8 @@
   $backup_path = $rsnapshot::params::server_backup_path,
   $log_path = $rsnapshot::params::server_log_path,
   $lock_path = $rsnapshot::params::lock_path,
-  $backup_user = $rsnapshot::params::server_user,
-  $remote_user = $rsnapshot::params::client_user,
+  $server_user = $rsnapshot::params::server_user,
+  $client_user = $rsnapshot::params::client_user,
   $directories = {},
   $includes = {},
   $excludes = {},
@@ -50,8 +50,6 @@
   $backup_path_norm = regsubst($backup_path, '\/$', '')
   $wrapper_path_norm = regsubst($wrapper_path, '\/$', '')
 
-  $user = $backup_user
-
   $log_file = "${log_path_norm}/${name}-rsnapshot.log"
   $lock_file = "${lock_path_norm}/${name}-rsnapshot.pid"
   $config_file = "${config_path_norm}/${name}-rsnapshot.conf"
@@ -87,23 +85,23 @@
   ## hourly
   cron { "rsnapshot-${name}-hourly" :
     command => "${rsnapshot::server::cmd_rsnapshot} -c ${config_file} hourly",
-    user    => 'root',
+    user    => $server_user,
     hour    => $backup_hourly_cron,
     minute  => $backup_time_minute
   } ->
 
   ## daily
   cron { "rsnapshot-${name}-daily" :
     command => "${rsnapshot::server::cmd_rsnapshot} -c ${config_file} daily",
-    user    => 'root',
+    user    => $server_user,
     hour    => $backup_time_hour,
     minute  => $backup_time_minute
   } ->
 
   ## weekly
   cron { "rsnapshot-${name}-weekly" :
     command => "${rsnapshot::server::cmd_rsnapshot} -c ${config_file} weekly",
-    user    => 'root',
+    user    => $server_user,
     hour    => ($backup_time_hour + 3) % 24,
     minute  => $backup_time_minute,
     weekday => $backup_time_weekday
@@ -112,7 +110,7 @@
   ## monthly
   cron { "rsnapshot-${name}-monthly" :
     command  => "${rsnapshot::server::cmd_rsnapshot} -c ${config_file} monthly",
-    user     => 'root',
+    user     => $server_user,
     hour     => ($backup_time_hour + 6) % 24,
     minute   => $backup_time_minute,
     monthday => $backup_time_dom
@@ -156,8 +154,8 @@
 
   # config file
   concat { $config_file :
-    owner => $::rsnapshot::server::user,
-    group => $::rsnapshot::server::user,
+    owner => $server_user,
+    group => $server_user,,
     mode  => '0644',
     warn  => true
   }

templates/backup_point.erb

@@ -1 +1 @@
-backup	<%= @user %>@<%= @host %>:<%= @source_path.gsub(/\/$/, '') %>/<%= "\t" %>
+backup	<%= @client_user %>@<%= @host %>:<%= @source_path.gsub(/\/$/, '') %>/<%= "\t" %>

templates/config.erb

@@ -101,5 +101,5 @@ exclude	<%= value %>
 ###############################
 
 <% @directories.each do |source_dir| -%>
-backup	<%= @user %>@<%= @name %>:<%= source_dir.gsub(/\/$/, '') %>/<%= "\t" %>
+backup	<%= @client_user %>@<%= @name %>:<%= source_dir.gsub(/\/$/, '') %>/<%= "\t" %>
 <% end -%>