foreman_userdata 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b7112089e0d77990b90ae1a8a04904532408f8a9
-  data.tar.gz: 3a024af5e6b794776a672973c2fff5dddd52d30c
+SHA256:
+  metadata.gz: 5d6869feb991a28777d8dbb81c5245bf558a1b5749dfa256f4fd4a6e0e5c9db5
+  data.tar.gz: 5b76c05add078863aeed559e72964bdd8896c9bc92c06422e59aa7648fc131dd
 SHA512:
-  metadata.gz: 8eae493b1aee10360801ddffe9c8024551359ee9e002474f8f68abe60970f08f7df1b54792a26b06452526775a7c8199aa13b0db6fb95242230b724b6d26a82e
-  data.tar.gz: b8a09691e46e1280295a0105ac0284e664ad35013b316d00811443f0b40132aafe983677ece1c13ec7cebc5fb33108be9d155cd547121e4edc3a2f5a9d1692e6
+  metadata.gz: 06075e10a78c2bf3f38f570ff9aee40759ba45604a37dcf1b252d70b52db6f718ece840a018738f0158966a6e17b6c5f3bd33afb8b22d3683e738257b98d5555
+  data.tar.gz: b23336f4d8f2ef1ecb9753355e3821e9f7634abfaa405afdd81036014e95e7418496b071984daffcdd4dd744d78dc7bdacbab28c97fa075de3ff5b010f5a18d9

data/README.md

