ohai 6.16.0 → 6.18.0.rc.0

data/lib/ohai/mixin/ec2_metadata.rb

@@ -22,11 +22,28 @@ require 'socket'
 
 module Ohai
   module Mixin
+    ##
+    # This code parses the EC2 Instance Metadata API to provide details
+    # of the running instance.
+    #
+    # Earlier version of this code assumed a specific version of the
+    # metadata API was available. Unfortunately the API versions
+    # supported by a particular instance are determined at instance
+    # launch and are not extended over the life of the instance. As such
+    # the earlier code would fail depending on the age of the instance.
+    #
+    # The updated code probes the instance metadata endpoint for
+    # available versions, determines the most advanced version known to
+    # work and executes the metadata retrieval using that version.
+    #
+    # If no compatible version is found, an empty hash is returned.
+    #
     module Ec2Metadata
 
       EC2_METADATA_ADDR = "169.254.169.254" unless defined?(EC2_METADATA_ADDR)
-      EC2_METADATA_URL = "/2012-01-12/meta-data" unless defined?(EC2_METADATA_URL)
-      EC2_USERDATA_URL = "/2012-01-12/user-data" unless defined?(EC2_USERDATA_URL)
+      EC2_SUPPORTED_VERSIONS = %w[ 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15
+                                   2008-02-01 2008-09-01 2009-04-04 2011-01-01 2011-05-01 2012-01-12 ]
+
       EC2_ARRAY_VALUES = %w(security-groups)
       EC2_ARRAY_DIR    = %w(network/interfaces/macs)
       EC2_JSON_DIR     = %w(iam)
@@ -57,67 +74,99 @@ module Ohai
         connected
       end
 
+      def best_api_version
+        response = http_client.get("/")
+        unless response.code == '200'
+          raise "Unable to determine EC2 metadata version (returned #{response.code} response)"
+        end
+        # Note: Sorting the list of versions may have unintended consequences in
+        # non-EC2 environments. It appears to be safe in EC2 as of 2013-04-12.
+        versions = response.body.split("\n")
+        versions = response.body.split("\n").sort
+        until (versions.empty? || EC2_SUPPORTED_VERSIONS.include?(versions.last)) do
+          pv = versions.pop
+          Ohai::Log.debug("EC2 shows unsupported metadata version: #{pv}") unless pv == 'latest'
+        end
+        Ohai::Log.debug("EC2 metadata version: #{versions.last}")
+        if versions.empty?
+          raise "Unable to determine EC2 metadata version (no supported entries found)"
+        end
+        versions.last
+      end
+
       def http_client
         Net::HTTP.start(EC2_METADATA_ADDR).tap {|h| h.read_timeout = 600}
       end
 
-      def fetch_metadata(id='')
+      def metadata_get(id, api_version)
+        response = http_client.get("/#{api_version}/meta-data/#{id}")
+        unless response.code == '200'
+          raise "Encountered error retrieving EC2 metadata (returned #{response.code} response)"
+        end
+        response
+      end
+
+      def fetch_metadata(id='', api_version=nil)
+        api_version ||= best_api_version
+        return Hash.new if api_version.nil?
         metadata = Hash.new
-        http_client.get("#{EC2_METADATA_URL}/#{id}").body.split("\n").each do |o|
+        metadata_get(id, api_version).body.split("\n").each do |o|
           key = expand_path("#{id}#{o}")
           if key[-1..-1] != '/'
             metadata[metadata_key(key)] =
               if EC2_ARRAY_VALUES.include? key
-                http_client.get("#{EC2_METADATA_URL}/#{key}").body.split("\n")
+                metadata_get(key, api_version).body.split("\n")
               else
-                http_client.get("#{EC2_METADATA_URL}/#{key}").body
+                metadata_get(key, api_version).body
               end
           elsif not key.eql?(id) and not key.eql?('/')
             name = key[0..-2]
-	    sym = metadata_key(name)
+            sym = metadata_key(name)
             if EC2_ARRAY_DIR.include?(name)
-              metadata[sym] = fetch_dir_metadata(key)
+              metadata[sym] = fetch_dir_metadata(key, api_version)
             elsif EC2_JSON_DIR.include?(name)
-              metadata[sym] = fetch_json_dir_metadata(key)
+              metadata[sym] = fetch_json_dir_metadata(key, api_version)
             else
