diff --git a/.fixtures.yml b/.fixtures.yml new file mode 100644 index 0000000..4d1fe61 --- /dev/null +++ b/.fixtures.yml @@ -0,0 +1,6 @@ +# This file can be used to install module dependencies for unit testing +# See https://github.com/puppetlabs/puppetlabs_spec_helper#using-fixtures for details +--- +fixtures: + forge_modules: + stdlib: "puppetlabs/stdlib" diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9032a01 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +*.rb eol=lf +*.erb eol=lf +*.pp eol=lf +*.sh eol=lf +*.epp eol=lf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2767022 --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +.git/ +.*.sw[op] +.metadata +.yardoc +.yardwarns +*.iml +/.bundle/ +/.idea/ +/.vagrant/ +/coverage/ +/bin/ +/doc/ +/Gemfile.local +/Gemfile.lock +/junit/ +/log/ +/pkg/ +/spec/fixtures/manifests/ +/spec/fixtures/modules/ +/tmp/ +/vendor/ +/convert_report.txt +/update_report.txt +.DS_Store +.project +.envrc +/inventory.yaml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..dde5c04 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,71 @@ +--- +stages: + - syntax + - unit + - notify + +variables: + NOTIFY_ADDRESS: 'frank.brehm@pixelpark.com thomas.dalichow@pixelpark.com' + SENDER_ADDRESS: 'gitlab-ci@pixelpark.com' + MODULE_NAME: 'pixelpark-networkmanager' + +cache: + paths: + - vendor/bundle + +before_script: + - bundle -v + - rm Gemfile.lock || true + - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner" + - "# Set `rubygems_version` in the .sync.yml to set a value" + - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set" + - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION' + - gem --version + - bundle -v + - bundle install --without system_tests --path vendor/bundle --jobs $(nproc) + +syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop-Ruby 2.5.7-Puppet ~> 6: + stage: syntax + image: ruby:2.5.7 + script: + - bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop + variables: + PUPPET_GEM_VERSION: '~> 6' + except: + - /^dev-.*$/ + - /^dev\/.*$/ + - /^hf.*$/ + - tags + +parallel_spec-Ruby 2.5.7-Puppet ~> 6: + stage: unit + image: ruby:2.5.7 + script: + - bundle exec rake parallel_spec + variables: + PUPPET_GEM_VERSION: '~> 6' + only: + - master + - test + +parallel_spec-Ruby 2.7.2-Puppet ~> 7: + stage: unit + image: ruby:2.7.2 + script: + - bundle exec rake parallel_spec + variables: + PUPPET_GEM_VERSION: '~> 7' + only: + - master + - test + +Notify Error: + stage: notify + allow_failure: true + when: on_failure + script: 'echo -e "Error in module ${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME} (${CI_COMMIT_REF_NAME})\nPlease check ${CI_PROJECT_URL}/pipelines/${CI_PIPELINE_ID}\n\nCommiter: ${GITLAB_USER_NAME} <${GITLAB_USER_EMAIL}>" | mailx -s "Gitlab-CI error for Puppet module $MODULE_NAME" -r "$SENDER_ADDRESS" "$NOTIFY_ADDRESS"' + only: + - master + - test + +# vim: ts=2 et diff --git a/.pdkignore b/.pdkignore new file mode 100644 index 0000000..e6215cd --- /dev/null +++ b/.pdkignore @@ -0,0 +1,42 @@ +.git/ +.*.sw[op] +.metadata +.yardoc +.yardwarns +*.iml +/.bundle/ +/.idea/ +/.vagrant/ +/coverage/ +/bin/ +/doc/ +/Gemfile.local +/Gemfile.lock +/junit/ +/log/ +/pkg/ +/spec/fixtures/manifests/ +/spec/fixtures/modules/ +/tmp/ +/vendor/ +/convert_report.txt +/update_report.txt +.DS_Store +.project +.envrc +/inventory.yaml +/appveyor.yml +/.fixtures.yml +/Gemfile +/.gitattributes +/.gitignore +/.gitlab-ci.yml +/.pdkignore +/Rakefile +/rakelib/ +/.rspec +/.rubocop.yml +/.travis.yml +/.yardopts +/spec/ +/.vscode/ diff --git a/.puppet-lint.rc b/.puppet-lint.rc new file mode 100644 index 0000000..cc96ece --- /dev/null +++ b/.puppet-lint.rc @@ -0,0 +1 @@ +--relative diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..16f9cdb --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--color +--format documentation diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..5307849 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,137 @@ +--- +require: +- rubocop-rspec +- rubocop-i18n +AllCops: + DisplayCopNames: true + TargetRubyVersion: '2.1' + Include: + - "./**/*.rb" + Exclude: + - bin/* + - ".vendor/**/*" + - "**/Gemfile" + - "**/Rakefile" + - pkg/**/* + - spec/fixtures/**/* + - vendor/**/* + - "**/Puppetfile" + - "**/Vagrantfile" + - "**/Guardfile" +Metrics/LineLength: + Description: People have wide screens, use them. + Max: 200 +GetText: + Enabled: false +GetText/DecorateString: + Description: We don't want to decorate test output. + Exclude: + - spec/**/* + Enabled: false +RSpec/BeforeAfterAll: + Description: Beware of using after(:all) as it may cause state to leak between tests. + A necessary evil in acceptance testing. + Exclude: + - spec/acceptance/**/*.rb +RSpec/HookArgument: + Description: Prefer explicit :each argument, matching existing module's style + EnforcedStyle: each +Style/BlockDelimiters: + Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to + be consistent then. + EnforcedStyle: braces_for_chaining +Style/BracesAroundHashParameters: + Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0. + See https://github.com/rubocop-hq/rubocop/pull/7643 + Enabled: true +Style/ClassAndModuleChildren: + Description: Compact style reduces the required amount of indentation. + EnforcedStyle: compact +Style/EmptyElse: + Description: Enforce against empty else clauses, but allow `nil` for clarity. + EnforcedStyle: empty +Style/FormatString: + Description: Following the main puppet project's style, prefer the % format format. + EnforcedStyle: percent +Style/FormatStringToken: + Description: Following the main puppet project's style, prefer the simpler template + tokens over annotated ones. + EnforcedStyle: template +Style/Lambda: + Description: Prefer the keyword for easier discoverability. + EnforcedStyle: literal +Style/RegexpLiteral: + Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168 + EnforcedStyle: percent_r +Style/TernaryParentheses: + Description: Checks for use of parentheses around ternary conditions. Enforce parentheses + on complex expressions for better readability, but seriously consider breaking + it up. + EnforcedStyle: require_parentheses_when_complex +Style/TrailingCommaInArguments: + Description: Prefer always trailing comma on multiline argument lists. This makes + diffs, and re-ordering nicer. + EnforcedStyleForMultiline: comma +Style/TrailingCommaInLiteral: + Description: Prefer always trailing comma on multiline literals. This makes diffs, + and re-ordering nicer. + EnforcedStyleForMultiline: comma +Style/SymbolArray: + Description: Using percent style obscures symbolic intent of array's contents. + EnforcedStyle: brackets +RSpec/MessageSpies: + EnforcedStyle: receive +Style/Documentation: + Exclude: + - lib/puppet/parser/functions/**/* + - spec/**/* +Style/WordArray: + EnforcedStyle: brackets +Style/CollectionMethods: + Enabled: true +Style/MethodCalledOnDoEndBlock: + Enabled: true +Style/StringMethods: + Enabled: true +GetText/DecorateFunctionMessage: + Enabled: false +GetText/DecorateStringFormattingUsingInterpolation: + Enabled: false +GetText/DecorateStringFormattingUsingPercent: + Enabled: false +Layout/EndOfLine: + Enabled: false +Layout/IndentHeredoc: + Enabled: false +Metrics/AbcSize: + Enabled: false +Metrics/BlockLength: + Enabled: false +Metrics/ClassLength: + Enabled: false +Metrics/CyclomaticComplexity: + Enabled: false +Metrics/MethodLength: + Enabled: false +Metrics/ModuleLength: + Enabled: false +Metrics/ParameterLists: + Enabled: false +Metrics/PerceivedComplexity: + Enabled: false +RSpec/DescribeClass: + Enabled: false +RSpec/ExampleLength: + Enabled: false +RSpec/MessageExpectation: + Enabled: false +RSpec/MultipleExpectations: + Enabled: false +RSpec/NestedGroups: + Enabled: false +Style/AsciiComments: + Enabled: false +Style/IfUnlessModifier: + Enabled: false +Style/SymbolProc: + Enabled: false diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..68d3e96 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,49 @@ +--- +os: linux +dist: xenial +language: ruby +cache: bundler +before_install: + - bundle -v + - rm -f Gemfile.lock + - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner" + - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used" + - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set" + - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION' + - gem --version + - bundle -v +script: + - 'bundle exec rake $CHECK' +bundler_args: --without system_tests +rvm: + - 2.5.7 +stages: + - static + - spec + - acceptance + - + if: tag =~ ^v\d + name: deploy +jobs: + fast_finish: true + include: + - + env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint" + stage: static + - + env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec + rvm: 2.4.5 + stage: spec + - + env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec + rvm: 2.5.7 + stage: spec + - + env: DEPLOY_TO_FORGE=yes + stage: deploy +branches: + only: + - master + - /^v\d/ +notifications: + email: false diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..2f1e4f7 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "puppet.puppet-vscode", + "rebornix.Ruby" + ] +} diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..29c933b --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +--markup markdown diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4c954cd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## Release 0.1.0 + +**Features** + +**Bugfixes** + +**Known Issues** diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..8007ad0 --- /dev/null +++ b/Gemfile @@ -0,0 +1,72 @@ +source ENV['GEM_SOURCE'] || 'https://rubygems.org' + +def location_for(place_or_version, fake_version = nil) + git_url_regex = %r{\A(?(https?|git)[:@][^#]*)(#(?.*))?} + file_url_regex = %r{\Afile:\/\/(?.*)} + + if place_or_version && (git_url = place_or_version.match(git_url_regex)) + [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact + elsif place_or_version && (file_url = place_or_version.match(file_url_regex)) + ['>= 0', { path: File.expand_path(file_url[:path]), require: false }] + else + [place_or_version, { require: false }] + end +end + +ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments +minor_version = ruby_version_segments[0..1].join('.') + +group :development do + gem "fast_gettext", '1.1.0', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') + gem "fast_gettext", require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') + gem "json_pure", '<= 2.0.1', require: false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') + gem "json", '= 1.8.1', require: false if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('2.1.9') + gem "json", '= 2.0.4', require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "json", '= 2.1.0', require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) + gem "rb-readline", '= 0.5.5', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] + gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby] + gem "puppet-module-win-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] + gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4', require: false, platforms: [:mswin, :mingw, :x64_mingw] +end + +puppet_version = ENV['PUPPET_GEM_VERSION'] +facter_version = ENV['FACTER_GEM_VERSION'] +hiera_version = ENV['HIERA_GEM_VERSION'] + +gems = {} + +gems['puppet'] = location_for(puppet_version) + +# If facter or hiera versions have been specified via the environment +# variables + +gems['facter'] = location_for(facter_version) if facter_version +gems['hiera'] = location_for(hiera_version) if hiera_version + +if Gem.win_platform? && puppet_version =~ %r{^(file:///|git://)} + # If we're using a Puppet gem on Windows which handles its own win32-xxx gem + # dependencies (>= 3.5.0), set the maximum versions (see PUP-6445). + gems['win32-dir'] = ['<= 0.4.9', require: false] + gems['win32-eventlog'] = ['<= 0.6.5', require: false] + gems['win32-process'] = ['<= 0.7.5', require: false] + gems['win32-security'] = ['<= 0.2.5', require: false] + gems['win32-service'] = ['0.8.8', require: false] +end + +gems.each do |gem_name, gem_params| + gem gem_name, *gem_params +end + +# Evaluate Gemfile.local and ~/.gemfile if they exist +extra_gemfiles = [ + "#{__FILE__}.local", + File.join(Dir.home, '.gemfile'), +] + +extra_gemfiles.each do |gemfile| + if File.file?(gemfile) && File.readable?(gemfile) + eval(File.read(gemfile), binding) + end +end +# vim: syntax=ruby diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d5c584 --- /dev/null +++ b/README.md @@ -0,0 +1,143 @@ +# networkmanager + + +## Table of Contents + +1. [Description](#description) +1. [Setup - The basics of getting started with networkmanager](#setup) + * [Setup requirements](#setup-requirements) +1. [Usage - Configuration options and additional functionality](#usage) +1. [Limitations - OS compatibility, etc.](#limitations) +1. [Development - Guide for contributing to the module](#development) + +## Description + +Get and set parameters of NetworkManager controlled connections. + +In the first iteration this module supports management of two aspects +of the NetworkManager: + +* Management of the NetworkManager daemon - whther it is running and enabled or not +* Management of DNS information of particular NetworkManager connections. + This could be done on three different ways: + * Either by configurig a global Configuration file below `/etc/NetworkManager/conf.d`, + * or by setting the DNS parameters of the primary NetworkManager connection (whichever it is), + * or by setting the DNS parameters of one or more named NetworkManager connections. + +## Setup + +### Setup Requirements + +This module requires following: + +* Puppet >= 6.0 +* the module puppetlabs-stdlib >= 7.0.0 + +This module ist supported only for operating systems using NetworkManager. If the NetworkManager +command line tool **nmcli** could not be found, the module fails immediately. + +This module was currently tested on: +* CentOS-7 and CentOS-8 +* Oracle Enterprise Linux 7 + +## Usage + +### Simple Including the module + +The following two examples are simply including the networkmanager module. The further +configuration must be done via hieradata. + +```puppet +include networkmanager +``` + +or + +```puppet +contain networkmanager +``` + +### Instantiation as a class + +The following example is instatiating this module class with nearly all parameters: + +```puppet +class {'networkmanager': + enable_global_dns => false, + manage_dns => true, + nameservers => ['8.8.8.8', '8.8.4.4', '1.1.1.1']. + dns_searchdomains => ['example.com', 'uhu-banane.de', 'uhu-banane.net'], + dns_options => ['timeout:1', 'attempts:2', 'use-vc'], + manage_service => true. + ensure_service => running, + enable_service => true, + dns_notify_daemon => false, + connection_dnsoptions => { + wifi1 => { + nameservers => ['172.28.1.2', '172.30.1.2'], + searchdomains => ['home.example.com'], + dns_options => ['timeout:3, 'attempts:3', 'use-vc'], + notify_daemon => true, + }, + }, +} +``` + +### Setup of hieradata + +All parameters of the networkmanager module could be configured as hieradata. +But be aware, that all parameters are looked up with a first lookup. If you want to make +a deep lookup, yu have to set the lookup options by yourself. + +```yaml +--- +networkmanager::enable_global_dns: false +networkmanager::manage_dns: true +networkmanager::nameservers: + - '8.8.8.8' + - '8.8.4.4' + - '1.1.1.1' +networkmanager::dns_searchdomains: + - 'example.com' + - 'uhu-banane.de' + - 'uhu-banane.net' +networkmanager::dns_options: + - 'timeout:1' + - 'attempts:2' + - 'use-vc' +networkmanager::manage_service: true +networkmanager::ensure_service: running +networkmanager::enable_service: true +networkmanager::dns_notify_daemon: false +networkmanager::connection_dnsoptions: + wifi1: + nameservers: + - '172.28.1.2' + - '172.30.1.2' + searchdomains: + - 'home.example.com' + dns_options: + - 'timeout:3' + - 'attempts:3' + - 'use-vc' + notify_daemon: true +``` + +#### Parameters + + +## Limitations + +The development of this module has even started, so the amount on functionality +is not so giant. + +Don't hasitate to bring here new ideas, how to improve this module. + +## Development + +In the Development section, tell other users the ground rules for contributing +to your project and how they should submit their work. + +[1]: https://puppet.com/docs/pdk/latest/pdk_generating_modules.html +[2]: https://puppet.com/docs/puppet/latest/puppet_strings.html +[3]: https://puppet.com/docs/puppet/latest/puppet_strings_style.html diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..0093bd0 --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,306 @@ +# Reference + + + +## Table of Contents + +### Classes + +#### Public Classes + +* [`networkmanager`](#networkmanager): Manages NetworkManager connections + +#### Private Classes + +* `networkmanager::service`: Ensure and restarts NetworkManager Service + +### Defined types + +* [`networkmanager::dns`](#networkmanagerdns): Manages the DNS informations about a particular NetworkManager connection + +## Classes + +### `networkmanager` + +Manages NetworkManager connections + +#### Examples + +##### using simple include + +```puppet +include networkmanager +``` + +##### using class + +```puppet +class {'networkmanager': + enable_global_dns => false, + manage_dns => true, + nameservers => ['8.8.8.8', '8.8.4.4', '1.1.1.1']. + dns_searchdomains => ['example.com', 'uhu-banane.de', 'uhu-banane.net'], + dns_options => ['timeout:1', 'attempts:2', 'use-vc'], + manage_service => true. + ensure_service => running, + enable_service => true, + dns_notify_daemon => false, + connection_dnsoptions => { + wifi1 => { + nameservers => ['172.28.1.2', '172.30.1.2'], + searchdomains => ['home.example.com'], + dns_options => ['timeout:3, 'attempts:3', 'use-vc'], + notify_daemon => true, + }, + }, +} +``` + +##### using hieradata + +```yaml +--- +networkmanager::enable_global_dns: false +networkmanager::manage_dns: true +networkmanager::nameservers: + - '8.8.8.8' + - '8.8.4.4' + - '1.1.1.1' +networkmanager::dns_searchdomains: + - 'example.com' + - 'uhu-banane.de' + - 'uhu-banane.net' +networkmanager::dns_options: + - 'timeout:1' + - 'attempts:2' + - 'use-vc' +networkmanager::manage_service: true +networkmanager::ensure_service: running +networkmanager::enable_service: true +networkmanager::dns_notify_daemon: false +networkmanager::connection_dnsoptions: + wifi1: + nameservers: + - '172.28.1.2' + - '172.30.1.2' + searchdomains: + - 'home.example.com' + dns_options: + - 'timeout:3' + - 'attempts:3' + - 'use-vc' + notify_daemon: true +``` + +#### Parameters + +The following parameters are available in the `networkmanager` class: + +* [`enable_global_dns`](#enable_global_dns) +* [`global_nameservers`](#global_nameservers) +* [`global_searchdomains`](#global_searchdomains) +* [`global_dns_options`](#global_dns_options) +* [`global_conffile`](#global_conffile) +* [`manage_dns`](#manage_dns) +* [`nameservers`](#nameservers) +* [`dns_searchdomains`](#dns_searchdomains) +* [`dns_options`](#dns_options) +* [`manage_service`](#manage_service) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`enable_service`](#enable_service) +* [`restart_service`](#restart_service) +* [`dns_notify_daemon`](#dns_notify_daemon) +* [`connection_dnsoptions`](#connection_dnsoptions) +* [`ensure_service`](#ensure_service) + +##### `enable_global_dns` + +Data type: `Boolean` + +By enabling this, NetworkManager will not use the connections specific dns settings. +Instead it will generate a file with the desired dns settings. +Those parameters are then the default, even if connection specific settings are present. + +##### `global_nameservers` + +Data type: `Array[Stdlib::IP::Address::Nosubnet]` + +An array of the IP addresses for the nameservers for the global setting. + +##### `global_searchdomains` + +Data type: `Array[String[1]]` + +An array of DNS search domains for the global setting. + +##### `global_dns_options` + +Data type: `Optional[Variant[Array[String[1]], String]]` + +A string or an array of strings with resolving options for the global setting. +If omitted, no global resolving optios are set. + +##### `global_conffile` + +Data type: `Optional[Stdlib::Absolutepath]` + +The config file for global dns settings. Should be under /etc/NetworkManager/conf.d + +##### `manage_dns` + +Data type: `Boolean` + +Whether we want to manage dns of the primary NetworkManager connection. + +##### `nameservers` + +Data type: `Array[Stdlib::IP::Address::Nosubnet]` + +An array of the IP addresses of the resolvers to use for the primary NetworkManager connection. +At least one address has to be given, but if exactly one address is given, a warning will be omitted. + +##### `dns_searchdomains` + +Data type: `Array[String[1], 1]` + +An array of DNS search domains to use for the primary NetworkManager connection. +At least one domain has to be given. + +##### `dns_options` + +Data type: `Optional[Variant[Array[String[1]], String]]` + +A string or an array of strings with resolving options to use for the primary NetworkManager connection. +Please note not to use whitespaces inside the strings, only use comma to separate options inside +a string. If not given (or undef), the options are not managed. +To remove existing options use an empty string '' as a value. + +##### `manage_service` + +Data type: `Boolean` + +Whether we want to manage the NetworkManager service. + +##### `service_ensure` + +Whether a service should be running. Valid values are 'stopped', 'running', true, false. + +##### `service_name` + +Data type: `String[1]` + +The systemd service name of NetworkManager, usually 'NetworkManager'. + +##### `enable_service` + +Data type: `Boolean` + +Whether a service should be enabled to start at boot. + +##### `restart_service` + +Data type: `Optional[String[1]]` + +Specify a restart command manually. If left unspecified, the service will be stopped and then started. + +##### `dns_notify_daemon` + +Data type: `Boolean` + +A boolean flag, whether to notify the NetworkManager daemon after DNS changea on the primary +NetworkManager connections. In case of a notification the NetworkManager daemon is rewriting +/etc/resolv.conf immediately. In this way this resorce can be used to manage /etc/resolv.conf. +**CAUTION**: If you are using another module for managing /etc/resolv.conf (like saz-resolv_conf), +this option should be set to false to prevent a Ping-Pong game between those two modules. In this +case manage_dns is only intended to ensure a correct /etc/resolv.conf immediately after a reboot. + +Default value: ``true`` + +##### `connection_dnsoptions` + +Data type: `Optional[Hash]` + +A hash for creating networkmanager::dns resources for managing DNS options on different NetworkManager +connections. Be sure not to include the primary NetworkManager connection, if manage_dns is true. + +Default value: ``undef`` + +##### `ensure_service` + +Data type: `Optional[Variant[Boolean, String[1]]]` + + + +## Defined types + +### `networkmanager::dns` + +Manages the DNS informations about a particular NetworkManager connection + +#### Examples + +##### + +```puppet +networkmanager::dns { 'System link': + nameservers => ['8.8.8.8', '8,.8.4.4', '1.1.1.1'], + searchdomains => ['example.com', 'uhu-banane.de', 'uhu-banane.net'], + dns_options => ['timeout:1', 'attempts:2', 'use-vc'], + notify_daemon => true, +} +``` + +#### Parameters + +The following parameters are available in the `networkmanager::dns` defined type: + +* [`nameservers`](#nameservers) +* [`searchdomains`](#searchdomains) +* [`dns_options`](#dns_options) +* [`connection`](#connection) +* [`notify_daemon`](#notify_daemon) + +##### `nameservers` + +Data type: `Array[Stdlib::IP::Address::Nosubnet, 1]` + +An array of the IP addresses of the resolvers to use. At least one address has to be given, +but if exactly one address is given, a warning will be omitted. + +##### `searchdomains` + +Data type: `Array[String[1], 1]` + +An array of DNS search domains. At least one domain has to be given. + +##### `dns_options` + +Data type: `Optional[Variant[Array[String[1]], String]]` + +A string or an array of strings with resolving options. Please note not to use whitespaces +inside the strings, only use comma to separate options inside a string. If not given (or undef), +the options are not managed. To remove existing options use an empty string '' as a value. + +##### `connection` + +Data type: `Optional[String[1]]` + +The name of the NetworkManager connection. If not given, the name of the resource will be used +as the name of the connection. + +Default value: ``undef`` + +##### `notify_daemon` + +Data type: `Boolean` + +A boolean flag, whether to notify the NetworkManager daemon after DNS changes. In case of a +notification the NetworkManager daemon is rewriting /etc/resolv.conf immediately. In this way +this resorce can be used to manage /etc/resolv.conf. +**CAUTION**: If you are using another module for managing /etc/resolv.conf (like saz-resolv_conf), +this option should be set to false to prevent a Ping-Pong game between those two modules. In this +case this resource is only intended to ensure a correct /etc/resolv.conf immediately after a reboot. + +Default value: ``true`` + diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..0a5093b --- /dev/null +++ b/Rakefile @@ -0,0 +1,87 @@ +# frozen_string_literal: true + +require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? +require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet-syntax/tasks/puppet-syntax' +require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? +require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? +require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? + +def changelog_user + return unless Rake.application.top_level_tasks.include? "changelog" + returnVal = nil || JSON.load(File.read('metadata.json'))['author'] + raise "unable to find the changelog_user in .sync.yml, or the author in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator user:#{returnVal}" + returnVal +end + +def changelog_project + return unless Rake.application.top_level_tasks.include? "changelog" + + returnVal = nil + returnVal ||= begin + metadata_source = JSON.load(File.read('metadata.json'))['source'] + metadata_source_match = metadata_source && metadata_source.match(%r{.*\/([^\/]*?)(?:\.git)?\Z}) + + metadata_source_match && metadata_source_match[1] + end + + raise "unable to find the changelog_project in .sync.yml or calculate it from the source in metadata.json" if returnVal.nil? + + puts "GitHubChangelogGenerator project:#{returnVal}" + returnVal +end + +def changelog_future_release + return unless Rake.application.top_level_tasks.include? "changelog" + returnVal = "v%s" % JSON.load(File.read('metadata.json'))['version'] + raise "unable to find the future_release (version) in metadata.json" if returnVal.nil? + puts "GitHubChangelogGenerator future_release:#{returnVal}" + returnVal +end + +PuppetLint.configuration.send('disable_relative') + +if Bundler.rubygems.find_name('github_changelog_generator').any? + GitHubChangelogGenerator::RakeTask.new :changelog do |config| + raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil? + config.user = "#{changelog_user}" + config.project = "#{changelog_project}" + config.future_release = "#{changelog_future_release}" + config.exclude_labels = ['maintenance'] + config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)." + config.add_pr_wo_labels = true + config.issues = false + config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB" + config.configure_sections = { + "Changed" => { + "prefix" => "### Changed", + "labels" => ["backwards-incompatible"], + }, + "Added" => { + "prefix" => "### Added", + "labels" => ["enhancement", "feature"], + }, + "Fixed" => { + "prefix" => "### Fixed", + "labels" => ["bug", "documentation", "bugfix"], + }, + } + end +else + desc 'Generate a Changelog from GitHub' + task :changelog do + raise < 1.15' + condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')" +EOM + end +end + diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..ec38949 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,56 @@ +--- +version: 1.1.x.{build} +branches: + only: + - master + - release +skip_commits: + message: /^\(?doc\)?.*/ +clone_depth: 10 +init: + - SET + - 'mkdir C:\ProgramData\PuppetLabs\code && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\facter && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\hiera && exit 0' + - 'mkdir C:\ProgramData\PuppetLabs\puppet\var && exit 0' +environment: + matrix: + - + RUBY_VERSION: 24-x64 + CHECK: syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop + - + PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VERSION: 24 + CHECK: parallel_spec + - + PUPPET_GEM_VERSION: ~> 5.0 + RUBY_VERSION: 24-x64 + CHECK: parallel_spec + - + PUPPET_GEM_VERSION: ~> 6.0 + RUBY_VERSION: 25 + CHECK: parallel_spec + - + PUPPET_GEM_VERSION: ~> 6.0 + RUBY_VERSION: 25-x64 + CHECK: parallel_spec +matrix: + fast_finish: true +install: + - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH% + - bundle install --jobs 4 --retry 2 --without system_tests + - type Gemfile.lock +build: off +test_script: + - bundle exec puppet -V + - ruby -v + - gem -v + - bundle -v + - bundle exec rake %CHECK% +notifications: + - provider: Email + to: + - nobody@nowhere.com + on_build_success: false + on_build_failure: false + on_build_status_changed: false diff --git a/data/common.yaml b/data/common.yaml new file mode 100644 index 0000000..5ba9031 --- /dev/null +++ b/data/common.yaml @@ -0,0 +1,22 @@ +--- + +# Defaults for Global DNS options +networkmanager::enable_global_dns: false +networkmanagerservers: [] +networkmanager::global_searchdomains: [] +networkmanager::global_dns_options: [] +networkmanager::global_conffile: '/etc/NetworkManager/conf.d/dns.conf' + +# Defaults for DNS for primary interface +networkmanager::manage_dns: true +networkmanager::nameservers: [] +networkmanager::dns_searchdomains: [] +networkmanager::dns_options: [] + +# Defaults for NetworkManager server +networkmanager::manage_service: true +networkmanager::ensure_service: 'running' +networkmanager::service_name: 'NetworkManager' +networkmanager::enable_service: true +networkmanager::restart_service: ~ + diff --git a/hiera.yaml b/hiera.yaml new file mode 100644 index 0000000..545fff3 --- /dev/null +++ b/hiera.yaml @@ -0,0 +1,21 @@ +--- +version: 5 + +defaults: # Used for any hierarchy level that omits these keys. + datadir: data # This path is relative to hiera.yaml's directory. + data_hash: yaml_data # Use the built-in YAML backend. + +hierarchy: + - name: "osfamily/major release" + paths: + # Used to distinguish between Debian and Ubuntu + - "os/%{facts.os.name}/%{facts.os.release.major}.yaml" + - "os/%{facts.os.family}/%{facts.os.release.major}.yaml" + # Used for Solaris + - "os/%{facts.os.family}/%{facts.kernelrelease}.yaml" + - name: "osfamily" + paths: + - "os/%{facts.os.name}.yaml" + - "os/%{facts.os.family}.yaml" + - name: 'common' + path: 'common.yaml' diff --git a/lib/facter/networkmanager_connections.rb b/lib/facter/networkmanager_connections.rb new file mode 100644 index 0000000..b821ca3 --- /dev/null +++ b/lib/facter/networkmanager_connections.rb @@ -0,0 +1,12 @@ + +Facter.add(:networkmanager_connections) do + setcode do + nmcli = Facter.value('networkmanager_nmcli_path') + if nmcli + cmd = "#{nmcli} -g name connection show" + Facter::Core::Execution.execute(cmd).split(%r{\n+}) + else + nil + end + end +end diff --git a/lib/facter/networkmanager_dns.rb b/lib/facter/networkmanager_dns.rb new file mode 100644 index 0000000..a0e669e --- /dev/null +++ b/lib/facter/networkmanager_dns.rb @@ -0,0 +1,22 @@ +Facter.add(:networkmanager_dns) do + setcode do + connections = Facter.value(:networkmanager_connections) + + if connections + dns = {} + nmcli = Facter.value(:networkmanager_nmcli_path) + connections.each do |connection| + dns[connection] = {} + dns[connection][:nameserver] = Facter::Core::Execution.execute("#{nmcli} -g ipv4.dns connection show id #{connection}").split(',') + dns[connection][:search] = Facter::Core::Execution.execute("#{nmcli} -g ipv4.dns-search connection show id #{connection}").split(',') + dns[connection][:options] = Facter::Core::Execution.execute("#{nmcli} -e no -g ipv4.dns-options connection show id #{connection}").split(',') + end + end + + if connections + dns + else + nil + end + end +end diff --git a/lib/facter/networkmanager_nmcli_path.rb b/lib/facter/networkmanager_nmcli_path.rb new file mode 100644 index 0000000..fdf6d6a --- /dev/null +++ b/lib/facter/networkmanager_nmcli_path.rb @@ -0,0 +1,26 @@ +# Cross-platform way of finding an executable in the $PATH. +# +# which('ruby') #=> /usr/bin/ruby +def which(cmd) + std_paths = ['/bin', '/sbin', '/usr/bin', '/usr/sbin', '/usr/local/bin', '/usr/local/sbin'] + exts = (ENV['PATHEXT']) ? ENV['PATHEXT'].split(';') : [''] + ENV['PATH'].split(File::PATH_SEPARATOR).each do |path| + exts.each do |ext| + exe = File.join(path, "#{cmd}#{ext}") + return exe if File.executable?(exe) && !File.directory?(exe) + end + end + std_paths.each do |path| + exts.each do |ext| + exe = File.join(path, "#{cmd}#{ext}") + return exe if File.executable?(exe) && !File.directory?(exe) + end + end + nil +end + +Facter.add(:networkmanager_nmcli_path) do + setcode do + which('nmcli') + end +end diff --git a/lib/facter/networkmanager_primaryconnection.rb b/lib/facter/networkmanager_primaryconnection.rb new file mode 100644 index 0000000..0a30436 --- /dev/null +++ b/lib/facter/networkmanager_primaryconnection.rb @@ -0,0 +1,17 @@ + +Facter.add(:networkmanager_primaryconnection) do + setcode do + nmcli = Facter.value('networkmanager_nmcli_path') + if nmcli + device = Facter.value('networkmanager_primarydevice') + if device + cmd = "#{nmcli} -g general.connection d show #{device}" + Facter::Core::Execution.execute(cmd) + else + nil + end + else + nil + end + end +end diff --git a/lib/facter/networkmanager_primarydevice.rb b/lib/facter/networkmanager_primarydevice.rb new file mode 100644 index 0000000..369c7f7 --- /dev/null +++ b/lib/facter/networkmanager_primarydevice.rb @@ -0,0 +1,31 @@ +def which(cmd) + std_paths = ['/bin', '/sbin', '/usr/bin', '/usr/sbin', '/usr/local/bin', '/usr/local/sbin'] + exts = (ENV['PATHEXT']) ? ENV['PATHEXT'].split(';') : [''] + ENV['PATH'].split(File::PATH_SEPARATOR).each do |path| + exts.each do |ext| + exe = File.join(path, "#{cmd}#{ext}") + return exe if File.executable?(exe) && !File.directory?(exe) + end + end + std_paths.each do |path| + exts.each do |ext| + exe = File.join(path, "#{cmd}#{ext}") + return exe if File.executable?(exe) && !File.directory?(exe) + end + end + nil +end + + +Facter.add(:networkmanager_primarydevice) do + confine kernel: 'Linux' + setcode do + ip = which('ip') + if ip + cmd = 'ip -o link | awk -F": " \'$0 ~ "^2:*" {print $2}\'' + Facter::Core::Execution.execute(cmd) + else + nil + end + end +end diff --git a/manifests/dns.pp b/manifests/dns.pp new file mode 100644 index 0000000..7a0046e --- /dev/null +++ b/manifests/dns.pp @@ -0,0 +1,101 @@ +# @summary Manages the DNS informations about a particular NetworkManager connection +# +# @example +# networkmanager::dns { 'System link': +# nameservers => ['8.8.8.8', '8,.8.4.4', '1.1.1.1'], +# searchdomains => ['example.com', 'uhu-banane.de', 'uhu-banane.net'], +# dns_options => ['timeout:1', 'attempts:2', 'use-vc'], +# notify_daemon => true, +# } +# +# @param nameservers +# An array of the IP addresses of the resolvers to use. At least one address has to be given, +# but if exactly one address is given, a warning will be omitted. +# +# @param searchdomains +# An array of DNS search domains. At least one domain has to be given. +# +# @param dns_options +# A string or an array of strings with resolving options. Please note not to use whitespaces +# inside the strings, only use comma to separate options inside a string. If not given (or undef), +# the options are not managed. To remove existing options use an empty string '' as a value. +# +# @param connection +# The name of the NetworkManager connection. If not given, the name of the resource will be used +# as the name of the connection. +# +# @param notify_daemon +# A boolean flag, whether to notify the NetworkManager daemon after DNS changes. In case of a +# notification the NetworkManager daemon is rewriting /etc/resolv.conf immediately. In this way +# this resorce can be used to manage /etc/resolv.conf. +# **CAUTION**: If you are using another module for managing /etc/resolv.conf (like saz-resolv_conf), +# this option should be set to false to prevent a Ping-Pong game between those two modules. In this +# case this resource is only intended to ensure a correct /etc/resolv.conf immediately after a reboot. +# +define networkmanager::dns ( + Array[Stdlib::IP::Address::Nosubnet, 1] $nameservers, + Array[String[1], 1] $searchdomains, + Optional[Variant[Array[String[1]], String]] $dns_options, + Optional[String[1]] $connection = undef, + Boolean $notify_daemon = true, +) { + + unless $facts['networkmanager_nmcli_path'] { + fail("Did not found NetworkManager command line tool 'nmcli'.") + } + $nmcli = $facts['networkmanager_nmcli_path'] + + if $connection { + $_connection = $connection + } + else { + $_connection = $name + } + + if $nameservers.length() == 1 { + notify { "Only one nameserver was given for NetworkManager connection ${_connection}.": loglevel => warning } + } + + $used_nameservers = $nameservers.join(',') + $has_nameservers = $facts['networkmanager_dns'][$_connection]['nameserver'].join(',') + unless $used_nameservers == $has_nameservers { + exec { "update nameserver nmcli connection ${_connection}": + command => "${nmcli} connection modify ${_connection} ipv4.dns ${used_nameservers}", + } + if $notify_daemon { + Exec["update nameserver nmcli connection ${_connection}"] ~> Class['networkmanager::service'] + } + } + + $used_searchdomains = $searchdomains.join(',') + $has_searchdomains = $facts['networkmanager_dns'][$_connection]['search'].join(',') + unless $used_searchdomains == $has_searchdomains { + exec { "update searchdomains nmcli connection ${_connection}": + command => "${nmcli} connection modify ${_connection} ipv4.dns-search '${used_searchdomains}'", + } + if $notify_daemon { + Exec["update searchdomains nmcli connection ${_connection}"] ~> Class['networkmanager::service'] + } + } + + unless $dns_options == undef { + if is_array($dns_options) { + $used_options = $dns_options.join(',') + } + else { + $used_options = $dns_options + } + + $has_options = $facts['networkmanager_dns'][$_connection]['options'].join(',') + unless $used_options == $has_options { + exec { "update dns-options nmcli connection ${_connection}": + command => "${nmcli} connection modify ${_connection} ipv4.dns-options '${used_options}'", + } + if $notify_daemon { + Exec["update dns-options nmcli connection ${_connection}"] ~> Class['networkmanager::service'] + } + } + + } + +} diff --git a/manifests/init.pp b/manifests/init.pp new file mode 100644 index 0000000..da53e92 --- /dev/null +++ b/manifests/init.pp @@ -0,0 +1,206 @@ +# @summary Manages NetworkManager connections +# +# @author Marko Weltzer +# @author Frank Brehm +# +# @example using simple include +# include networkmanager +# +# @example using class +# class {'networkmanager': +# enable_global_dns => false, +# manage_dns => true, +# nameservers => ['8.8.8.8', '8.8.4.4', '1.1.1.1']. +# dns_searchdomains => ['example.com', 'uhu-banane.de', 'uhu-banane.net'], +# dns_options => ['timeout:1', 'attempts:2', 'use-vc'], +# manage_service => true. +# ensure_service => running, +# enable_service => true, +# dns_notify_daemon => false, +# connection_dnsoptions => { +# wifi1 => { +# nameservers => ['172.28.1.2', '172.30.1.2'], +# searchdomains => ['home.example.com'], +# dns_options => ['timeout:3', 'attempts:3', 'use-vc'], +# notify_daemon => true, +# }, +# }, +# } +# +# @example using hieradata +# --- +# networkmanager::enable_global_dns: false +# networkmanager::manage_dns: true +# networkmanager::nameservers: +# - '8.8.8.8' +# - '8.8.4.4' +# - '1.1.1.1' +# networkmanager::dns_searchdomains: +# - 'example.com' +# - 'uhu-banane.de' +# - 'uhu-banane.net' +# networkmanager::dns_options: +# - 'timeout:1' +# - 'attempts:2' +# - 'use-vc' +# networkmanager::manage_service: true +# networkmanager::ensure_service: running +# networkmanager::enable_service: true +# networkmanager::dns_notify_daemon: false +# networkmanager::connection_dnsoptions: +# wifi1: +# nameservers: +# - '172.28.1.2' +# - '172.30.1.2' +# searchdomains: +# - 'home.example.com' +# dns_options: +# - 'timeout:3' +# - 'attempts:3' +# - 'use-vc' +# notify_daemon: true +# +# @param enable_global_dns +# By enabling this, NetworkManager will not use the connections specific dns settings. +# Instead it will generate a file with the desired dns settings. +# Those parameters are then the default, even if connection specific settings are present. +# +# @param global_nameservers +# An array of the IP addresses for the nameservers for the global setting. +# +# @param global_searchdomains +# An array of DNS search domains for the global setting. +# +# @param global_dns_options +# A string or an array of strings with resolving options for the global setting. +# If omitted, no global resolving optios are set. +# +# @param global_conffile +# The config file for global dns settings. Should be under /etc/NetworkManager/conf.d +# +# @param manage_dns +# Whether we want to manage dns of the primary NetworkManager connection. +# +# @param nameservers +# An array of the IP addresses of the resolvers to use for the primary NetworkManager connection. +# At least one address has to be given, but if exactly one address is given, a warning will be omitted. +# +# @param dns_searchdomains +# An array of DNS search domains to use for the primary NetworkManager connection. +# At least one domain has to be given. +# +# @param dns_options +# A string or an array of strings with resolving options to use for the primary NetworkManager connection. +# Please note not to use whitespaces inside the strings, only use comma to separate options inside +# a string. If not given (or undef), the options are not managed. +# To remove existing options use an empty string '' as a value. +# +# @param manage_service +# Whether we want to manage the NetworkManager service. +# +# @param service_ensure +# Whether a service should be running. Valid values are 'stopped', 'running', true, false. +# +# @param service_name +# The systemd service name of NetworkManager, usually 'NetworkManager'. +# +# @param enable_service +# Whether a service should be enabled to start at boot. +# +# @param restart_service +# Specify a restart command manually. If left unspecified, the service will be stopped and then started. +# +# @param dns_notify_daemon +# A boolean flag, whether to notify the NetworkManager daemon after DNS changea on the primary +# NetworkManager connections. In case of a notification the NetworkManager daemon is rewriting +# /etc/resolv.conf immediately. In this way this resorce can be used to manage /etc/resolv.conf. +# **CAUTION**: If you are using another module for managing /etc/resolv.conf (like saz-resolv_conf), +# this option should be set to false to prevent a Ping-Pong game between those two modules. In this +# case manage_dns is only intended to ensure a correct /etc/resolv.conf immediately after a reboot. +# +# @param connection_dnsoptions +# A hash for creating networkmanager::dns resources for managing DNS options on different NetworkManager +# connections. Be sure not to include the primary NetworkManager connection, if manage_dns is true. +# +class networkmanager ( + Boolean $enable_global_dns, + Array[Stdlib::IP::Address::Nosubnet] $global_nameservers, + Array[String[1]] $global_searchdomains, + Optional[Variant[Array[String[1]], String]] $global_dns_options, + Optional[Stdlib::Absolutepath] $global_conffile, + Boolean $manage_dns, + Array[Stdlib::IP::Address::Nosubnet] $nameservers, + Array[String[1], 1] $dns_searchdomains, + Optional[Variant[Array[String[1]], String]] $dns_options, + Boolean $manage_service, + Optional[Variant[Boolean, String[1]]] $ensure_service, + String[1] $service_name, + Boolean $enable_service, + Optional[String[1]] $restart_service, + Boolean $dns_notify_daemon = true, + Optional[Hash] $connection_dnsoptions = undef, +){ + + unless $facts['networkmanager_nmcli_path'] { + fail("Did not found NetworkManager command line tool 'nmcli'.") + } + + if $enable_global_dns { + + if $global_dns_options { + if is_array($global_dns_options) { + $real_dns_options = join($global_dns_options, ',') + } + else { + $real_dns_options = $global_dns_options + } + } + else { + $real_dns_options = undef + } + + file { $global_conffile: + ensure => file, + mode => '0644', + content => template("${module_name}/dns.erb"), + notify => Class['networkmanager::service'] + } + } + else { + file { $global_conffile: + ensure => absent, + notify => Class['networkmanager::service'] + } + } + + class { 'networkmanager::service': + ensure => $ensure_service, + service_name => $service_name, + enable => $enable_service, + manage => $manage_service, + restart => $restart_service, + } + + if $manage_dns { + + $primary_connection = $facts['networkmanager_primaryconnection'] + + if $primary_connection { + networkmanager::dns { $primary_connection: + nameservers => $nameservers, + searchdomains => $dns_searchdomains, + dns_options => $dns_options, + notify_daemon => $dns_notify_daemon, + } + } + else { + notify { 'Did not found a primary NetworkManager connection.': loglevel => warning } + } + + } + + if $connection_dnsoptions { + create_resources('networkmanager::dns', $connection_dnsoptions) + } + +} diff --git a/manifests/service.pp b/manifests/service.pp new file mode 100644 index 0000000..ed1b448 --- /dev/null +++ b/manifests/service.pp @@ -0,0 +1,58 @@ +# +# @summary Ensure and restarts NetworkManager Service +# +# @example Setting up NetworkManager service +# class { 'networkmanager::service': +# ensure => 'running', +# enable => true, +# manage => true, +# restart => undef, +# } +# +# @param service_name +# The systemd service name of NetworkManager, usually 'NetworkManager'. +# +# @param enable +# Whether a service should be enabled to start at boot. +# +# @param ensure +# Whether a service should be running. Valid values are 'stopped', 'running', true, false. +# +# @param manage +# Whether the service should be managed. If false, then this class has no function. +# +# @param restart +# Specify a restart command manually. If left unspecified, the service will be stopped and then started. +# +# @api private +class networkmanager::service ( + String[1] $service_name = 'NetworkManager', + Boolean $enable = true, + Optional[Variant[Boolean, String[1]]] $ensure = 'running', + Boolean $manage = true, + Optional[String[1]] $restart = undef, +) { + + if $manage { + + case $ensure { + true, false, 'running', 'stopped': { + $_ensure = $ensure + } + default: { + $_ensure = undef + } + } + + $hasrestart = $restart == undef + + service { 'NetworkManager': + ensure => $_ensure, + name => $service_name, + enable => $enable, + restart => $restart, + hasrestart => $hasrestart, + } + } + +} diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..9c36379 --- /dev/null +++ b/metadata.json @@ -0,0 +1,53 @@ +{ + "name": "pixelpark-networkmanager", + "version": "0.3.3", + "author": "pixelpark", + "summary": "A module to manage the networkmanager connections.", + "license": "LGPL-3.0-or-later", + "source": "https://git.pixelpark.com/puppet/networkmanager.git", + "dependencies": [ + { "name": "puppetlabs-stdlib", "version_requirement": ">=7.0.0 <9.0.0" } + ], + "operatingsystem_support": [ + { + "operatingsystem": "CentOS", + "operatingsystemrelease": [ + "7", "8" + ] + }, + { + "operatingsystem": "OracleLinux", + "operatingsystemrelease": [ + "7" + ] + }, + { + "operatingsystem": "RedHat", + "operatingsystemrelease": [ + "8" + ] + }, + { + "operatingsystem": "Debian", + "operatingsystemrelease": [ + "9", + "10" + ] + }, + { + "operatingsystem": "Scientific", + "operatingsystemrelease": [ + "7" + ] + } + ], + "requirements": [ + { + "name": "puppet", + "version_requirement": ">= 6.0.0 < 8.0.0" + } + ], + "pdk-version": "1.18.1", + "template-url": "pdk-default#1.18.1", + "template-ref": "tags/1.18.1-0-g3d2e75c" +} diff --git a/spec/classes/networkmanager_service_spec.rb b/spec/classes/networkmanager_service_spec.rb new file mode 100644 index 0000000..ea764da --- /dev/null +++ b/spec/classes/networkmanager_service_spec.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'networkmanager::service' do + on_supported_os.each do |os, os_facts| + context "on #{os}" do + let(:facts) { os_facts } + + it { is_expected.to compile } + end + end +end diff --git a/spec/classes/networkmanager_spec.rb b/spec/classes/networkmanager_spec.rb new file mode 100644 index 0000000..586a446 --- /dev/null +++ b/spec/classes/networkmanager_spec.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'networkmanager' do + let(:params) do + { + global_nameservers: ['8.8.8.8', '8.8.4.4', '1.1.1.1'], + global_searchdomains: ['example.com', 'uhu-banane.net'], + global_dns_options: '', + nameservers: ['8.8.8.8', '8.8.4.4', '1.1.1.1'], + dns_searchdomains: ['example.com', 'uhu-banane.net'], + } + end + + on_supported_os.each do |os, os_facts| + context "on #{os} without manage_dns" do + let(:facts) { os_facts } + let(:params) do + super().merge(manage_dns: false) + end + + it { is_expected.to compile } + end + + context "on #{os} with manage_dns" do + let(:facts) { os_facts } + let(:params) do + super().merge( + manage_dns: true, + dns_options: ['timeout:3', 'attempts:3', 'use-vc'], + dns_notify_daemon: false, + ) + end + + it { is_expected.to compile } + end + end +end diff --git a/spec/default_facts.yml b/spec/default_facts.yml new file mode 100644 index 0000000..f777abf --- /dev/null +++ b/spec/default_facts.yml @@ -0,0 +1,8 @@ +# Use default_module_facts.yml for module specific facts. +# +# Facts specified here will override the values provided by rspec-puppet-facts. +--- +ipaddress: "172.16.254.254" +ipaddress6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" +is_pe: false +macaddress: "AA:AA:AA:AA:AA:AA" diff --git a/spec/default_module_facts.yml b/spec/default_module_facts.yml new file mode 100644 index 0000000..6b68419 --- /dev/null +++ b/spec/default_module_facts.yml @@ -0,0 +1,21 @@ +--- +networkmanager_primaryconnection: 'eth0' +networkmanager_nmcli_path: '/usr/bin/nmcli' + +networkmanager_dns: + eth0: + nameserver: + - '8.8.8.8' + - '1.1.1.1' + search: + - 'example.com' + - 'uhu-banane.net' + options: [] + connection0: + nameserver: + - '8.8.8.8' + - '1.1.1.1' + search: + - 'example.com' + - 'uhu-banane.net' + options: [] diff --git a/spec/defines/dns_spec.rb b/spec/defines/dns_spec.rb new file mode 100644 index 0000000..6e018d3 --- /dev/null +++ b/spec/defines/dns_spec.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe 'networkmanager::dns' do + let(:title) { 'connection0' } + let(:params) do + { + nameservers: ['8.8.8.8', '8.8.4.4', '1.1.1.1'], + searchdomains: ['example.com', 'uhu-banane.net'], + dns_options: '', + } + end + let(:pre_condition) { 'include networkmanager::service' } + + on_supported_os.each do |os, os_facts| + context "on #{os}" do + let(:facts) { os_facts } + + it { is_expected.to compile } + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..d3778ca --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,57 @@ +# frozen_string_literal: true + +require 'puppetlabs_spec_helper/module_spec_helper' +require 'rspec-puppet-facts' + +require 'spec_helper_local' if File.file?(File.join(File.dirname(__FILE__), 'spec_helper_local.rb')) + +include RspecPuppetFacts + +default_facts = { + puppetversion: Puppet.version, + facterversion: Facter.version, +} + +default_fact_files = [ + File.expand_path(File.join(File.dirname(__FILE__), 'default_facts.yml')), + File.expand_path(File.join(File.dirname(__FILE__), 'default_module_facts.yml')), +] + +default_fact_files.each do |f| + next unless File.exist?(f) && File.readable?(f) && File.size?(f) + + begin + default_facts.merge!(YAML.safe_load(File.read(f), [], [], true)) + rescue => e + RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}" + end +end + +# read default_facts and merge them over what is provided by facterdb +default_facts.each do |fact, value| + add_custom_fact fact, value +end + +RSpec.configure do |c| + c.default_facts = default_facts + c.before :each do + # set to strictest setting for testing + # by default Puppet runs at warning level + Puppet.settings[:strict] = :warning + Puppet.settings[:strict_variables] = true + end + c.filter_run_excluding(bolt: true) unless ENV['GEM_BOLT'] + c.after(:suite) do + end +end + +# Ensures that a module is defined +# @param module_name Name of the module +def ensure_module_defined(module_name) + module_name.split('::').reduce(Object) do |last_module, next_module| + last_module.const_set(next_module, Module.new) unless last_module.const_defined?(next_module, false) + last_module.const_get(next_module, false) + end +end + +# 'spec_overrides' from sync.yml will appear below this line diff --git a/templates/dns.erb b/templates/dns.erb new file mode 100644 index 0000000..de106a3 --- /dev/null +++ b/templates/dns.erb @@ -0,0 +1,9 @@ +[main] +dns=default + +[global-dns] +searches=<% @global_searchdomains.each do |searchdomain| %><%= searchdomain %>,<% end %><% if @real_dns_options %> +options=<%= @real_dns_options %><% end %> + +[global-dns-domain-*] +servers=<% @global_nameservers.each do |nameserver| %><%= nameserver %>,<% end %>