Merge pull request #2 from jps-help/dev

Release 0.1.2

Author: jps-help

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Release 0.1.2
+### Changed
+- `netplan::config` resources include the top-level `network` key automatically [BREAKING]
+  - Users will need to remove the top-level `network` key from their existing netplan hash/hiera 
 ## Release 0.1.0
 
 Initial release

README.md

@@ -31,6 +31,8 @@ include netplan
 This module is best used by supplying data via Hiera. Generating netplan YAML files with resource statements, although possible, can result in very complex manifests.
 
 The below example shows both methods, although it's strongly recommended to just use Hiera to form your netplan config.
+
+Please note, the `netplan::config` resource automatically adds the top-level `network` key to generated YAML files. You only need to define the settings under that key.
 ### Basic usage
 Make sure to include netplan somewhere in your manifest. By default, this will only ensure that netplan is installed.
 ```
@@ -42,24 +44,21 @@ Provide Hiera data to build your inteneded netplan YAML file.
 netplan::configs:
   example-config:
     settings:
-      network:
-        version: 2
-        renderer: networkd
-        ethernets:
-          eth0:
-            dhcp4: true
+      version: 2
+      renderer: networkd
+      ethernets:
+        eth0:
+          dhcp4: true
 ```
 And here is the same config using a `netplan::config` resource instead
 ```
 netplan::config { 'example-config': 
   settings => {
-    network => {
-      version => 2,
-      renderer => networkd,
-      ethernets => {
-        eth0 => {
-          dhcp4 => true,
-        },
+    version => 2,
+    renderer => networkd,
+    ethernets => {
+      eth0 => {
+        dhcp4 => true,
       },
     },
   },
@@ -87,16 +86,14 @@ netplan::configs:
   example-config:
     priority: 10
     settings:
-      network:
-        version: 2
-        renderer: networkd
+      version: 2
+      renderer: networkd
   example-config-2:
     priority: 20
     settings:
-      network:
-        ethernets:
-          eth0:
-            dhcp4: true
+      ethernets:
+        eth0:
+          dhcp4: true
 ```
 The above will result in the following under `/etc/netplan/`
 - 10-example-config.yaml

REFERENCE.md

@@ -97,13 +97,11 @@ Create netplan YAML files from a Hash of data.
 ```puppet
 netplan::config { 'example-config':
   settings => {
-    network => {
-      version => 2,
-      renderer => networkd,
-      ethernets => {
-        eth0 => {
-          dhcp4 => true,
-        },
+    version => 2,
+    renderer => networkd,
+    ethernets => {
+      eth0 => {
+        dhcp4 => true,
       },
     },
   },

manifests/config.pp

@@ -5,13 +5,11 @@
 # @example Basic config
 #   netplan::config { 'example-config': 
 #     settings => {
-#       network => {
-#         version => 2,
-#         renderer => networkd,
-#         ethernets => {
-#           eth0 => {
-#             dhcp4 => true,
-#           },
+#       version => 2,
+#       renderer => networkd,
+#       ethernets => {
+#         eth0 => {
+#           dhcp4 => true,
 #         },
 #       },
 #     },
@@ -46,7 +44,7 @@
   file { $file:
     ensure  => $ensure,
     mode    => $file_mode,
-    content => to_yaml($settings),
+    content => to_yaml({ network => $settings }),
     notify  => Exec['netplan_cmd'],
   }
 }

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "jmckenzie-netplan",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "James McKenzie",
   "summary": "Manage netplan via Puppet",
   "license": "Apache-2.0",