vagrant-em-demos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3b112c514632342110ca68fde78d575498ece865d9b96e3602867c250d7e65f
+  data.tar.gz: 403a9897dfd29c47583728699ea664fdfff1ab5bb118e24f092d091ee178b8c3
+SHA512:
+  metadata.gz: d517770aab989f68f06f1d964b2a8cc340b80007744daceeba8c899fc53baba911698edcce5851a169b6ddb4fb365f595d902571be3e1805250af338c47247cb
+  data.tar.gz: d637dc143dd55fe02fe727b4873a18b0a3827065b22394a92d26615a08fb3103cec562833a24bc1ebc725240ff4c199d95c7276f058918750f12ea7acf4d8aec

data/code/environments/plugin/hiera.yaml

@@ -0,0 +1,17 @@
+---
+version: 5
+defaults:  # Used for any hierarchy level that omits these keys.
+  datadir: hieradata         # This path is relative to hiera.yaml's directory.
+  data_hash: yaml_data       # Use the built-in YAML backend.
+
+hierarchy:
+  - name: "Per-node data"                   # Human-readable name.
+    paths:
+      - "nodes/%{networking.hostname}.yaml"  # File path, relative to datadir.
+      - "nodes/%{networking.fqdn}.yaml"
+
+  - name: "Deployment Zone" # Uses custom facts.
+    path: "deployment_zones/%{::deployment_zone}.yaml"
+
+  - name: "Defaults"
+    path: "defaults.yaml"

data/code/environments/plugin/hieradata/deployment_zones/vagrant.yaml

@@ -0,0 +1 @@
+profile::base::hosts::list: {}

data/code/environments/plugin/hieradata/nodes/puppetserver.yaml

@@ -0,0 +1,2 @@
+---
+role: role::puppetserver

data/code/environments/plugin/manifests/site.pp

@@ -0,0 +1,14 @@
+include stdlib                       # Make sure the standard functions are available
+if defined(easy_type::license::activate) {
+  include easy_type::license::activate  # Always include the license class. This makes sure all the license files are copied
+}
+
+#
+# This is the schedule used for applying patches. The databases and WebLogic instances
+# might go down during these times.
+#
+schedule { 'maintenance-window':
+  range  => "00:00 - 23:59"  # Change to your requirements
+}
+
+lookup('role', String).include

data/code/environments/plugin/modules/profile/manifests/base/config.pp

@@ -0,0 +1,11 @@
+#
+# This is the base configuration. It is the same for ALL nodes
+#
+class profile::base::config()
+{
+  if $::kernel == 'Linux' {
+    class { 'timezone':
+      timezone => 'Europe/Amsterdam',
+    }
+  }
+}

data/code/environments/plugin/modules/profile/manifests/base/hosts.pp

@@ -0,0 +1,13 @@
+#
+# Make sure all required nodes are in the hosts file.
+#
+class profile::base::hosts(
+  Hash $list,
+)
+{
+  $list.each |$host, $values| {
+    host { $host:
+      * => $values,
+    }
+  }
+}

data/code/environments/plugin/modules/profile/manifests/base/packages.pp

@@ -0,0 +1,13 @@
+#
+# Make sure all required packages are installed
+#
+class profile::base::packages()
+{
+  $required_package = [
+  ]
+
+  package{ $required_package:
+    ensure => 'installed',
+  }
+
+}

data/code/environments/plugin/modules/profile/manifests/base/vagrant.pp