-              fetch_metadata(key).each{|k,v| metadata[k] = v}
+              fetch_metadata(key, api_version).each{|k,v| metadata[k] = v}
             end
           end
         end
         metadata
       end
 
-      def fetch_dir_metadata(id)
+      def fetch_dir_metadata(id, api_version)
         metadata = Hash.new
-        http_client.get("#{EC2_METADATA_URL}/#{id}").body.split("\n").each do |o|
+          metadata_get(id, api_version).body.split("\n").each do |o|
           key = expand_path(o)
           if key[-1..-1] != '/'
-            metadata[metadata_key(key)] = http_client.get("#{EC2_METADATA_URL}/#{id}#{key}").body
+            metadata[metadata_key(key)] = metadata_get("#{id}#{key}", api_version).body
           elsif not key.eql?('/')
-            metadata[key[0..-2]] = fetch_dir_metadata("#{id}#{key}")
+            metadata[key[0..-2]] = fetch_dir_metadata("#{id}#{key}", api_version)
           end
         end
         metadata
       end
 
-      def fetch_json_dir_metadata(id)
+      def fetch_json_dir_metadata(id, api_version)
         metadata = Hash.new
-        http_client.get("#{EC2_METADATA_URL}/#{id}").body.split("\n").each do |o|
+        metadata_get(id, api_version).body.split("\n").each do |o|
           key = expand_path(o)
           if key[-1..-1] != '/'
-            data = http_client.get("#{EC2_METADATA_URL}/#{id}#{key}").body
+            data = metadata_get("#{id}#{key}", api_version).body
             json = StringIO.new(data)
             parser = Yajl::Parser.new
             metadata[metadata_key(key)] = parser.parse(json)
           elsif not key.eql?('/')
-            metadata[key[0..-2]] = fetch_json_dir_metadata("#{id}#{key}")
+            metadata[key[0..-2]] = fetch_json_dir_metadata("#{id}#{key}", api_version)
           end
         end
         metadata
       end
 
       def fetch_userdata()
-        response = http_client.get("#{EC2_USERDATA_URL}/")
+        api_version = best_api_version
+        return nil if api_version.nil?
+        response = http_client.get("/#{api_version}/user-data/")
         response.code == "200" ? response.body : nil
       end
 
@@ -138,4 +187,3 @@ module Ohai
     end
   end
 end
-

data/lib/ohai/mixin/gce_metadata.rb