@@ -14,6 +14,22 @@ See [Plugins install instructions](https://theforeman.org/plugins/)
 for how to install Foreman plugins.
 You need to install the package `tfm-rubygem-foreman_userdata`.
 
+## Motivation
+
+This plug-in was developed to be used with VMWare vSphere provisioning from VMWare templates.
+vSphere offers the functionality to customize the templates during cloning. This is very handy for changing the network settings of a newly cloned VM.
+Foreman fully supports this feature via a userdata template. [The Foreman handbook](https://theforeman.org/manuals/1.17/index.html#image-provisioning-without-ssh) has details on how to configure this.
+The amount of things vSphere allows a user to customize are very limited, though. It's not possible to run a finish script or setup puppet with valid certificates on the new VM.
+This can be worked around by setting up a two step process: vSphere customization is just used to set up the network config of the host. Cloud-init is used to do the rest of the customization on first boot.
+Templates for Linux hosts are seeded when you install this plugin. Make sure you associate both `CloudInit default` and `UserData open-vm-tools` templates with the operatingsystem of your host and choose them as the default `userdata` and `cloud-init` templates.
+
+This leads to this workflow:
+1. An administrator creates a vSphere VM template and makes sure the cloud-init application is installed in the template VM as described below in the client setup section.
+2. Foreman creates a new cloned VM in vSphere and passes the userdata template (UserData open-vm-tools) to vSphere if the template is properly assigned to the host.
+3. vSphere changes the network settings of the new host as defined in the userdata template and boots the new VM.
+4. The VM runs cloud-init and asks Foreman for the cloud-init template (CloudInit default) if the template has been properly assinged to the host. Your VM needs network access to Foreman on ports `tcp/80` and `tcp/443`. Cloud-init then runs the template and executes the defined actions.
+5. Cloud-init signals Foreman that the host has been built successfully.
+
 ## Client setup
 
 On RHEL7 using cloud-init from EPEL:

data/Rakefile

@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError => _
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/userdata_controller.rb

@@ -51,7 +51,12 @@ class UserdataController < ApplicationController
   end
 
   def safe_render(template)
-    @host.render_template(template)
+    # Foreman >= 1.20
+    if template.respond_to?(:render)
+      template.render(host: @host, params: params)
+    else
+      @host.render_template(template)
+    end
   rescue StandardError => error
     Foreman::Logging.exception("Error rendering the #{template.name} template", error)
     render_error(
@@ -60,7 +65,7 @@ class UserdataController < ApplicationController
       :error => error.message,
       :status => :internal_server_error
     )
-    return false
+    false
   end
 
   def skip_secure_headers
@@ -101,9 +106,7 @@ class UserdataController < ApplicationController
     ip = request.env['REMOTE_ADDR']
 
     # check if someone is asking on behalf of another system (load balancer etc)
-    if request.env['HTTP_X_FORWARDED_FOR'].present? && (ip =~ Regexp.new(Setting[:remote_addr]))
-      ip = request.env['HTTP_X_FORWARDED_FOR']
-    end
+    ip = request.env['HTTP_X_FORWARDED_FOR'] if request.env['HTTP_X_FORWARDED_FOR'].present? && (ip =~ Regexp.new(Setting[:remote_addr]))
 
     ip
   end

data/app/views/foreman/unattended/provisioning_templates/cloud_init/cloud_init_default.erb

@@ -0,0 +1,39 @@
+<%#
+kind: cloud_init
+name: CloudInit default
+model: ProvisioningTemplate
+oses:
+- CentOS
+- Fedora
+- Debian
+- Ubuntu
+-%>
+<%#
+This template accepts the following parameters:
+- force-puppet: boolean (default=false)
+- enable-puppetlabs-repo: boolean (default=false)
+- enable-puppetlabs-pc1-repo: boolean (default=false)
+- enable-puppetlabs-puppet5-repo: boolean (default=false)
+%>
+<%
+  pm_set = @host.puppetmaster.empty? ? false : true
+  puppet_enabled = pm_set || host_param_true?('force-puppet')
+%>
+#cloud-config
+hostname: <%= @host.name %>
+fqdn: <%= @host %>
+manage_etc_hosts: true
+users: {}
+runcmd:
+- |
+<% if puppet_enabled %>
+<% if host_param_true?('enable-puppetlabs-pc1-repo') || host_param_true?('enable-puppetlabs-repo') || host_param_true?('enable-puppetlabs-puppet5-repo') -%>
+<%= snippet 'puppetlabs_repo' %>
+<% end -%>
+<%= indent(2) { snippet('puppet_setup_cloudinit') } %>
+<% end -%>
+
+phone_home:
+  url: <%= foreman_url('built') %>
+  post: []
+  tries: 10

data/app/views/foreman/unattended/provisioning_templates/snippet/puppet_setup_cloudinit.erb

@@ -0,0 +1,85 @@
+<%#
+kind: snippet
+name: puppet_setup_cloudinit
+model: ProvisioningTemplate
+description: this snippet will configure the Puppet agent from within cloudinit
+snippet: true
+%>
+<%
+os_family = @host.operatingsystem.family
+os_major  = @host.operatingsystem.major.to_i
+os_name   = @host.operatingsystem.name
+aio_enabled = host_param_true?('enable-puppetlabs-puppet5-repo') || host_param_true?('enable-puppetlabs-pc1-repo') || host_param_true?('enable-puppet4') || host_param_true?('enable-puppet5')
+if os_family == 'Freebsd'
+  freebsd_package = host_param_true?('enable-puppet5') ? 'puppet5' : 'puppet4'
+  etc_path = '/usr/local/etc/puppet'
+  bin_path = '/usr/local/bin'
+elsif aio_enabled
+  linux_package = 'puppet-agent'
+  etc_path = '/etc/puppetlabs/puppet'
+  bin_path = '/opt/puppetlabs/bin'
+else
+  linux_package = os_family == 'Suse' ? 'rubygem-puppet' : 'puppet'
+  etc_path = '/etc/puppet'
+  bin_path = '/usr/bin'
+end
+%>
+
+<% if os_family == 'Debian' -%>
+apt-get update
+apt-get install -y <%= linux_package %>
+<% elsif os_family == 'Freebsd' -%>
+pkg install -y <%= freebsd_package %>
+<% elsif os_family == 'Redhat' -%>
+if [ -f /usr/bin/dnf ]; then
+  dnf -y install <%= linux_package %>
+else
+  yum -t -y install <%= linux_package %>
+fi
+<% elsif os_family == 'Suse' -%>
+<% if host_param_true?('enable-puppetlabs-pc1-repo') || host_param_true?('enable-puppetlabs-puppet5-repo') -%>
+rpmkeys --import http://yum.puppetlabs.com/RPM-GPG-KEY-puppetlabs
+rpmkeys --import http://yum.puppetlabs.com/RPM-GPG-KEY-puppet
+<% end -%>
+<% if @host.provision_method == 'image' -%>
+/usr/bin/zypper -n install <%= linux_package %>
+<% end -%>
+
+cat > <%= etc_path %>/puppet.conf << EOF
+<%= snippet 'puppet.conf' %>
+EOF
+
+<% if os_family == 'Redhat' -%>
+<% if os_major > 6 -%>
+puppet_unit=puppet
+/usr/bin/systemctl list-unit-files | grep -q puppetagent && puppet_unit=puppetagent
+/usr/bin/systemctl enable ${puppet_unit}
+<% else -%>
+/sbin/chkconfig --level 345 puppet on
+<% end -%>
+<% end -%>
+<% if os_family == 'Freebsd' -%>
+echo 'puppet_enable="YES"' >>/etc/rc.conf
+<% end -%>
+<% unless aio_enabled -%>
+<% if os_family == 'Debian' -%>
+if [ -f "/etc/default/puppet" ]
+then
+/bin/sed -i 's/^START=no/START=yes/' /etc/default/puppet
+fi
+<%= bin_path %>/puppet agent --enable
+<% elsif os_family == 'Suse' -%>
+if [ -f "/etc/sysconfig/puppet" ]
+then
+/usr/bin/sed -ie s/^PUPPET_SERVER=.*/PUPPET_SERVER=<%= @host.puppetmaster.blank? ? '' : @host.puppetmaster %>/ /etc/sysconfig/puppet
+fi
+<% end -%>
+<% end -%>
+<% end -%>
+<%= bin_path %>/puppet agent --config <%= etc_path %>/puppet.conf --onetime <%= @host.puppetmaster.blank? ? '' : "--server #{@host.puppetmaster}" %> --no-daemonize
+<% if os_family == 'Suse' || (os_name == 'Debian' && os_major > 8) || (os_name == 'Ubuntu' && os_major >= 15) -%>
+<%= bin_path %>/puppet resource service puppet enable=true
+<% if @host.provision_method == 'image' -%>
+<%= bin_path %>/puppet resource service puppet ensure=running
+<% end -%>
+<% end -%>

data/app/views/foreman/unattended/provisioning_templates/user_data/userdata_open_vm_tools.erb

@@ -0,0 +1,36 @@
+<%#
+kind: user_data
+name: UserData open-vm-tools
+model: ProvisioningTemplate
+oses:
+- CentOS
+- Fedora
+- Debian
+- Ubuntu
+-%>
+# Template for VMWare customization via open-vm-tools
+
+identity:
+  LinuxPrep:
+    domain: <%= @host.domain %>
+    hostName: <%= @host.shortname %>
+    hwClockUTC: true
+    timeZone: <%= host_param('time-zone') || 'UTC' %>
+
+globalIPSettings:
+  dnsSuffixList: [<%= @host.domain %>]
+  <%- @host.interfaces.each do |interface| -%>
+  <%- next unless interface.subnet -%>
+  dnsServerList: [<%= interface.subnet.dns_primary %>, <%= interface.subnet.dns_secondary %>]
+  <%- end -%>
+
+nicSettingMap:
+<%- @host.interfaces.each do |interface| -%>
+<%- next unless interface.subnet -%>
+  - adapter:
+      dnsDomain: <%= interface.domain %>
+      dnsServerList: [<%= interface.subnet.dns_primary %>, <%= interface.subnet.dns_secondary %>]
+      gateway: [<%= interface.subnet.gateway %>]
+      ip: <%= interface.ip %>
+      subnetMask: <%= interface.subnet.mask %>
+<%- end -%>

data/db/seeds.d/103-cloud_init_provisioning_templates.rb

@@ -0,0 +1,19 @@
+User.as_anonymous_admin do
+  templates = [
+    { name: 'CloudInit default', source: 'cloud_init/cloud_init_default.erb', template_kind: TemplateKind.find_by(name: 'cloud-init') },
+    { name: 'puppet_setup_cloudinit', source: 'snippet/puppet_setup_cloudinit.erb', snippet: true },
+    { name: 'UserData open-vm-tools', source: 'user_data/userdata_open_vm_tools.erb', template_kind: TemplateKind.find_by(name: 'user_data') }
+  ]
+  templates.each do |template|
+    template[:contents] = File.read(File.join(ForemanUserdata::Engine.root, 'app/views/foreman/unattended/provisioning_templates', template[:source]))
+    ProvisioningTemplate.where(name: template[:name]).first_or_create do |pt|
+      pt.vendor = 'ForemanUserdata'
+      pt.default = true
+      pt.locked = true
+      pt.name = template[:name]
+      pt.template = template[:contents]
+      pt.template_kind = template[:template_kind] if template[:template_kind]
+      pt.snippet = template[:snippet] if template[:snippet]
+    end
+  end
+end

data/lib/foreman_userdata/version.rb

@@ -1,3 +1,3 @@
 module ForemanUserdata
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/tasks/foreman_userdata_tasks.rake

@@ -29,7 +29,7 @@ namespace :foreman_userdata do
                          "#{ForemanUserdata::Engine.root}/lib/**/*.rb",
                          "#{ForemanUserdata::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue LoadError
       puts 'Rubocop not loaded.'
     end
 
@@ -40,6 +40,4 @@ end
 Rake::Task[:test].enhance ['test:foreman_userdata']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_userdata', 'foreman_userdata:rubocop']
-end
+Rake::Task['jenkins:unit'].enhance ['test:foreman_userdata', 'foreman_userdata:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/test/controllers/userdata_controller_test.rb

@@ -2,14 +2,14 @@ require 'test_plugin_helper'
 
 class UserdataControllerTest < ActionController::TestCase
   context '#user-data' do
-    let(:organization) { FactoryGirl.create(:organization) }
-    let(:tax_location) { FactoryGirl.create(:location) }
+    let(:organization) { FactoryBot.create(:organization) }
+    let(:tax_location) { FactoryBot.create(:location) }
     let(:user_data_content) { 'template content user_data' }
     let(:cloud_init_content) { 'template content cloud-init' }
-    let(:user_data_template_kind) { FactoryGirl.create(:template_kind, :name => 'user_data') }
-    let(:cloud_init_template_kind) { FactoryGirl.create(:template_kind, :name => 'cloud-init') }
+    let(:user_data_template_kind) { FactoryBot.create(:template_kind, :name => 'user_data') }
+    let(:cloud_init_template_kind) { FactoryBot.create(:template_kind, :name => 'cloud-init') }
     let(:user_data_template) do
-      FactoryGirl.create(
+      FactoryBot.create(
         :provisioning_template,
         :template_kind => user_data_template_kind,
         :template => user_data_content,
@@ -18,7 +18,7 @@ class UserdataControllerTest < ActionController::TestCase
       )
     end
     let(:cloud_init_template) do
-      FactoryGirl.create(
+      FactoryBot.create(
         :provisioning_template,
         :template_kind => cloud_init_template_kind,
         :template => cloud_init_content,
@@ -27,7 +27,7 @@ class UserdataControllerTest < ActionController::TestCase
       )
     end
     let(:os) do
-      FactoryGirl.create(
+      FactoryBot.create(
         :operatingsystem,
         :with_associations,
         :family => 'Redhat',
@@ -38,7 +38,7 @@ class UserdataControllerTest < ActionController::TestCase
       )
     end
     let(:host) do
-      FactoryGirl.create(
+      FactoryBot.create(
         :host,
         :managed,
         :operatingsystem => os,
@@ -48,7 +48,7 @@ class UserdataControllerTest < ActionController::TestCase
     end
 
     setup do
-      FactoryGirl.create(
+      FactoryBot.create(
         :os_default_template,
         :template_kind => user_data_template_kind,
         :provisioning_template => user_data_template,
@@ -67,7 +67,7 @@ class UserdataControllerTest < ActionController::TestCase
 
     context 'with cloud-init template' do
       setup do
-        FactoryGirl.create(
+        FactoryBot.create(
           :os_default_template,
           :template_kind => cloud_init_template_kind,
           :provisioning_template => cloud_init_template,
@@ -84,7 +84,7 @@ class UserdataControllerTest < ActionController::TestCase
   end
 
   context '#metadata' do
-    let(:host) { FactoryGirl.create(:host, :managed) }
+    let(:host) { FactoryBot.create(:host, :managed) }
     setup do
       @request.env['REMOTE_ADDR'] = host.ip
     end
@@ -93,7 +93,7 @@ class UserdataControllerTest < ActionController::TestCase
       get :metadata
       assert_response :success
       response = @response.body
-      parsed = YAML.load(response)
+      parsed = YAML.safe_load(response)
       assert_equal host.mac, parsed['mac']
       assert_equal host.hostname, parsed['hostname']
     end

data/test/lib/tasks/seeds_test.rb

@@ -0,0 +1,33 @@
+require 'test_plugin_helper'
+
+module ForemanUserdata
+  class SeedsTest < ActiveSupport::TestCase
+    setup do
+      Foreman.stubs(:in_rake?).returns(true)
+    end
+
+    test 'seeds cloud-init provisioning templates' do
+      seed
+      assert ProvisioningTemplate.unscoped.where(default: true).exists?
+      expected_template_names = [
+        'CloudInit default',
+        'puppet_setup_cloudinit',
+        'UserData open-vm-tools'
+      ]
+
+      seeded_templates = ProvisioningTemplate.unscoped.where(default: true, vendor: 'ForemanUserdata').pluck(:name)
+
+      expected_template_names.each do |template|
+        assert_includes seeded_templates, template
+      end
+    end
+
+    private
+
+    def seed
+      User.current = FactoryBot.build(:user, admin: true,
+                                             organizations: [], locations: [])
+      load Rails.root.join('db', 'seeds.rb')
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -1,18 +1,3 @@
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 require 'database_cleaner'
-
-# Foreman's setup doesn't handle cleaning up for Minitest::Spec
-DatabaseCleaner.strategy = :transaction
-
-module Minitest
-  class Spec
-    before :each do
-      DatabaseCleaner.start
-    end
-
-    after :each do
-      DatabaseCleaner.clean
-    end
-  end
-end

data/test/unit/foreman_userdata/renderer_test.rb

@@ -0,0 +1,103 @@
+require 'test_plugin_helper'
+require 'minitest/hooks'
+
+module ForemanUserdata
+  class RendererTest < ActiveSupport::TestCase
+    # Disable AR transactional tests as we use DatabaseCleaner's truncation
+    # seeds are loaded once for every context block to speed up tests
+    self.use_transactional_tests = false
+
+    # active_support_test_case_helper loads all fixtures by default
+    # This overrides the seeded data so we reset the fixture list here
+    self.fixture_table_names = []
+
+    fixtures :settings, :taxonomies, :users
+
+    TEMPLATES = [
+      'CloudInit default',
+      'UserData open-vm-tools'
+    ].freeze
+
+    setup do
+      User.current = FactoryBot.create(:user, admin: true,
+                                              organizations: [], locations: [])
+    end
+
+    teardown do
+      User.current = nil
+    end
+
+    describe 'templates seeded by this plugin' do
+      include Minitest::Hooks
+      before(:all) do
+        DatabaseCleaner.clean_with :truncation
+        seed
+      end
+
+      after(:all) do
+        DatabaseCleaner.clean_with :truncation
+      end
+
+      let(:host) do
+        FactoryBot.create(
+          :host, :managed,
+          :with_puppet, :with_puppet_ca, :with_environment,
+          :with_subnet, :with_hostgroup
+        ).tap do |h|
+          h.subnet.dns_primary = '8.8.8.8'
+          h.subnet.dns_secondary = '8.8.4.4'
+          h.save!
+        end
+      end
+
+      context 'safe mode' do
+        setup do
+          Setting[:safemode_render] = true
+        end
+
+        TEMPLATES.each do |template_name|
+          test "renders #{template_name} template without errors" do
+            assert_template(template_name)
+          end
+        end
+      end
+
+      context 'unsafe mode' do
+        setup do
+          Setting[:safemode_render] = false
+        end
+
+        TEMPLATES.each do |template_name|
+          test "renders #{template_name} template without errors" do
+            assert_template(template_name)
+          end
+        end
+      end
+    end
+
+    private
+
+    def assert_template(template_name)
+      template = ProvisioningTemplate.unscoped.find_by(name: template_name)
+      assert_not_nil template
+      rendered_template = render_template(template)
+      assert rendered_template
+      assert YAML.safe_load(rendered_template)
+    end
+
+    def render_template(template)
+      # Foreman >= 1.20
+      if template.respond_to?(:render)
+        template.render(host: host)
+      else
+        host.render_template(template)
+      end
+    end
+
+    def seed
+      User.current = FactoryBot.build(:user, admin: true,
+                                             organizations: [], locations: [])
+      load Rails.root.join('db', 'seeds.rb')
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: foreman_userdata
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Timo Goebel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-hooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.54.0
 description: This plug-in adds support for serving user-data for cloud-init to The
   Foreman.
 email:
@@ -50,14 +64,20 @@ files:
 - README.md
 - Rakefile
 - app/controllers/userdata_controller.rb
+- app/views/foreman/unattended/provisioning_templates/cloud_init/cloud_init_default.erb
+- app/views/foreman/unattended/provisioning_templates/snippet/puppet_setup_cloudinit.erb
+- app/views/foreman/unattended/provisioning_templates/user_data/userdata_open_vm_tools.erb
 - config/routes.rb
-- db/seeds.d/50_cloud_init_template_kind.rb
+- db/seeds.d/050-cloud_init_template_kind.rb
+- db/seeds.d/103-cloud_init_provisioning_templates.rb
 - lib/foreman_userdata.rb
 - lib/foreman_userdata/engine.rb
 - lib/foreman_userdata/version.rb
 - lib/tasks/foreman_userdata_tasks.rake
 - test/controllers/userdata_controller_test.rb
+- test/lib/tasks/seeds_test.rb
 - test/test_plugin_helper.rb
+- test/unit/foreman_userdata/renderer_test.rb
 homepage: http://github.com/theforeman/foreman_userdata
 licenses:
 - GPL-3
@@ -78,10 +98,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This plug-in adds support for serving user-data for cloud-init to The Foreman.
 test_files:
-- test/controllers/userdata_controller_test.rb
+- test/unit/foreman_userdata/renderer_test.rb
+- test/lib/tasks/seeds_test.rb
 - test/test_plugin_helper.rb
+- test/controllers/userdata_controller_test.rb