Class: Fog::Volume::OpenStack::Real

Inherits:
Object
  • Object
show all
Defined in:
lib/fog/openstack/volume.rb,
lib/fog/openstack/requests/volume/get_quota.rb,
lib/fog/openstack/requests/volume/set_tenant.rb,
lib/fog/openstack/requests/volume/list_volumes.rb,
lib/fog/openstack/requests/volume/update_quota.rb,
lib/fog/openstack/requests/volume/create_volume.rb,
lib/fog/openstack/requests/volume/delete_volume.rb,
lib/fog/openstack/requests/volume/list_snapshots.rb,
lib/fog/openstack/requests/volume/delete_snapshot.rb,
lib/fog/openstack/requests/volume/list_volume_types.rb,
lib/fog/openstack/requests/volume/get_quota_defaults.rb,
lib/fog/openstack/requests/volume/get_volume_details.rb,
lib/fog/openstack/requests/volume/get_snapshot_details.rb,
lib/fog/openstack/requests/volume/create_volume_snapshot.rb,
lib/fog/openstack/requests/volume/get_volume_type_details.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Real

Returns a new instance of Real.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/fog/openstack/volume.rb', line 109

def initialize(options={})
  @openstack_auth_token = options[:openstack_auth_token]

  unless @openstack_auth_token
    missing_credentials = Array.new
    @openstack_api_key  = options[:openstack_api_key]
    @openstack_username = options[:openstack_username]

    missing_credentials << :openstack_api_key  unless @openstack_api_key
    missing_credentials << :openstack_username unless @openstack_username
    raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
  end

  @openstack_tenant               = options[:openstack_tenant]
  @openstack_auth_uri             = URI.parse(options[:openstack_auth_url])
  @openstack_management_url       = options[:openstack_management_url]
  @openstack_must_reauthenticate  = false
  @openstack_service_type         = options[:openstack_service_type] || ['volume']
  @openstack_service_name         = options[:openstack_service_name]
  @openstack_region               = options[:openstack_region]

  @openstack_endpoint_type        = options[:openstack_endpoint_type] || 'adminURL'
  @connection_options = options[:connection_options] || {}

  @current_user = options[:current_user]
  @current_tenant = options[:current_tenant]

  authenticate

  @persistent = options[:persistent] || false
  @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
end

Instance Attribute Details

#current_tenantObject (readonly)

Returns the value of attribute current_tenant.



107
108
109
# File 'lib/fog/openstack/volume.rb', line 107

def current_tenant
  @current_tenant
end

#current_userObject (readonly)

Returns the value of attribute current_user.



106
107
108
# File 'lib/fog/openstack/volume.rb', line 106

def current_user
  @current_user
end

Instance Method Details

#create_volume(name, description, size, options = {}) ⇒ Object



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'lib/fog/openstack/requests/volume/create_volume.rb', line 6

def create_volume(name, description, size, options={})
  data = {
    'volume' => {
      'display_name'        => name,
      'display_description' => description,
      'size'                => size
    }
  }

  vanilla_options = [:snapshot_id, :imageRef, :volume_type,
    :source_volid]
  vanilla_options.select{|o| options[o]}.each do |key|
    data['volume'][key] = options[key]
  end
  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'POST',
    :path     => "volumes"
  )
end

#create_volume_snapshot(volume_id, name, description, force = false) ⇒ Object



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# File 'lib/fog/openstack/requests/volume/create_volume_snapshot.rb', line 6

def create_volume_snapshot(volume_id, name, description, force=false)
  data = {
    'snapshot' => {
      'volume_id'           => volume_id,
      'display_name'        => name,
      'display_description' => description,
      'force'               => force
    }
  }

  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'POST',
    :path     => "snapshots"
  )
end

#credentialsObject



142
143
144
145
146
147
148
149
# File 'lib/fog/openstack/volume.rb', line 142

def credentials
  { :provider                 => 'openstack',
    :openstack_auth_url       => @openstack_auth_uri.to_s,
    :openstack_auth_token     => @auth_token,
    :openstack_management_url => @openstack_management_url,
    :current_user             => @current_user,
    :current_tenant           => @current_tenant }
end

#delete_snapshot(snapshot_id) ⇒ Object



6
7
8
9
10
11
12
# File 'lib/fog/openstack/requests/volume/delete_snapshot.rb', line 6

