octofacts-updater 0.5.0

data/lib/octofacts_updater/service/local_file.rb

@@ -0,0 +1,36 @@
+# This class reads a YAML file from the local file system so that it can be used as a source
+# in octofacts-updater. This was originally intended for a quickstart tutorial, since it requires
+# no real configuration. However it could also be used in production, if the user wants to create
+# their own fact obtaining logic outside of octofacts-updater and simply feed in the results.
+
+require_relative "base"
+
+module OctofactsUpdater
+  module Service
+    class LocalFile < OctofactsUpdater::Service::Base
+      # Get the facts from a local file, without using PuppetDB, SSH, or any of the other automated methods.
+      #
+      # node   - A String with the FQDN for which to retrieve facts
+      # config - A Hash with configuration settings
+      #
+      # Returns a Hash with the facts.
+      def self.facts(node, config = {})
+        unless config["localfile"].is_a?(Hash)
+          raise ArgumentError, "OctofactsUpdater::Service::LocalFile requires localfile section"
+        end
+        config_localfile = config["localfile"].dup
+
+        path_raw = config_localfile.delete("path")
+        unless path_raw
+          raise ArgumentError, "OctofactsUpdater::Service::LocalFile requires 'path' in the localfile section"
+        end
+        path = path_raw.gsub("%%NODE%%", node)
+        unless File.file?(path)
+          raise Errno::ENOENT, "OctofactsUpdater::Service::LocalFile cannot find a file at #{path.inspect}"
+        end
+
+        parse_yaml(File.read(path))
+      end
+    end
+  end
+end

data/lib/octofacts_updater/service/puppetdb.rb

@@ -0,0 +1,42 @@
+# This class interacts with puppetdb to pull the facts from the recent
+# run of Puppet on a given node. This uses octocatalog-diff on the back end to
+# pull the facts from puppetdb.
+
+require "octocatalog-diff"
+
+module OctofactsUpdater
+  module Service
+    class PuppetDB
+      # Get the facts for a specific node.
+      #
+      # node   - A String with the FQDN for which to retrieve facts
+      # config - An optional Hash with configuration settings
+      #
+      # Returns a Hash with the facts (via octocatalog-diff)
+      def self.facts(node, config = {})
+        fact_obj = OctocatalogDiff::Facts.new(
+          node: node.strip,
+          backend: :puppetdb,
+          puppetdb_url: puppetdb_url(config)
+        )
+        facts = fact_obj.facts(node)
+        return facts unless facts.nil?
+        raise OctocatalogDiff::Errors::FactSourceError, "Fact retrieval failed for #{node}"
+      end
+
+      # Get the puppetdb URL from the configuration or environment.
+      #
+      # config - An optional Hash with configuration settings
+      #
+      # Returns a String with the PuppetDB URL
+      def self.puppetdb_url(config = {})
+        answer = [
+          config.fetch("puppetdb", {}).fetch("url", nil),
+          ENV["PUPPETDB_URL"]
+        ].compact
+        raise "PuppetDB URL not configured or set in environment" unless answer.any?
+        answer.first
+      end
+    end
+  end
+end

data/lib/octofacts_updater/service/ssh.rb

@@ -0,0 +1,58 @@
+# This class interacts with a puppetserver to obtain facts from that server's YAML cache.
+# This is achieved by SSH-ing to the server and obtaining the fact file directly from the
+# puppetserver's cache. This can also be used to SSH to an actual node and run a command,
+# e.g. `facter -p --yaml` to grab actual facts from a running production node.
+
+require "net/ssh"
+require "shellwords"
+
+require_relative "base"
+
+module OctofactsUpdater
+  module Service
+    class SSH < OctofactsUpdater::Service::Base
+      CACHE_DIR = "/opt/puppetlabs/server/data/puppetserver/yaml/facts"
+      COMMAND = "cat %%NODE%%.yaml"
+
+      # Get the facts for a specific node.
+      #
+      # node   - A String with the FQDN for which to retrieve facts
+      # config - A Hash with configuration settings
+      #
+      # Returns a Hash with the facts.
+      def self.facts(node, config = {})
+        unless config["ssh"].is_a?(Hash)
+          raise ArgumentError, "OctofactsUpdater::Service::SSH requires ssh section"
+        end
+        config_ssh = config["ssh"].dup
+
+        server_raw = config_ssh.delete("server")
+        unless server_raw
+          raise ArgumentError, "OctofactsUpdater::Service::SSH requires 'server' in the ssh section"
+        end
+        server = server_raw.gsub("%%NODE%%", node)
+
+        user = config_ssh.delete("user") || ENV["USER"]
+        unless user
+          raise ArgumentError, "OctofactsUpdater::Service::SSH requires 'user' in the ssh section"
+        end
+
+        # Default is to 'cd (puppetserver cache dir) && cat (node).yaml' but this can
+        # be overridden by specifying a command in the SSH options. "%%NODE%%" will always
+        # be replaced by the FQDN of the node in the overall result.
+        cache_dir = config_ssh.delete("cache_dir") || CACHE_DIR
+        command_raw = config_ssh.delete("command") || "cd #{Shellwords.escape(cache_dir)} && #{COMMAND}"
+        command = command_raw.gsub("%%NODE%%", node)
+
+        # Everything left over in config["ssh"] (once server, user, command, and cache_dir are removed) is
+        # symbolized and passed directory to Net::SSH.
+        net_ssh_opts = config_ssh.map { |k, v| [k.to_sym, v] }.to_h || {}
+        ret = Net::SSH.start(server, user, net_ssh_opts) do |ssh|
+          ssh.exec! command
+        end
+        return { "name" => node, "values" => parse_yaml(ret.to_s.strip) } if ret.exitstatus == 0
+        raise "ssh failed with exitcode=#{ret.exitstatus}: #{ret.to_s.strip}"
+      end
+    end
+  end
+end

data/lib/octofacts_updater/version.rb

@@ -0,0 +1,3 @@
+module OctofactsUpdater
+  VERSION = File.read(File.expand_path("../../.version", File.dirname(__FILE__))).strip
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: octofacts-updater
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- GitHub, Inc.
+- Kevin Paulisse
+- Antonio Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: octocatalog-diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: |
+  Octofacts-updater is a series of scripts to construct the fact fixture files and index files consumed by octofacts.
+email: opensource+octofacts@github.com
+executables:
+- octofacts-updater
+extensions: []
+extra_rdoc_files: []
+files:
+- ".version"
+- bin/octofacts-updater
+- lib/octofacts_updater.rb
+- lib/octofacts_updater/cli.rb
+- lib/octofacts_updater/fact.rb
+- lib/octofacts_updater/fact_index.rb
+- lib/octofacts_updater/fixture.rb
+- lib/octofacts_updater/plugin.rb
+- lib/octofacts_updater/plugins/ip.rb
+- lib/octofacts_updater/plugins/ssh.rb
+- lib/octofacts_updater/plugins/static.rb
+- lib/octofacts_updater/service/base.rb
+- lib/octofacts_updater/service/enc.rb
+- lib/octofacts_updater/service/github.rb
+- lib/octofacts_updater/service/local_file.rb
+- lib/octofacts_updater/service/puppetdb.rb
+- lib/octofacts_updater/service/ssh.rb
+- lib/octofacts_updater/version.rb
+homepage: https://github.com/github/octofacts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Scripts to update octofacts fixtures from recent Puppet runs
+test_files: []