Merge pull request #676 from bastelfreak/manage_user

Add support for managing user ID and comment

REFERENCE.md

@@ -125,6 +125,8 @@ The following parameters are available in the `consul` class:
 * [`enable_beta_ui`](#-consul--enable_beta_ui)
 * [`allow_binding_to_root_ports`](#-consul--allow_binding_to_root_ports)
 * [`log_file`](#-consul--log_file)
+* [`comment`](#-consul--comment)
+* [`uid`](#-consul--uid)
 
 ##### <a name="-consul--acls"></a>`acls`
 
@@ -592,6 +594,22 @@ where should the log file be located
 
 Default value: `'/var/log/consul'`
 
+##### <a name="-consul--comment"></a>`comment`
+
+Data type: `Optional[String[1]]`
+
+the comment for the consul user, will be added to /etc/passwd
+
+Default value: `undef`
+
+##### <a name="-consul--uid"></a>`uid`
+
+Data type: `Optional[Integer[1]]`
+
+the ID for the consul user
+
+Default value: `undef`
+
 ## Defined types
 
 ### <a name="consul--check"></a>`consul::check`

manifests/init.pp

@@ -73,6 +73,8 @@
 #   You can enable it by setting this variable to true. Defaults to false
 # @param allow_binding_to_root_ports enables CAP_NET_BIND_SERVICE if true. This is currently only implemented on systemd nodes
 # @param log_file where should the log file be located
+# @param comment the comment for the consul user, will be added to /etc/passwd
+# @param uid the ID for the consul user
 #
 # @example simple consul setup
 #    class { 'consul':
@@ -142,6 +144,8 @@
   Optional[String[1]]                   $shell                       = $consul::params::shell,
   Boolean                               $enable_beta_ui              = false,
   Boolean                               $allow_binding_to_root_ports = false,
+  Optional[String[1]]                   $comment                     = undef,
+  Optional[Integer[1]]                  $uid                         = undef,
 ) inherits consul::params {
   $real_download_url = pick(
     $download_url,

manifests/install.pp

@@ -102,11 +102,13 @@
     }
 
     user { $consul::user_real:
-      ensure => 'present',
-      system => true,
-      groups => $consul::extra_groups,
-      shell  => $consul::shell,
-      home   => $consul_user_home,
+      ensure  => 'present',
+      system  => true,
+      groups  => $consul::extra_groups,
+      shell   => $consul::shell,
+      home    => $consul_user_home,
+      uid     => $consul::uid,
+      comment => $consul::comment,
     }
 
     if ($consul::manage_group) and ($consul::install_method != 'docker' ) {

spec/classes/init_spec.rb

@@ -242,7 +242,7 @@
       end
 
       context 'By default, a user and group should be installed' do
-        it { is_expected.to contain_user('consul').with(ensure: :present) }
+        it { is_expected.to contain_user('consul').with(ensure: :present).without_uid.without_comment }
         it { is_expected.to contain_group('consul').with(ensure: :present) }
       end
 
@@ -256,6 +256,17 @@
         it { is_expected.to contain_user('consul').with(ensure: :present).without_home }
       end
 
+      context 'with uid and comment' do
+        let :params do
+          {
+            uid: 2,
+            comment: 'this is a comment',
+          }
+        end
+
+        it { is_expected.to contain_user('consul').with(ensure: :present).with_uid(2).with_comment('this is a comment') }
+      end
+
       context 'When data_dir is provided' do
         let(:params) do
           {