Merge pull request #462 from jcpunk/timedatectl

Add support for timezone and hardware clock

Author: jcpunk

REFERENCE.md

@@ -23,6 +23,7 @@
 * `systemd::oomd`: This class manages and configures oomd.
 * `systemd::resolved`: This class provides an abstract way to trigger resolved.
 * `systemd::system`: This class provides a solution to enable accounting
+* `systemd::timedatectl`: This class provides an abstract way to set elements with timedatectl
 * `systemd::timesyncd`: This class provides an abstract way to trigger systemd-timesyncd
 * `systemd::udevd`: This class manages systemd's udev config
 
@@ -121,6 +122,8 @@ The following parameters are available in the `systemd` class:
 * [`timesyncd_package`](#-systemd--timesyncd_package)
 * [`ntp_server`](#-systemd--ntp_server)
 * [`fallback_ntp_server`](#-systemd--fallback_ntp_server)
+* [`timezone`](#-systemd--timezone)
+* [`set_local_rtc`](#-systemd--set_local_rtc)
 * [`manage_journald`](#-systemd--manage_journald)
 * [`journald_settings`](#-systemd--journald_settings)
 * [`manage_udevd`](#-systemd--manage_udevd)
@@ -416,6 +419,30 @@ systemd-networkd take precedence over this setting. requires puppetlabs-inifile
 
 Default value: `undef`
 
+##### <a name="-systemd--timezone"></a>`timezone`
+
+Data type: `Optional[String[1]]`
+
+Set the system time zone to the specified value.
+Available timezones can be listed with list-timezones.
+If the RTC is configured to be in the local time, this will also update
+the RTC time. This call will alter the /etc/localtime symlink.
+
+Default value: `undef`
+
+##### <a name="-systemd--set_local_rtc"></a>`set_local_rtc`
+
+Data type: `Optional[Boolean]`
+
+Takes a boolean argument. If "false", the system is configured to maintain
+the RTC in universal time.
+If "true", it will maintain the RTC in local time instead.
+Note that maintaining the RTC in the local timezone is not fully supported
+and will create various problems with time zone changes and daylight saving
+adjustments. If at all possible, keep the RTC in UTC mode.
+
+Default value: `undef`
+
 ##### <a name="-systemd--manage_journald"></a>`manage_journald`
 
 Data type: `Boolean`

manifests/init.pp

@@ -112,6 +112,20 @@
 #   as the fallback NTP servers. Any per-interface NTP servers obtained from
 #   systemd-networkd take precedence over this setting. requires puppetlabs-inifile
 #
+# @param timezone
+#   Set the system time zone to the specified value.
+#   Available timezones can be listed with list-timezones.
+#   If the RTC is configured to be in the local time, this will also update
+#   the RTC time. This call will alter the /etc/localtime symlink.
+#
+# @param set_local_rtc
+#   Takes a boolean argument. If "false", the system is configured to maintain
+#   the RTC in universal time.
+#   If "true", it will maintain the RTC in local time instead.
+#   Note that maintaining the RTC in the local timezone is not fully supported
+#   and will create various problems with time zone changes and daylight saving
+#   adjustments. If at all possible, keep the RTC in UTC mode.
+#
 # @param manage_journald
 #   Manage the systemd journald
 #
@@ -230,6 +244,8 @@
   Optional[String[1]]                                 $timesyncd_package = undef,
   Optional[Variant[Array,String]]                     $ntp_server = undef,
   Optional[Variant[Array,String]]                     $fallback_ntp_server = undef,
+  Optional[Boolean]                                   $set_local_rtc = undef,
+  Optional[String[1]]                                 $timezone = undef,
   Boolean                                             $manage_accounting = false,
   Boolean                                             $purge_dropin_dirs = true,
   Boolean                                             $manage_journald = true,
@@ -313,6 +329,8 @@
     Class['systemd::install'] -> Class['systemd::networkd']
   }
 
+  contain systemd::timedatectl
+
   if $manage_timesyncd and $facts['systemd_internal_services'] and $facts['systemd_internal_services']['systemd-timesyncd.service'] {
     contain systemd::timesyncd
   }

manifests/timedatectl.pp

@@ -0,0 +1,46 @@
+# @api private
+#
+# @summary This class provides an abstract way to set elements with timedatectl
+#
+# @param set_local_rtc
+# Takes a boolean argument. If "false", the system is configured to maintain
+# the RTC in universal time.
+# If "true", it will maintain the RTC in local time instead.
+# Note that maintaining the RTC in the local timezone is not fully supported
+# and will create various problems with time zone changes and daylight saving
+# adjustments. If at all possible, keep the RTC in UTC mode.
+#
+# @param timezone
+# Set the system time zone to the specified value.
+# Available timezones can be listed with list-timezones.
+# If the RTC is configured to be in the local time, this will also update
+# the RTC time. This call will alter the /etc/localtime symlink.
+class systemd::timedatectl (
+  Optional[Boolean] $set_local_rtc = $systemd::set_local_rtc,
+  Optional[String[1]] $timezone = $systemd::timezone,
+) {
+  assert_private()
+
+  if $timezone {
+    exec { 'set system timezone':
+      command => "timedatectl set-timezone ${timezone}",
+      unless  => "test $(timedatectl show --property Timezone --value) = ${timezone}",
+      path    => $facts['path'],
+    }
+  }
+
+  # if $set_local_rtc is undef, this remains unmanaged
+  if $set_local_rtc {
+    exec { 'set local hardware clock to local time':
+      command => 'timedatectl set-local-rtc 1',
+      onlyif  => 'test $(timedatectl show --property LocalRTC --value) = no',
+      path    => $facts['path'],
+    }
+  } elsif $set_local_rtc == false {
+    exec { 'set local hardware clock to UTC time':
+      command => 'timedatectl set-local-rtc 0',
+      unless  => 'test $(timedatectl show --property LocalRTC --value) = no',
+      path    => $facts['path'],
+    }
+  }
+}

spec/classes/init_spec.rb

@@ -386,6 +386,43 @@
           it { is_expected.to contain_ini_setting('fallback_ntp_server') }
         end
 
+        context 'when setting timezone' do
+          let(:params) do
+            {
+              timezone: 'America/Chicago',
+            }
+          end
+
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_exec('set system timezone').with_command('timedatectl set-timezone America/Chicago') }
+          it { is_expected.not_to contain_exec('set local hardware clock to local time') }
+          it { is_expected.not_to contain_exec('set local hardware clock to UTC time') }
+        end
+
+        context 'when setting rtc-local is true' do
+          let(:params) do
+            {
+              set_local_rtc: true
+            }
+          end
+
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_exec('set local hardware clock to local time') }
+          it { is_expected.not_to contain_exec('set local hardware clock to UTC time') }
+        end
+
+        context 'when setting rtc-local is false' do
+          let(:params) do
+            {
+              set_local_rtc: false
+            }
+          end
+
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.not_to contain_exec('set local hardware clock to local time') }
+          it { is_expected.to contain_exec('set local hardware clock to UTC time') }
+        end
+
         context 'when passing service limits' do
           let(:params) do
             {