Class: Ridley::Client

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Celluloid, Logging
Defined in:
lib/ridley/client.rb

Defined Under Namespace

Classes: ConnectionSupervisor, ResourcesSupervisor

Constant Summary collapse

REQUIRED_OPTIONS = 
[
  :server_url,
  :client_name,
  :client_key
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Logging

logger, #logger, set_logger

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :server_url (String) —

    URL to the Chef API

  • :client_name (String) —

    name of the client used to authenticate with the Chef API

  • :client_key (String) —

    filepath to the client’s private key used to authenticate with the Chef API

  • :validator_client (String) — default: nil
  • :validator_path (String) — default: nil
  • :encrypted_data_bag_secret_path (String) — default: nil
  • :chef_version (String) —

    the version of Chef to use when bootstrapping

  • :params (Hash) —

    URI query unencoded key/value pairs

  • :headers (Hash) —

    unencoded HTTP header key/value pairs

  • :request (Hash) —

    request options

  • :ssl (Hash) —

    • :verify (Boolean) [true] set to false to disable SSL verification

  • :proxy (URI, String, Hash) —

    URI, String, or Hash of HTTP proxy options

  • :pool_size (Integer) — default: 4 —

    size of the connection pool

Raises:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/ridley/client.rb', line 120

def initialize(options = {})
  @options = options.reverse_merge(
    pool_size: 4
  ).deep_symbolize_keys
  self.class.validate_options(@options)

  @chef_version     = @options[:chef_version]
  @validator_client = @options[:validator_client]

  if @options[:validator_path]
    @validator_path = File.expand_path(@options[:validator_path])
  end

  @options[:encrypted_data_bag_secret] ||= begin
    if @options[:encrypted_data_bag_secret_path]
      @encrypted_data_bag_secret_path = File.expand_path(@options[:encrypted_data_bag_secret_path])
    end

    encrypted_data_bag_secret
  end

  unless verify_client_key(@options[:client_key])
    @options[:client_key] = File.expand_path(@options[:client_key])
    raise Errors::ClientKeyFileNotFoundOrInvalid, "client key is invalid or not found at: '#{@options[:client_key]}'" unless File.exist?(@options[:client_key]) && verify_client_key(::IO.read(@options[:client_key]))
  end

  @connection_registry   = Celluloid::Registry.new
  @resources_registry    = Celluloid::Registry.new
  @connection_supervisor = ConnectionSupervisor.new(@connection_registry, @options)
  @resources_supervisor  = ResourcesSupervisor.new(@resources_registry, @connection_registry, @options)
end

Instance Attribute Details

#chef_version ⇒ Object

Returns the value of attribute chef_version.



92
93
94
 
# File 'lib/ridley/client.rb', line 92

def chef_version
  @chef_version
end

#encrypted_data_bag_secret_path ⇒ Object

Returns the value of attribute encrypted_data_bag_secret_path.



91
92
93
 
# File 'lib/ridley/client.rb', line 91

def encrypted_data_bag_secret_path
  @encrypted_data_bag_secret_path
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



87
88
89
 
# File 'lib/ridley/client.rb', line 87

def options
  @options
end

#validator_client ⇒ Object

Returns the value of attribute validator_client.



89
90
91
 
# File 'lib/ridley/client.rb', line 89

def validator_client
  @validator_client
end

#validator_path ⇒ Object

Returns the value of attribute validator_path.



90
91
92
 
# File 'lib/ridley/client.rb', line 90

def validator_path
  @validator_path
end

Class Method Details

.open(options = {}, &block) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/ridley/client.rb', line 36

def open(options = {}, &block)
  client = new(options)
  yield client
ensure
  client.terminate if client && client.alive?
end

.validate_options(options) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ridley/client.rb', line 46

def validate_options(options)
  missing = (REQUIRED_OPTIONS - options.keys)

  if missing.any?
    missing.collect! { |opt| "'#{opt}'" }
    raise ArgumentError, "Missing required option(s): #{missing.join(', ')}"
  end

  missing_values = options.slice(*REQUIRED_OPTIONS).select { |key, value| !value.present? }
  if missing_values.any?
    values = missing_values.keys.collect { |opt| "'#{opt}'" }
    raise ArgumentError, "Missing value for required option(s): '#{values.join(', ')}'"
  end
end

Instance Method Details

#client ⇒ Ridley::ClientResource

Returns:



153
154
155
 
# File 'lib/ridley/client.rb', line 153

def client
  @resources_registry[:client_resource]
end

#cookbook ⇒ Ridley::CookbookResource

Returns:



158
159
160
 
# File 'lib/ridley/client.rb', line 158

def cookbook
  @resources_registry[:cookbook_resource]
end

#data_bag ⇒ Ridley::DataBagResource

Returns:



163
164
165
 
# File 'lib/ridley/client.rb', line 163

def data_bag
  @resources_registry[:data_bag_resource]
end

#encrypted_data_bag_secret ⇒ String?

The encrypted data bag secret for this connection.

Returns:

  • (String, nil)

Raises:



255
256
257
258
259
260
261
 
# File 'lib/ridley/client.rb', line 255

def encrypted_data_bag_secret
  return nil if encrypted_data_bag_secret_path.nil?

  ::IO.read(encrypted_data_bag_secret_path).chomp
rescue Errno::ENOENT => e
  raise Errors::EncryptedDataBagSecretNotFound, "Encrypted data bag secret provided but not found at '#{encrypted_data_bag_secret_path}'"
end

#environment ⇒ Ridley::EnvironmentResource

Returns:



168
169
170
 
# File 'lib/ridley/client.rb', line 168

def environment
  @resources_registry[:environment_resource]
end

#node ⇒ Ridley::NodeResource

Returns:



173
174
175
 
# File 'lib/ridley/client.rb', line 173

def node
  @resources_registry[:node_resource]
end

#partial_search(index, query = nil, attributes = [], options = {}) ⇒ Array<ChefObject>, Hash

Perform a partial search on the Chef Server. Partial objects or a smaller hash will be returned resulting in a faster response for larger response sets. Specify the attributes you want returned with the attributes parameter.

Examples:

ridley = Ridley.new(...)
ridley.partial_search(:node, "chef_environment:RESET", [ 'ipaddress', 'some.application.setting' ]) #=>
  [
    #<Ridley::NodeObject: chef_id:"reset.riotgames.com" normal:
      { "ipaddress" => "192.168.1.1", "some" => { "application" => { "setting" => "value" } } } ...>
  ]

Parameters:

  • index (#to_sym, #to_s)
  • query (#to_s) (defaults to: nil)
  • attributes (Array) (defaults to: []) —

    an array of strings in dotted hash notation representing the attributes to return

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :sort (String) —

    a sort string such as ‘name DESC’

  • :rows (Integer) —

    how many rows to return

  • :start (Integer) —

    the result number to start from

Returns:



246
247
248
 
# File 'lib/ridley/client.rb', line 246

def partial_search(index, query = nil, attributes = [], options = {})
  @resources_registry[:search_resource].partial(index, query, Array(attributes), @resources_registry, options)
end

#role ⇒ Ridley::RoleResource

Returns:



178
179
180
 
# File 'lib/ridley/client.rb', line 178

def role
  @resources_registry[:role_resource]
end

#sandbox ⇒ Ridley::SandboxResource

Returns:



183
184
185
 
# File 'lib/ridley/client.rb', line 183

def sandbox
  @resources_registry[:sandbox_resource]
end

#search(index, query = nil, options = {}) ⇒ Array<ChefObject>, Hash

Perform a search the Chef Server

Parameters:

  • index (#to_sym, #to_s)
  • query (#to_s) (defaults to: nil)
  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :sort (String) —

    a sort string such as ‘name DESC’

  • :rows (Integer) —

    how many rows to return

  • :start (Integer) —

    the result number to start from

Returns:



205
206
207
 
# File 'lib/ridley/client.rb', line 205

def search(index, query = nil, options = {})
  @resources_registry[:search_resource].run(index, query, @resources_registry, options)
end

#search_indexes ⇒ Array<Symbol, String>

Return an array of all possible search indexes for the including connection

Examples:

ridley = Ridley.new(...)
ridley.search_indexes #=>
  [:client, :environment, :node, :role, :"ridley-two", :"ridley-one"]

Returns:

  • (Array<Symbol, String>) 


217
218
219
 
# File 'lib/ridley/client.rb', line 217

def search_indexes
  @resources_registry[:search_resource].indexes
end

#server_url ⇒ Object 



263
264
265
 
# File 'lib/ridley/client.rb', line 263

def server_url
  self.url_prefix.to_s
end

#user ⇒ Ridley::UserResource

Returns:



188
189
190
 
# File 'lib/ridley/client.rb', line 188

def user
  @resources_registry[:user_resource]
end