@@ -0,0 +1,39 @@
+# Contains all development specific stuff on vagrant boxes
+class profile::base::vagrant()
+{
+
+    if $::kernel == 'Linux' {
+
+      $required_packages = [
+        'mlocate',
+        'unzip',
+      ]
+
+      package{ $required_packages:
+        ensure => 'installed',
+      }
+
+      exec { 'create swap file':
+        command => '/bin/dd if=/dev/zero of=/var/swap.1 bs=1M count=8192',
+        creates => '/var/swap.1',
+      }
+
+      -> exec { 'attach swap file':
+        command => '/sbin/mkswap /var/swap.1 && /sbin/swapon /var/swap.1',
+        unless  => '/sbin/swapon -s | grep /var/swap.1',
+      }
+
+      #add swap file entry to fstab
+      -> exec {'add swapfile entry to fstab':
+        command => '/bin/echo >>/etc/fstab /var/swap.1 swap swap defaults 0 0',
+        user    => root,
+        unless  => "/bin/grep '^/var/swap.1' /etc/fstab 2>/dev/null",
+      }
+    } elsif $::kernel == 'windows' {
+      # For performance reasons in VirtualBox
+      exec { 'disable windows defender':
+        command  => 'Set-MpPreference -DisableArchiveScanning $true -DisableRealtimeMonitoring $true',
+        provider => 'powershell',
+      }
+    }
+}

data/code/environments/plugin/modules/profile/manifests/base.pp

@@ -0,0 +1,8 @@
+# TODO: Docs
+class profile::base()
+{
+  contain "profile::base::${::deployment_zone}"
+  contain profile::base::config
+  contain profile::base::hosts
+  contain profile::base::packages
+}

data/code/environments/plugin/modules/profile/manifests/puppetserver.pp

@@ -0,0 +1,20 @@
+class profile::puppetserver()
+{
+  package {
+    'puppetserver':
+      ensure => 'present';
+  }
+
+  -> service { 'puppetserver':
+    ensure => 'running',
+  }
+
+  -> class { 'puppetdb':
+    postgresql_ssl_on       => false,
+    database_host           => 'puppetserver.example.com',
+    database_listen_address => '0.0.0.0',
+    manage_firewall         => false,
+  }
+
+  class { 'puppetdb::master::config': }
+}

data/code/environments/plugin/modules/role/manifests/puppet_enterprise.pp

@@ -0,0 +1 @@
+class role::puppet_enterprise {}

data/code/environments/plugin/modules/role/manifests/puppetserver.pp

@@ -0,0 +1,7 @@
+class role::puppetserver(){
+  contain profile::base
+  contain profile::puppetserver
+
+  Class['profile::base']
+  -> Class['profile::puppetserver']
+}

data/lib/vagrant/em/demos/Vagrantfile.rb

@@ -0,0 +1,42 @@
+require "yaml"
+
+module Vagrant
+  class Vagrantfile
+    def initialize(loader, keys)
+      @keys = keys
+      @loader = loader
+      @config, _ = loader.load(keys)
+      @logger = Log4r::Logger.new("vagrant::vagrantfile")
+      vagrant_root = Dir.pwd
+      @config.ssh.insert_key = false
+      config_reader = Vagrant::ConfigReader.new("#{vagrant_root}/#{@config.em.config_file}")
+      @models = config_reader.read_configuration
+      File.write("#{vagrant_root}/puppet_version", ENV["PUPPET_VERSION"]) if ENV["PUPPET_VERSION"]
+      @models.each do |model|
+        config.vm.define model.name do |vm|
+          raise InvalidType if model.type.empty?
+
+          @provisioners = []
+
+          class_name = "Vagrant::EM::#{model.type.split("-").map(&:capitalize).join}"
+          if Object.const_defined?(class_name)
+            Object.const_get(class_name).setup(config, vm, model, @provisioners, @models)
+          else
+            raise "#{model.type} is invalid."
+          end
+          apply_provisioners(config, vm, model)
+        end
+      end
+    end
+
+    private
+
+    def apply_provisioners(config, vm, servers)
+      @provisioners.each do |provisioner|
+        provisioner.each do |type, options|
+          vm.vm.provision type, **options
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/adress_manager.rb

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  class AdressManager
+    require 'singleton'
+
+    include Singleton
+
+    def initialize(base_ip)
+      @base_ip = base_ip
+      @registered_nodes = {}
+      @next_ip_index = 1 # Start from the first available IP after the base
+    end
+
+    def self.instance(base_ip)
+      @instance ||= new(base_ip)
+    end
+
+    def register_node(node_name)
+      return @registered_nodes[node_name] if @registered_nodes.key?(node_name)
+
+      # Generate the next IP address
+      new_ip = generate_ip(@next_ip_index)
+      @registered_nodes[node_name] = new_ip
+      @next_ip_index += 1 # Increment for the next node
+      new_ip
+    end
+
+    private
+
+    def generate_ip(index)
+      # Assuming the base IP is in the format "192.168.1.1"
+      base_parts = @base_ip.split('.').map(&:to_i)
+      last_part = base_parts[3] + index
+
+      if last_part > 250
+        base_parts[2] += last_part / 256 # Increment the second to last part
+        base_parts[3] = last_part % 256   # Set the last part to the remainder
+      else
+        base_parts[3] = last_part
+      end
+
+      "#{base_parts[0]}.#{base_parts[1]}.#{base_parts[2]}.#{base_parts[3]}"
+    end
+  end
+end