def delete_snapshot(snapshot_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "snapshots/#{snapshot_id}"
  )
end

#delete_volume(volume_id) ⇒ Object



6
7
8
9
10
11
12
# File 'lib/fog/openstack/requests/volume/delete_volume.rb', line 6

def delete_volume(volume_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "volumes/#{volume_id}"
  )
end

#get_quota(tenant_id) ⇒ Object



6
7
8
9
10
11
12
# File 'lib/fog/openstack/requests/volume/get_quota.rb', line 6

def get_quota(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}"
  )
end

#get_quota_defaults(tenant_id) ⇒ Object



6
7
8
9
10
11
12
# File 'lib/fog/openstack/requests/volume/get_quota_defaults.rb', line 6

def get_quota_defaults(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}/defaults"
  )
end

#get_snapshot_details(snapshot_id) ⇒ Object



6
7
8
9
10
11
12
13
# File 'lib/fog/openstack/requests/volume/get_snapshot_details.rb', line 6

def get_snapshot_details(snapshot_id)

  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "snapshots/#{snapshot_id}"
  )
end

#get_volume_details(volume_id) ⇒ Object



6
7
8
9
10
11
12
13
# File 'lib/fog/openstack/requests/volume/get_volume_details.rb', line 6

def get_volume_details(volume_id)

  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "volumes/#{volume_id}"
  )
end

#get_volume_type_details(volume_type_id) ⇒ Object



5
6
7
8
9
10
11
# File 'lib/fog/openstack/requests/volume/get_volume_type_details.rb', line 5

def get_volume_type_details(volume_type_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "types/#{volume_type_id}"
  )
end

#list_snapshots(detailed = true) ⇒ Object



6
7
8
9
10
11
12
13
14
# File 'lib/fog/openstack/requests/volume/list_snapshots.rb', line 6

def list_snapshots(detailed=true)

  path = detailed ? 'snapshots/detail' : 'snapshots'
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => path
  )
end

#list_volume_types(options = {}) ⇒ Object



5
6
7
8
9
10
11
12
# File 'lib/fog/openstack/requests/volume/list_volume_types.rb', line 5

def list_volume_types(options={})
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => 'types',
    :query    => options
  )
end

#list_volumes(detailed = true, options = {}) ⇒ Object



6
7
8
9
10
11
12
13
14
# File 'lib/fog/openstack/requests/volume/list_volumes.rb', line 6

def list_volumes(detailed=true, options={})
  path = detailed ? 'volumes/detail' : 'volumes'
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => path,
    :query    => options
  )
end

#reloadObject



151
152
153
# File 'lib/fog/openstack/volume.rb', line 151

def reload
  @connection.reset
end

#request(params) ⇒ Object



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/fog/openstack/volume.rb', line 155

def request(params)
  begin
    response = @connection.request(params.merge({
      :headers  => {
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
        'X-Auth-Token' => @auth_token
      }.merge!(params[:headers] || {}),
      :path     => "#{@path}/#{params[:path]}"#,
    }))
  rescue Excon::Errors::Unauthorized => error
    if error.response.body != 'Bad username or password' # token expiration
      @openstack_must_reauthenticate = true
      authenticate
      retry
    else # bad credentials
      raise error
    end
  rescue Excon::Errors::HTTPStatusError => error
    raise case error
    when Excon::Errors::NotFound
      Fog::Compute::OpenStack::NotFound.slurp(error)
    else
      error
    end
  end
  unless response.body.empty?
    response.body = Fog::JSON.decode(response.body)
  end
  response
end

#set_tenant(tenant) ⇒ Object



6
7
8
9
10
# File 'lib/fog/openstack/requests/volume/set_tenant.rb', line 6

def set_tenant(tenant)
  @openstack_must_reauthenticate = true
  @openstack_tenant = tenant.to_s
  authenticate
end

#update_quota(tenant_id, options = {}) ⇒ Object



6
7
8
9
10
11
12
13
14
# File 'lib/fog/openstack/requests/volume/update_quota.rb', line 6

def update_quota(tenant_id, options = {})
  options['tenant_id'] = tenant_id
  request(
    :body => Fog::JSON.encode({ 'quota_set' => options }),
    :expects => 200,
    :method => 'PUT',
    :path => "/os-quota-sets/#{tenant_id}"
  )
end