@@ -0,0 +1,101 @@
+#
+# Author:: Ranjib Dey (<dey.ranjib@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'net/http'
+require 'socket'
+
+module Ohai
+  module Mixin
+    module GCEMetadata
+
+      GCE_METADATA_ADDR = "metadata.google.internal" unless defined?(GCE_METADATA_ADDR)
+      GCE_METADATA_URL = "/0.1/meta-data" unless defined?(GCE_METADATA_URL)
+
+      def can_metadata_connect?(addr, port, timeout=2)
+        t = Socket.new(Socket::Constants::AF_INET, Socket::Constants::SOCK_STREAM, 0)
+        saddr = Socket.pack_sockaddr_in(port, addr)
+        connected = false
+
+        begin
+          t.connect_nonblock(saddr)
+        rescue Errno::EINPROGRESS
+          r,w,e = IO::select(nil,[t],nil,timeout)
+          if !w.nil?
+            connected = true
+          else
+            begin
+              t.connect_nonblock(saddr)
+            rescue Errno::EISCONN
+              t.close
+              connected = true
+            rescue SystemCallError
+            end
+          end
+        rescue SystemCallError
+        end
+        Ohai::Log.debug("can_metadata_connect? == #{connected}")
+        connected
+      end
+
+      def http_client
+        Net::HTTP.start(GCE_METADATA_ADDR).tap {|h| h.read_timeout = 600}
+      end
+
+      def fetch_metadata(id='')
+        uri = "#{GCE_METADATA_URL}/#{id}"
+        response = http_client.get(uri)
+        return nil unless response.code == "200"
+        
+        if json?(response.body)
+          data = StringIO.new(response.body)
+          parser = Yajl::Parser.new
+          parser.parse(data)
+        elsif  has_trailing_slash?(id) or (id == '')
+          temp={}
+          response.body.split("\n").each do |sub_attr|
+            temp[sanitize_key(sub_attr)] = fetch_metadata("#{id}#{sub_attr}")
+          end
+          temp
+        else
+          response.body
+        end
+      end
+
+      def json?(data)
+        data = StringIO.new(data)
+        parser = Yajl::Parser.new
+        begin
+          parser.parse(data)
+          true
+        rescue Yajl::ParseError
+          false
+        end
+      end
+    
+      def multiline?(data)
+        data.lines.to_a.size > 1
+      end
+
+      def has_trailing_slash?(data)
+        !! ( data =~ %r{/$} )
+      end
+
+      def sanitize_key(key)
+        key.gsub(/\-|\//, '_')
+      end
+    end
+  end
+end

data/lib/ohai/plugins/azure.rb

@@ -0,0 +1,13 @@
+
+provides "azure"
+
+
+azure_metadata_from_hints = hint?('azure')
+if azure_metadata_from_hints
+  Ohai::Log.debug("azure_metadata_from_hints is present.")
+  azure Mash.new
+  azure_metadata_from_hints.each {|k, v| azure[k] = v }
+else
+  Ohai::Log.debug("No hints present for azure.")
+  false
+end

data/lib/ohai/plugins/cloud.rb

@@ -17,10 +17,12 @@
 provides "cloud"
 
 require_plugin "ec2"
+require_plugin "gce"
 require_plugin "rackspace"
 require_plugin "eucalyptus"
 require_plugin "linode"
 require_plugin "openstack"
+require_plugin "azure"
 
 # Make top-level cloud hashes
 #
@@ -29,6 +31,41 @@ def create_objects
   cloud[:public_ips] = Array.new
   cloud[:private_ips] = Array.new
 end
+#---------------------------------------
+# Google Compute Engine (gce)
+#--------------------------------------
+
+def on_gce?
+  gce != nil
+end
+def get_gce_values
+  cloud[:public_ipv4] = []
+  cloud[:local_ipv4] = []
+
+  public_ips = gce['network']["networkInterface"].collect do |interface|
+    if interface.has_key?('accessConfiguration')
+      interface['accessConfiguration'].collect{|ac| ac['externalIp']}
+    end
+  end.flatten.compact
+
+  private_ips = gce['network']["networkInterface"].collect do |interface|
+    interface['ip']
+  end.compact
+  
+  cloud[:public_ips] += public_ips
+  cloud[:private_ips] += private_ips
+  cloud[:public_ipv4] +=  public_ips
+  cloud[:public_hostname] = nil
+  cloud[:local_ipv4] += private_ips
+  cloud[:local_hostname] = gce['hostname']
+  cloud[:provider] = "gce"
+end
+
+# setup gce cloud
+if on_gce?
+  create_objects
+  get_gce_values
+end
 
 # ----------------------------------------
 # ec2
@@ -179,3 +216,32 @@ if on_openstack?
   create_objects
   get_openstack_values
 end
+
+# ----------------------------------------
+# azure
+# ----------------------------------------
+
+# Is current cloud azure?
+#
+# === Return
+# true:: If azure Hash is defined
+# false:: Otherwise
+def on_azure?
+  azure != nil
+end
+
+# Fill cloud hash with azure values
+def get_azure_values
+  cloud[:vm_name] = azure["vm_name"]
+  cloud[:public_ips] << azure['public_ip']
+  cloud[:public_fqdn] = azure['public_fqdn']
+  cloud[:public_ssh_port] = azure['public_ssh_port'] if azure['public_ssh_port']
+  cloud[:public_winrm_port] = azure['public_winrm_port'] if azure['public_winrm_port']
+  cloud[:provider] = "azure"
+end
+
+# setup azure cloud data
+if on_azure?
+  create_objects
+  get_azure_values
+end

data/lib/ohai/plugins/darwin/cpu.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Nathan L Smith (<nlloyds@gmail.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+provides "cpu"
+
+cpu Mash.new
+cpu[:real]  = from("sysctl -n hw.physicalcpu").to_i
+cpu[:total] = from("sysctl -n hw.logicalcpu").to_i

data/lib/ohai/plugins/gce.rb

@@ -0,0 +1,40 @@
+#
+# Author:: Ranjib Dey (<dey.ranjib@google.com>)
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+provides "gce"
+
+require 'ohai/mixin/gce_metadata'
+
+extend Ohai::Mixin::GCEMetadata
+GOOGLE_SYSFS_DMI = '/sys/firmware/dmi/entries/1-0/raw'
+
+#https://developers.google.com/compute/docs/instances#dmi
+def has_google_dmi?
+ ::File.read(GOOGLE_SYSFS_DMI).include?('Google')
+end
+
+def looks_like_gce?
+  hint?('gce') || has_google_dmi? && can_metadata_connect?(GCE_METADATA_ADDR,80)
+end
+
+if looks_like_gce?
+  Ohai::Log.debug("looks_like_gce? == true")
+  gce Mash.new
+  fetch_metadata.each {|k, v| gce[k] = v }
+else
+  Ohai::Log.debug("looks_like_gce? == false")
+  false
+end

data/lib/ohai/plugins/linux/platform.rb

@@ -38,11 +38,17 @@ elsif File.exists?("/etc/enterprise-release")
   platform "oracle"
   platform_version get_redhatish_version(contents)
 elsif File.exists?("/etc/debian_version")
-  # Ubuntu and Debian both have /etc/debian_version
-  # Ubuntu should always have a working lsb, debian does not by default
+  # Ubuntu, GCEL and Debian both have /etc/debian_version
+  # Ubuntu, GCEL should always have a working lsb, debian does not by default
   if lsb[:id] =~ /Ubuntu/i
     platform "ubuntu"
     platform_version lsb[:release]
+  elsif lsb[:id] =~ /gcel/i
+    platform "gcel"
+    platform_version lsb[:release]
+  elsif lsb[:id] =~ /LinuxMint/i
+    platform "linuxmint"
+    platform_version lsb[:release]
   else 
     if File.exists?("/usr/bin/raspi-config")
       platform "raspbian"
@@ -63,9 +69,15 @@ elsif File.exists?('/etc/gentoo-release')
   platform "gentoo"
   platform_version File.read('/etc/gentoo-release').scan(/(\d+|\.+)/).join
 elsif File.exists?('/etc/SuSE-release')
-  platform "suse"
-  platform_version File.read("/etc/SuSE-release").scan(/VERSION = (\d+)\nPATCHLEVEL = (\d+)/).flatten.join(".")
-  platform_version File.read("/etc/SuSE-release").scan(/VERSION = ([\d\.]{2,})/).flatten.join(".") if platform_version == ""
+  suse_release = File.read("/etc/SuSE-release")
+  suse_version = suse_release.scan(/VERSION = (\d+)\nPATCHLEVEL = (\d+)/).flatten.join(".")
+  suse_version = suse_release[/VERSION = ([\d\.]{2,})/, 1] if suse_version == ""
+  platform_version suse_version
+  if suse_release =~ /^openSUSE/
+    platform "opensuse"
+  else
+    platform "suse"
+  end
 elsif File.exists?('/etc/slackware-version')
   platform "slackware"
   platform_version File.read("/etc/slackware-version").scan(/(\d+|\.+)/).join
@@ -82,6 +94,9 @@ elsif lsb[:id] =~ /Amazon/i
 elsif lsb[:id] =~ /ScientificSL/i
   platform "scientific"
   platform_version lsb[:release]
+elsif lsb[:id] =~ /XenServer/i
+  platform "xenserver"
+  platform_version lsb[:release]
 elsif lsb[:id] # LSB can provide odd data that changes between releases, so we currently fall back on it rather than dealing with its subtleties 
   platform lsb[:id].downcase
   platform_version lsb[:release]
@@ -89,11 +104,11 @@ end
 
 
 case platform
-  when /debian/, /ubuntu/, /linuxmint/, /raspbian/
+  when /debian/, /ubuntu/, /linuxmint/, /raspbian/, /gcel/
     platform_family "debian"
   when /fedora/
     platform_family "fedora"
-  when /oracle/, /centos/, /redhat/, /scientific/, /enterpriseenterprise/, /amazon/
+  when /oracle/, /centos/, /redhat/, /scientific/, /enterpriseenterprise/, /amazon/, /xenserver/ # Note that 'enterpriseenterprise' is oracle's LSB "distributor ID"
     platform_family "rhel"
   when /suse/
     platform_family "suse"