data/lib/vagrant/em/demos/command/cleanup.rb

@@ -0,0 +1,29 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Em
+    module Demos
+      module Command
+        class Cleanup < Vagrant.plugin("2", :command)
+          def execute
+            destination_dir = "./modules/software/files/"
+            @env.ui.info("Cleaning up software files...")
+            # Get the active machines and their configurations
+            with_target_vms(ARGV[1]) do |machine|
+              model = machine.env.vagrantfile.instance_variable_get(:@models).find { |m| m.name == machine.name.to_s }
+              next if model.nil?
+
+              model.software_files&.each do |file|
+                if File.exist?("#{destination_dir}/#{file}")
+                  @env.ui.info("Removing File #{file} for #{machine.name}...")
+                  FileUtils.rm("#{destination_dir}/#{file}")
+                end
+              end
+            end
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/command/prepare.rb

@@ -0,0 +1,35 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Em
+    module Demos
+      module Command
+        class Prepare < Vagrant.plugin("2", :command)
+          def execute
+            raise "Must specify a VM name" if ARGV[1].nil?
+            @env.ui.info("Copying required software files...")
+
+            # Get the active machines and their configurations
+            with_target_vms(ARGV[1]) do |machine|
+              source_dir = File.expand_path("~/software")
+              destination_dir = "./modules/software/files/"
+              FileUtils.mkdir_p(destination_dir)
+
+              model = machine.env.vagrantfile.instance_variable_get(:@models).find { |m| m.name == ARGV[1] }
+              model.software_files.each do |file|
+                if File.exist?("#{destination_dir}/#{file}")
+                  @env.ui.info("Skipping File #{file} as it already exists...")
+                else
+                  # Copy files from source to destination
+                  @env.ui.info("Fetching File #{file}...")
+                  FileUtils.cp("#{source_dir}/#{file}", destination_dir)
+                end
+              end
+            end
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/config.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Em
+    module Demos
+      class Config < Vagrant.plugin("2", :config)
+        attr_accessor :config_file
+
+        def initialize
+          @config_file = UNSET_VALUE
+        end
+
+        def finalize!
+          @config_file = "servers.yaml" if @config_file == UNSET_VALUE
+        end
+
+        def validate(machine)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/config_reader.rb

