cloudbox-server 0.0.1

data/lib/receiver/ambari_rest_api_connector.rb

@@ -0,0 +1,599 @@
+# This file is part of cloudbox-server project
+# Author: tnoguer (INGENSI)
+
+require 'json'
+require 'receiver/rest_api_connector'
+
+module Receiver
+  # Class linking to the Ambari Rest API.
+  # @author tnoguer
+  class AmbariRestAPIConnector < RestApiConnector
+
+    public
+    # Default constructor.
+    # @raise [ArgumentError] If the value of the arguments are nil or invalid.
+    # @author tnoguer
+    # @todo Change the conf file path to a relative path
+    def initialize(logger = nil)
+      file = File.new(File.dirname(__FILE__) + "/../../resources/cloudbox-server.conf", "r")
+      json = file.read()
+      conf = JSON.parse(json)
+      super(conf["ambari_server_ip"], conf["ambari_server_port"], "BASIC", conf["ambari_user"], conf["ambari_password"], 10000, logger)
+      @logger.info("Receiver::AmbariRestAPIConnector   initialize the parameters...")
+    end
+
+    public
+    # Create a configuration into a cluster.
+    # @param cluster_name The name of the cluster.
+    # @param configuration_type The type of the configuration to add.
+    # @param configuration_tag The tag of the configuration to add.
+    # @param properties The hash of properties for the configuration. (ex: {"Property 1" => "value", "Property 2" => "value"})
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def create_configuration(cluster_name, configuration_type, configuration_tag, properties)
+      if cluster_name == nil || configuration_type == nil || configuration_tag == nil || properties == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      body = {"type" => configuration_type,
+              "tag" => configuration_tag,
+              "Config" => {
+                  "cluster_name" => cluster_name
+              },
+              "properties" => {}
+      }
+      body["properties"].update(properties)
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}/configurations", body.to_json)
+    end
+
+    public
+    # Create and apply a configuration into a cluster.
+    # @param cluster_name The name of the cluster.
+    # @param configuration_type The type of the configuration to add.
+    # @param configuration_tag The tag of the configuration to add.
+    # @param properties The hash of properties for the configuration. (ex: {"Property 1" => "value", "Property 2" => "value"})
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def create_apply_configuration(cluster_name, configuration_type, configuration_tag, properties)
+      if cluster_name == nil || configuration_type == nil || configuration_tag == nil || properties == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+      body = {"Clusters" => {
+          "desired_config" => {
+              "type" => configuration_type.to_s,
+              "tag" => configuration_tag.to_s,
+              "properties" => {}
+          }
+      }}
+      body['Clusters']['desired_config']['properties'].update(properties)
+      return launch_request("PUT", "/api/v1/clusters/#{cluster_name}", body.to_json)
+    end
+
+    public
+    # Apply a configuration into a cluster.
+    # @param cluster_name The name of the cluster.
+    # @param configuration_type The type of the configuration to add.
+    # @param configuration_tag The tag of the configuration to add.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def apply_configuration(cluster_name, configuration_type, configuration_tag)
+      if cluster_name == nil || configuration_type == nil || configuration_tag == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      body = {"Clusters" => {
+          "desired_config" => {
+              "type" => configuration_type,
+              "tag" => configuration_tag
+          }
+      }}
+
+      return launch_request("PUT", "/api/v1/clusters/#{cluster_name}", body.to_json)
+    end
+
+    public
+    # Defines a new cluster.
+    # @param cluster_name The name of the cluster to be defined.
+    # @param cluster_version The version of the cluster to be created.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.add
+    # @author tnoguer
+    def define_cluster(cluster_name, cluster_version)
+      if cluster_name == nil || cluster_version == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}", "{\"Clusters\": {\"version\" : \"#{cluster_version}\"}}")
+    end
+
+    public
+    # Deletes a new cluster.
+    # @param cluster_name The name of the cluster to be deleted.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def delete_cluster(cluster_name)
+      if cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("DELETE", "/api/v1/clusters/#{cluster_name}")
+    end
+
+    public
+    # Shows the services of a cluster.
+    # @param cluster_name The name of the cluster.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_cluster_services(cluster_name)
+      if cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/services")
+    end
+
+    public
+    # Launches a GET request on a specifique configuration.
+    # @param cluster_name The name of the cluster.
+    # @param type The type of configuration.
+    # @param tag The tag ot configuration.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def get_cluster_configuration(cluster_name, type, tag)
+      if cluster_name == nil || type == nil || tag == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/configurations?type=#{type}&tag=#{tag}")
+    end
+
+    public
+    # Shows the requests of a cluster.
+    # @param cluster_name The name of the cluster.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_requests(cluster_name)
+      if cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/requests")
+    end
+
+    public
+    # Shows the information of a request.
+    # @param cluster_name The name of the cluster.
+    # @param request_id The ID of the request.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_request(cluster_name, request_id)
+      if cluster_name == nil || request_id == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/requests/#{request_id}?fields=tasks/*")
+    end
+
+
+    public
+    # Shows the information of a cluster.
+    # @param cluster_name The name of the cluster.
+    # @param show_host True to show the detail of the hosts. False otherwise.
+    # @param show_components True to show the detail of the components. False otherwise.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_cluster(cluster_name, show_host=false, show_components=false)
+      if cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      show_host = false unless show_host
+      show_components = false unless show_components
+      fields = "?fields=*"
+      fields += ",services/*" if show_components
+      fields += ",services/components/*" if show_host
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}#{fields}")
+    end
+
+    public
+    # Shows the list of clusters.
+    # @return The http response.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def list_clusters
+      return launch_request("GET", "/api/v1/clusters")
+    end
+
+    public
+    # Adds a component to an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to add.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def add_host_component(cluster_name, host_name, component_name)
+      if cluster_name == nil || host_name == nil || component_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}/host_components/#{component_name}")
+    end
+
+    public
+    # Deletes a component from an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to delete.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def delete_host_component(cluster_name, host_name, component_name)
+      if host_name == nil || component_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("DELETE", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}/host_components/#{component_name}")
+    end
+
+    public
+    # Deletes an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host to delete.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def delete_host(cluster_name, host_name)
+      if host_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("DELETE", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}")
+    end
+
+    public
+    # Installs a component of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to install.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def install_host_component(cluster_name, host_name, component_name)
+      return set_status_host_component(cluster_name, host_name, component_name, "INSTALLED")
+    end
+
+    public
+    # Starts a component of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to start.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def start_host_component(cluster_name, host_name, component_name)
+      return set_status_host_component(cluster_name, host_name, component_name, "STARTED")
+    end
+
+    public
+    # Stops a component of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to stop.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def stop_host_component(cluster_name, host_name, component_name)
+      return set_status_host_component(cluster_name, host_name, component_name, "INSTALLED")
+    end
+
+    public
+    # Detachs a component of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component to detach.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer0
+    def detach_host_component(cluster_name, host_name, component_name)
+      return set_status_host_component(cluster_name, host_name, component_name, "MAINTENANCE")
+    end
+
+    private
+    # Set the status of a component of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param component_name The name of the component.
+    # @param status The status to set. (INSTALLED, STARTED, MAINTENANCE)
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def set_status_host_component(cluster_name, host_name, component_name, status)
+      if host_name == nil || component_name == nil || cluster_name == nil || status == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("PUT", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}/host_components/#{component_name}",
+                            "{ \"HostRoles\" : { \"state\" : \"#{status}\"}}")
+    end
+
+    public
+    # Adds an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host to add.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def add_host(cluster_name, host_name)
+      if host_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}")
+    end
+
+    #public
+    # Creates and applies a configuration to an host from a configuration file.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @param configuration_type The type of the configuration to add.
+    # @param configuration_tag The tag of the configuration to add.
+    # @param file_path The path to the file containing the properties of the configuration.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    #def configure_host(cluster_name, host_name, configuration_type, configuration_tag, file_path)
+    #  if file_path == nil || cluster_name == nil || host_name == nil || configuration_type == nil || configuration_tag == nil
+    #    raise(ArgumentError, 'Arguments can\'t be nil!')
+    #  end
+    #
+    #  config = {:Clusters => {:desired_configs => {:type => configuration_type, :tag => configuration_tag, :properties => {}}}}
+    #  config[:Clusters][:desired_configs][:properties].update(xml2json(file_path))
+    #  config = config.to_json
+    #
+    #  return launch_request("PUT", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}", config)
+    #end
+
+    public
+    # Shows information of an host.
+    # @param cluster_name The name of the cluster.
+    # @param host_name The name of the host.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_host(cluster_name, host_name)
+      if host_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/hosts/#{host_name}?fields=*,host_components/*")
+    end
+
+    public
+    # Adds a component to a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the component to add.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def add_service_component(cluster_name, service_name, component_name)
+      if service_name == nil || component_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}/services/#{service_name}/components/#{component_name}")
+
+    end
+
+    public
+    # Defines a new service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service to define.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def define_service(cluster_name, service_name)
+      if service_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("POST", "/api/v1/clusters/#{cluster_name}/services/#{service_name}")
+    end
+
+    public
+    # Deletes a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service to delete.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def delete_service(cluster_name, service_name)
+      if service_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("DELETE", "/api/v1/clusters/#{cluster_name}/services/#{service_name}")
+    end
+
+    public
+    # Installs a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service to install.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def install_service(cluster_name, service_name)
+      return set_status_service(cluster_name, service_name, "INSTALLED")
+    end
+
+    public
+    # Starts a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service to start.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def start_service(cluster_name, service_name)
+      return set_status_service(cluster_name, service_name, "STARTED")
+    end
+
+    public
+    # Stops a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service to stop.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def stop_service(cluster_name, service_name)
+      return set_status_service(cluster_name, service_name, "INSTALLED")
+    end
+
+    private
+    # Set the status of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param status The status to set. (INSTALLED STARTED)
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def set_status_service(cluster_name, service_name, status)
+      if service_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("PUT", "/api/v1/clusters/#{cluster_name}/services/#{service_name}",
+                            "{\"ServiceInfo\": {\"state\" : \"#{status}\"}}")
+    end
+
+    public
+    # Installs a type of components of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the components to install.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def install_service_components(cluster_name, service_name, component_name)
+      return set_status_service_components(cluster_name, service_name, component_name, "INSTALLED")
+    end
+
+    public
+    # Starts a type of components of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the components to start.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def start_service_components(cluster_name, service_name, component_name)
+      return set_status_service_components(cluster_name, service_name, component_name, "STARTED")
+    end
+
+    public
+    # Stops a type of components of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the components to stops.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def stop_service_components(cluster_name, service_name, component_name)
+      return set_status_service_components(cluster_name, service_name, component_name, "INSTALLED")
+    end
+
+    private
+    # Set the status of a type of components of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the components.
+    # @param status The status to set. (INSTALLED STARTED)
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def set_status_service_components(cluster_name, service_name, component_name, status)
+      if service_name == nil || cluster_name == nil || component_name == nil || status == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("PUT", "/api/v1/clusters/#{cluster_name}/services/#{service_name}/components/#{component_name}",
+                            "{\"ServiceComponentInfo\": {\"state\" : \"#{status}\"}}")
+    end
+
+    public
+    # Shows information of a type of components of a service.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @param component_name The name of the components.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_service_components(cluster_name, service_name, component_name)
+      if service_name == nil || cluster_name == nil ||component_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/services/#{service_name}/components/#{component_name}?fields=host_components/*")
+    end
+
+    public
+    # Shows the list of service of a cluster.
+    # @param cluster_name The name of the cluster.
+    # @param service_name The name of the service.
+    # @return The http response.
+    # @raise [ArgumentError] If any argument is nil.
+    # @raise [HTTPError] If the request is invalid.
+    # @author tnoguer
+    def show_service(cluster_name, service_name)
+      if service_name == nil || cluster_name == nil
+        raise(ArgumentError, 'Arguments can\'t be nil!')
+      end
+
+      return launch_request("GET", "/api/v1/clusters/#{cluster_name}/services/#{service_name}?fields=*,components/ServiceComponentInfo,components/host_components/*")
+    end
+
+  end
+end