@@ -0,0 +1,118 @@
+require "yaml"
+
+module Vagrant
+  class ConfigReader
+    VALID_KEYS = [
+      "dhcp_fix",
+      "public_ip",
+      "private_ip",
+      "domain_name",
+      "additional_hosts",
+      "box",
+      "puppet_master",
+      "disks",
+      "cluster",
+      "puppet_installer",
+      "required_plugins",
+      "software_files",
+      "protocol",
+      "type",
+      "cpucount",
+      "ram",
+      "virtualboxorafix",
+      "needs_storage",
+      "custom_facts",
+      "mount_uid",
+      "mount_gid",
+      "run_r10k",
+      "ip_start_address",
+      "prefix"
+    ]
+
+    def initialize(yaml_path)
+      @yaml_path = yaml_path
+    end
+
+    def read_configuration
+      content = YAML.load_file(@yaml_path)
+      processed_content = process_content(content)
+      merged_content = merge_defaults(processed_content)
+      validate_definitions!(merged_content)
+
+      # Convert validated YAML to Server objects
+      merged_content.each_with_index.collect { |(name, attributes) , index|
+        Models::Server.new(name, attributes, index)
+      }
+    end
+
+    private
+
+    def process_content(content)
+      processed_content = {}
+      content.each do |key, values|
+        if ["ml-", "pe-", "ps-"].include?(key[0, 3]) || key == "defaults"
+          processed_content[key] = values
+        else
+          processed_content["ml-#{key}"] = values
+          processed_content["pe-#{key}"] = values
+          processed_content["ps-#{key}"] = values
+        end
+      end
+      processed_content
+    end
+
+    def merge_defaults(content)
+      defaults_file = File.join(File.dirname(__FILE__), "defaults.yaml")
+      gem_defaults = YAML.load_file(defaults_file)
+
+      defaults    = gem_defaults.delete("defaults").merge(content.delete("defaults") || {})
+      pe_defaults = gem_defaults.delete("pe-defaults").merge(content.delete("pe-defaults") || {})
+      ml_defaults = gem_defaults.delete("ml-defaults").merge(content.delete("ml-defaults") || {})
+      ps_defaults = gem_defaults.delete("ps-defaults").merge(content.delete("ps-defaults") || {})
+      content.merge!(gem_defaults)
+
+      content.each do |key, values|
+        case key[0, 3]
+        when "ml-"
+          content[key] = defaults.merge(ml_defaults).merge(values)
+        when "pe-"
+          content[key] = defaults.merge(pe_defaults).merge(values)
+        when "ps-"
+          content[key] = defaults.merge(ps_defaults).merge(values)
+        end
+      end
+
+      validate_definitions!(content)
+      content
+    end
+
+    def validate_definitions!(content)
+      errors = []
+
+      content.each do |key, values|
+        # errors << validate_node_prefix(key)
+        errors << validate_known_keys(key, values)
+      end
+
+      errors.compact!
+      errors.flatten!
+
+      if errors.any?
+        puts "#{@yaml_path} contains following errors:"
+        errors.each { |e| puts "- #{e}" }
+        raise InvalidDefinition
+      end
+    end
+
+    def validate_node_prefix(key)
+      return if key[0, 3] == "ml-" || key[0, 3] == "pe-" || key[0, 3] == "ps-"
+      "Node #{key} needs an 'ml-' prefix for masterless or a 'pe-' prefix for Puppet agent or a 'ps-' prefix for Puppet Server"
+    end
+
+    def validate_known_keys(key, values)
+      unknown_keys = values.keys - VALID_KEYS
+      return if unknown_keys.empty?
+      "Node #{key} contains unknown entries #{unknown_keys.join(", ")}"
+    end
+  end
+end

data/lib/vagrant/em/demos/defaults.yaml

@@ -0,0 +1,54 @@
+---
+#
+# The default settings for all nodes
+#
+defaults:
+  domain_name:      example.com
+  cpucount:         1
+  ram:              4096
+  protocol:         ssh
+  dhcp_fix:         false
+  needs_storage:    false
+  additional_hosts: []
+  virtualboxorafix: false
+  required_plugins: []
+  run_r10k:         true
+  custom_facts:
+    deployment_zone: vagrant
+#
+# The default settings for all ML nodes
+#
+ml-defaults:
+  type:             masterless
+#
+# The default settings for all PE nodes
+#
+pe-defaults:
+  mount_uid:        983
+  mount_gid:        983
+  type:             pe-agent
+  puppet_master:    puppetserver
+#
+#  The default settings for all PS nodes
+#
+ps-defaults:
+  mount_uid:        52
+  mount_gid:        52
+  type:             agent
+  puppet_master:    puppetserver
+
+ps-puppetserver:
+  type:             ps-server
+  box:              generic/rocky9
+  cpucount:         2
+  ram:              6144
+#
+# The settings for the Puppet Enterprise Server
+#
+pe-puppetserver:
+  puppet_master:    puppetserver
+  type:             pe-master
+  box:              generic/rocky9
+  cpucount:         2
+  ram:              6144
+  puppet_installer: puppet-enterprise-2023.8.1-el-9-x86_64/puppet-enterprise-installer

data/lib/vagrant/em/demos/errors.rb

@@ -0,0 +1,15 @@
+module Vagrant
+  module EM
+    class FilesNotFoundError < Vagrant::Errors::VagrantError
+      def error_message
+        "Missing software files"
+      end
+    end
+
+    class InvalidDefinition < Vagrant::Errors::VagrantError
+      def error_message
+        "Invalid definition in server.yaml"
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/models.rb

@@ -0,0 +1,97 @@
+require "ostruct"
+
+module Vagrant
+  module Models
+    class Disk
+      attr_reader :name, :size, :uuid
+
+      def initialize(name, attributes)
+        @name = name
+        @size = attributes["size"]
+        @uuid = attributes["uuid"]
+      end
+    end
+
+    class AdditionalHost
+      attr_reader :name, :ip, :domain_name
+
+      def initialize(name, attributes, domain_name)
+        @name = name
+        @ip = attributes["ip"]
+        @domain_name = domain_name
+      end
+
+      def fqdn
+        "#{name}.#{domain_name}"
+      end
+    end
+
+    class Server
+      ATTRIBUTES = [
+        :name, :type, :box, :domain_name, :public_ip, :private_ip,
+        :cpucount, :ram, :puppet_master, :puppet_installer,
+        :protocol, :disks, :additional_hosts, :custom_facts,
+        :required_plugins, :software_files, :needs_storage,
+        :virtualboxorafix, :dhcp_fix, :cluster, :run_r10k, :mount_uid,
+        :mount_gid, :prefix, :ip_start_address, :ipaddress
+      ]
+      attr_reader(*ATTRIBUTES)
+      attr_accessor :generated_ip, :index, :vmname
+
+      def initialize(name, attributes, index)
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attributes[attr.to_s])
+        end
+        # Change the name if needed
+        parts = name.split("-")
+        if @prefix && !parts[1].start_with?(@prefix)
+          @vmname = "#{parts[0]}-#{@prefix}#{parts[1]}"
+        else
+          @vmname = name
+        end
+        @name = name
+        @index = index
+        if ip_start_address
+          adress_manager = VagrantPlugins::AdressManager.instance(ip_start_address)
+          @generated_ip = adress_manager.register_node(fqdn)
+          @ipaddress = @generated_ip
+        else
+          fail "priate_ip or ip_start_address is required"
+          @ipaddress = @private_ip
+        end
+
+        initialize_disks(attributes["disks"])
+        initialize_additional_hosts(attributes["additional_hosts"])
+      end
+
+
+      def hostname
+        @name[3..] # Removes 'ml-' or 'pe-' prefix
+      end
+
+      def fqdn
+        "#{hostname}.#{domain_name}"
+      end
+
+      private
+
+      def initialize_disks(disks_hash)
+        @disks = if disks_hash
+          disks_hash.map { |name, attributes| Disk.new(name, attributes) }
+        else
+          []
+        end
+      end
+
+      def initialize_additional_hosts(hosts_hash)
+        @additional_hosts = if hosts_hash
+          hosts_hash.map { |name, attributes|
+            AdditionalHost.new(name, attributes, domain_name)
+          }
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/em/demos/plugin.rb

@@ -0,0 +1,40 @@
+require "vagrant"
+require_relative "models"
+require_relative "config"
+require_relative "errors"
+require_relative "config_reader"
+require_relative "types/base"
+require_relative "adress_manager"
+# Dynamically require all Ruby files in the 'types' directory
+Dir[File.join(__dir__, "types", "*.rb")].each do |file|
+  require_relative file
+end
+
+module VagrantPlugins
+  module Em
+    module Demos
+      class Plugin < Vagrant.plugin("2")
+        name "EM Demos Provisioner"
+        description "Provides custom provisioning for Vagrant environments."
+
+        require_relative "Vagrantfile"
+
+        config "em" do
+          Config
+        end
+
+        #  Copies all software files to modules/software
+        command "prepare" do
+          require_relative "command/prepare"
+          Command::Prepare
+        end
+
+        #  Cleans up all software files from modules/software
+        command "cleanup" do
+          require_relative "command/cleanup"
+          Command::Cleanup
+        end
+      end
+    end
+  end
+end