Class: VagrantPlugins::Openstack::Config
- Inherits:
-
Object
- Object
- VagrantPlugins::Openstack::Config
- Defined in:
- lib/vagrant-openstack-provider/config.rb
Instance Attribute Summary collapse
-
#availability_zone ⇒ String
Availability Zone.
-
#endpoint_type ⇒ String
Specify the endpoint_type to use : publicURL, adminURL, or internalURL (default is publicURL).
-
#flavor ⇒ Object
The flavor of server to launch, either the ID or name.
-
#floating_ip ⇒ String
The floating IP address from the IP pool which will be assigned to the instance.
-
#floating_ip_pool ⇒ String
The floating IP pool from where new IPs will be allocated.
-
#floating_ip_pool_always_allocate ⇒ Boolean
if set to true, vagrant will always allocate floating ip instead of trying to reuse unassigned ones default to false.
- #http ⇒ HttpConfig
-
#image ⇒ Object
The name or ID of the image to use.
-
#keypair_name ⇒ String
The name of the keypair to use.
-
#metadata ⇒ Hash
A Hash of metadata that will be sent to the instance for configuration.
-
#networks ⇒ Array
Network list the VM will be connected to.
-
#openstack_auth_url ⇒ Object
The authentication endpoint.
-
#openstack_compute_url ⇒ Object
The compute service url to access Openstack.
-
#openstack_image_url ⇒ Object
The image service url to access Openstack.
-
#openstack_network_url ⇒ Object
The network service url to access Openstack.
-
#openstack_orchestration_url ⇒ Object
The orchestration service url to access Openstack.
-
#openstack_volume_url ⇒ Object
The block storage service url to access Openstack.
-
#password ⇒ Object
The API key to access Openstack.
-
#public_key_path ⇒ Array
Public key path to create OpenStack keypair.
-
#region ⇒ Object
Openstack region.
-
#rsync_ignore_files ⇒ Array
Sync folder ignore files.
-
#rsync_includes ⇒ Array
Opt files/directories in to the rsync operation performed by this provider.
-
#scheduler_hints ⇒ Object
Pass hints to the OpenStack scheduler, e.g.
-
#security_groups ⇒ Array[String]
List of strings representing the security groups to apply.
- #server_active_timeout ⇒ Integer
- #server_create_timeout ⇒ Integer
- #server_delete_timeout ⇒ Integer
-
#server_name ⇒ Object
The name of the server.
- #server_stop_timeout ⇒ Integer
-
#ssh_disabled ⇒ Boolean
Flag to enable/disable all SSH actions (to use for instance on private networks).
-
#ssh_timeout ⇒ Integer
The SSH timeout use after server creation.
-
#ssh_username ⇒ String
The SSH username to use with this OpenStack instance.
- #stack_create_timeout ⇒ Integer
- #stack_delete_timeout ⇒ Integer
-
#stacks ⇒ Array
Stack that will be created and associated to the instances.
-
#sync_method ⇒ String
Sync folder method.
-
#tenant_name ⇒ Object
The name of the openstack project on witch the vm will be created.
-
#user_data ⇒ String
User data to be sent to the newly created OpenStack instance.
-
#username ⇒ String
The username to access Openstack.
-
#volume_boot ⇒ Object
Volume to boot the vm from.
-
#volumes ⇒ Array
Volumes list that will be attached to the VM.
Instance Method Summary collapse
-
#finalize! ⇒ Object
rubocop:disable Style/CyclomaticComplexity.
-
#initialize ⇒ Config
constructor
A new instance of Config.
- #merge(other) ⇒ Object
-
#rsync_include(inc) ⇒ Object
rubocop:enable Style/CyclomaticComplexity.
- #validate(machine) ⇒ Object
Constructor Details
#initialize ⇒ Config
Returns a new instance of Config.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/vagrant-openstack-provider/config.rb', line 197 def initialize @password = UNSET_VALUE @openstack_compute_url = UNSET_VALUE @openstack_network_url = UNSET_VALUE @openstack_volume_url = UNSET_VALUE @openstack_orchestration_url = UNSET_VALUE @openstack_image_url = UNSET_VALUE @openstack_auth_url = UNSET_VALUE @endpoint_type = UNSET_VALUE @region = UNSET_VALUE @flavor = UNSET_VALUE @image = UNSET_VALUE @volume_boot = UNSET_VALUE @tenant_name = UNSET_VALUE @server_name = UNSET_VALUE @username = UNSET_VALUE @rsync_includes = [] @rsync_ignore_files = [] @keypair_name = UNSET_VALUE @ssh_username = UNSET_VALUE @ssh_timeout = UNSET_VALUE @floating_ip = UNSET_VALUE @floating_ip_pool = [] @floating_ip_pool_always_allocate = UNSET_VALUE @sync_method = UNSET_VALUE @availability_zone = UNSET_VALUE @networks = [] @stacks = [] @volumes = [] @public_key_path = UNSET_VALUE @scheduler_hints = UNSET_VALUE @security_groups = UNSET_VALUE @user_data = UNSET_VALUE @metadata = UNSET_VALUE @ssh_disabled = UNSET_VALUE @server_create_timeout = UNSET_VALUE @server_active_timeout = UNSET_VALUE @server_stop_timeout = UNSET_VALUE @server_delete_timeout = UNSET_VALUE @stack_create_timeout = UNSET_VALUE @stack_delete_timeout = UNSET_VALUE @http = HttpConfig.new end |
Instance Attribute Details
#availability_zone ⇒ String
Availability Zone
137 138 139 |
# File 'lib/vagrant-openstack-provider/config.rb', line 137 def availability_zone @availability_zone end |
#endpoint_type ⇒ String
Specify the endpoint_type to use : publicURL, adminURL, or internalURL (default is publicURL)
167 168 169 |
# File 'lib/vagrant-openstack-provider/config.rb', line 167 def endpoint_type @endpoint_type end |
#flavor ⇒ Object
The flavor of server to launch, either the ID or name. This can also be a regular expression to partially match a name.
40 41 42 |
# File 'lib/vagrant-openstack-provider/config.rb', line 40 def flavor @flavor end |
#floating_ip ⇒ String
The floating IP address from the IP pool which will be assigned to the instance.
90 91 92 |
# File 'lib/vagrant-openstack-provider/config.rb', line 90 def floating_ip @floating_ip end |
#floating_ip_pool ⇒ String
The floating IP pool from where new IPs will be allocated
95 96 97 |
# File 'lib/vagrant-openstack-provider/config.rb', line 95 def floating_ip_pool @floating_ip_pool end |
#floating_ip_pool_always_allocate ⇒ Boolean
if set to true, vagrant will always allocate floating ip instead of trying to reuse unassigned ones default to false
101 102 103 |
# File 'lib/vagrant-openstack-provider/config.rb', line 101 def floating_ip_pool_always_allocate @floating_ip_pool_always_allocate end |
#http ⇒ HttpConfig
195 196 197 |
# File 'lib/vagrant-openstack-provider/config.rb', line 195 def http @http end |
#image ⇒ Object
The name or ID of the image to use. This can also be a regular expression to partially match a name.
44 45 46 |
# File 'lib/vagrant-openstack-provider/config.rb', line 44 def image @image end |
#keypair_name ⇒ String
The name of the keypair to use.
68 69 70 |
# File 'lib/vagrant-openstack-provider/config.rb', line 68 def keypair_name @keypair_name end |
#metadata ⇒ Hash
A Hash of metadata that will be sent to the instance for configuration
157 158 159 |
# File 'lib/vagrant-openstack-provider/config.rb', line 157 def @metadata end |
#networks ⇒ Array
Network list the VM will be connected to
117 118 119 |
# File 'lib/vagrant-openstack-provider/config.rb', line 117 def networks @networks end |
#openstack_auth_url ⇒ Object
The authentication endpoint. This defaults to Openstack’s global authentication endpoint.
33 34 35 |
# File 'lib/vagrant-openstack-provider/config.rb', line 33 def openstack_auth_url @openstack_auth_url end |
#openstack_compute_url ⇒ Object
The compute service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
14 15 16 |
# File 'lib/vagrant-openstack-provider/config.rb', line 14 def openstack_compute_url @openstack_compute_url end |
#openstack_image_url ⇒ Object
The image service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
30 31 32 |
# File 'lib/vagrant-openstack-provider/config.rb', line 30 def openstack_image_url @openstack_image_url end |
#openstack_network_url ⇒ Object
The network service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
18 19 20 |
# File 'lib/vagrant-openstack-provider/config.rb', line 18 def openstack_network_url @openstack_network_url end |
#openstack_orchestration_url ⇒ Object
The orchestration service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
26 27 28 |
# File 'lib/vagrant-openstack-provider/config.rb', line 26 def openstack_orchestration_url @openstack_orchestration_url end |
#openstack_volume_url ⇒ Object
The block storage service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
22 23 24 |
# File 'lib/vagrant-openstack-provider/config.rb', line 22 def openstack_volume_url @openstack_volume_url end |
#password ⇒ Object
The API key to access Openstack.
10 11 12 |
# File 'lib/vagrant-openstack-provider/config.rb', line 10 def password @password end |
#public_key_path ⇒ Array
Public key path to create OpenStack keypair
132 133 134 |
# File 'lib/vagrant-openstack-provider/config.rb', line 132 def public_key_path @public_key_path end |
#region ⇒ Object
Openstack region
36 37 38 |
# File 'lib/vagrant-openstack-provider/config.rb', line 36 def region @region end |
#rsync_ignore_files ⇒ Array
Sync folder ignore files. A list of files containing exclude patterns to ignore in the rsync operation
performed by this provider
112 113 114 |
# File 'lib/vagrant-openstack-provider/config.rb', line 112 def rsync_ignore_files @rsync_ignore_files end |
#rsync_includes ⇒ Array
Opt files/directories in to the rsync operation performed by this provider
85 86 87 |
# File 'lib/vagrant-openstack-provider/config.rb', line 85 def rsync_includes @rsync_includes end |
#scheduler_hints ⇒ Object
Pass hints to the OpenStack scheduler, e.g. { “cell”: “some cell name” }
140 141 142 |
# File 'lib/vagrant-openstack-provider/config.rb', line 140 def scheduler_hints @scheduler_hints end |
#security_groups ⇒ Array[String]
List of strings representing the security groups to apply. e.g. [‘ssh’, ‘http’]
146 147 148 |
# File 'lib/vagrant-openstack-provider/config.rb', line 146 def security_groups @security_groups end |
#server_active_timeout ⇒ Integer
175 176 177 |
# File 'lib/vagrant-openstack-provider/config.rb', line 175 def server_active_timeout @server_active_timeout end |
#server_create_timeout ⇒ Integer
171 172 173 |
# File 'lib/vagrant-openstack-provider/config.rb', line 171 def server_create_timeout @server_create_timeout end |
#server_delete_timeout ⇒ Integer
183 184 185 |
# File 'lib/vagrant-openstack-provider/config.rb', line 183 def server_delete_timeout @server_delete_timeout end |
#server_name ⇒ Object
The name of the server. This defaults to the name of the machine defined by Vagrant (via ‘config.vm.define`), but can be overriden here.
58 59 60 |
# File 'lib/vagrant-openstack-provider/config.rb', line 58 def server_name @server_name end |
#server_stop_timeout ⇒ Integer
179 180 181 |
# File 'lib/vagrant-openstack-provider/config.rb', line 179 def server_stop_timeout @server_stop_timeout end |
#ssh_disabled ⇒ Boolean
Flag to enable/disable all SSH actions (to use for instance on private networks)
162 163 164 |
# File 'lib/vagrant-openstack-provider/config.rb', line 162 def ssh_disabled @ssh_disabled end |
#ssh_timeout ⇒ Integer
The SSH timeout use after server creation. If server startup is too long the timeout value can be increase with this variable. Default is 60 seconds
80 81 82 |
# File 'lib/vagrant-openstack-provider/config.rb', line 80 def ssh_timeout @ssh_timeout end |
#ssh_username ⇒ String
The SSH username to use with this OpenStack instance. This overrides the ‘config.ssh.username` variable.
74 75 76 |
# File 'lib/vagrant-openstack-provider/config.rb', line 74 def ssh_username @ssh_username end |
#stack_create_timeout ⇒ Integer
187 188 189 |
# File 'lib/vagrant-openstack-provider/config.rb', line 187 def stack_create_timeout @stack_create_timeout end |
#stack_delete_timeout ⇒ Integer
191 192 193 |
# File 'lib/vagrant-openstack-provider/config.rb', line 191 def stack_delete_timeout @stack_delete_timeout end |
#stacks ⇒ Array
Stack that will be created and associated to the instances
127 128 129 |
# File 'lib/vagrant-openstack-provider/config.rb', line 127 def stacks @stacks end |
#sync_method ⇒ String
Sync folder method. Can be either “rsync” or “none”
106 107 108 |
# File 'lib/vagrant-openstack-provider/config.rb', line 106 def sync_method @sync_method end |
#tenant_name ⇒ Object
The name of the openstack project on witch the vm will be created.
53 54 55 |
# File 'lib/vagrant-openstack-provider/config.rb', line 53 def tenant_name @tenant_name end |
#user_data ⇒ String
User data to be sent to the newly created OpenStack instance. Use this e.g. to inject a script at boot time.
152 153 154 |
# File 'lib/vagrant-openstack-provider/config.rb', line 152 def user_data @user_data end |
#username ⇒ String
The username to access Openstack.
63 64 65 |
# File 'lib/vagrant-openstack-provider/config.rb', line 63 def username @username end |
#volume_boot ⇒ Object
Volume to boot the vm from
48 49 50 |
# File 'lib/vagrant-openstack-provider/config.rb', line 48 def volume_boot @volume_boot end |
#volumes ⇒ Array
Volumes list that will be attached to the VM
122 123 124 |
# File 'lib/vagrant-openstack-provider/config.rb', line 122 def volumes @volumes end |
Instance Method Details
#finalize! ⇒ Object
rubocop:disable Style/CyclomaticComplexity
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/vagrant-openstack-provider/config.rb', line 280 def finalize! @password = nil if @password == UNSET_VALUE @openstack_compute_url = nil if @openstack_compute_url == UNSET_VALUE @openstack_network_url = nil if @openstack_network_url == UNSET_VALUE @openstack_orchestration_url = nil if @openstack_orchestration_url == UNSET_VALUE @openstack_volume_url = nil if @openstack_volume_url == UNSET_VALUE @openstack_image_url = nil if @openstack_image_url == UNSET_VALUE @openstack_auth_url = nil if @openstack_auth_url == UNSET_VALUE @endpoint_type = 'publicURL' if @endpoint_type == UNSET_VALUE @region = nil if @region == UNSET_VALUE @flavor = nil if @flavor == UNSET_VALUE @image = nil if @image == UNSET_VALUE @volume_boot = nil if @volume_boot == UNSET_VALUE @tenant_name = nil if @tenant_name == UNSET_VALUE @server_name = nil if @server_name == UNSET_VALUE @username = nil if @username == UNSET_VALUE @rsync_includes = nil if @rsync_includes.empty? @rsync_ignore_files = nil if @rsync_ignore_files.empty? @floating_ip = nil if @floating_ip == UNSET_VALUE @floating_ip_pool = nil if @floating_ip_pool == UNSET_VALUE @floating_ip_pool_always_allocate = false if floating_ip_pool_always_allocate == UNSET_VALUE @sync_method = 'rsync' if @sync_method == UNSET_VALUE @keypair_name = nil if @keypair_name == UNSET_VALUE @public_key_path = nil if @public_key_path == UNSET_VALUE @availability_zone = nil if @availability_zone == UNSET_VALUE @scheduler_hints = nil if @scheduler_hints == UNSET_VALUE @security_groups = nil if @security_groups == UNSET_VALUE @user_data = nil if @user_data == UNSET_VALUE @metadata = nil if @metadata == UNSET_VALUE @ssh_disabled = false if @ssh_disabled == UNSET_VALUE # The SSH values by default are nil, and the top-level config # `config.ssh` values are used. @ssh_username = nil if @ssh_username == UNSET_VALUE @ssh_timeout = 180 if @ssh_timeout == UNSET_VALUE @server_create_timeout = 200 if @server_create_timeout == UNSET_VALUE @server_active_timeout = 200 if @server_active_timeout == UNSET_VALUE @server_stop_timeout = 200 if @server_stop_timeout == UNSET_VALUE @server_delete_timeout = 200 if @server_delete_timeout == UNSET_VALUE @stack_create_timeout = 200 if @stack_create_timeout == UNSET_VALUE @stack_delete_timeout = 200 if @stack_delete_timeout == UNSET_VALUE @networks = nil if @networks.empty? @volumes = nil if @volumes.empty? @stacks = nil if @stacks.empty? @http.finalize! end |
#merge(other) ⇒ Object
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/vagrant-openstack-provider/config.rb', line 241 def merge(other) result = self.class.new # Set all of our instance variables on the new class [self, other].each do |obj| obj.instance_variables.each do |key| # Ignore keys that start with a double underscore. This allows # configuration classes to still hold around internal state # that isn't propagated. next if key.to_s.start_with?('@__') # Let user inputs a string or an array for floating ip pool attribute obj.floating_ip_pool = [obj.floating_ip_pool].flatten if key.eql?(:@floating_ip_pool) && !obj.floating_ip_pool.nil? # Let user inputs a string or an array for networks attribute obj.networks = [obj.networks].flatten if key.eql?(:@networks) && !obj.networks.nil? # Don't set the value if it is the unset value, either. value = obj.instance_variable_get(key) if [:@networks, :@volumes, :@rsync_includes, :@ignore_files, :@floating_ip_pool, :@stacks].include? key result.instance_variable_set(key, value) unless value.empty? elsif [:@http].include? key result.instance_variable_set(key, instance_variable_get(key).merge(other.instance_variable_get(key))) if value != UNSET_VALUE else result.instance_variable_set(key, value) if value != UNSET_VALUE end end end # Persist through the set of invalid methods this_invalid = @__invalid_methods || Set.new other_invalid = other.instance_variable_get(:"@__invalid_methods") || Set.new result.instance_variable_set(:"@__invalid_methods", this_invalid + other_invalid) result end |
#rsync_include(inc) ⇒ Object
rubocop:enable Style/CyclomaticComplexity
328 329 330 |
# File 'lib/vagrant-openstack-provider/config.rb', line 328 def rsync_include(inc) @rsync_includes << inc end |
#validate(machine) ⇒ Object
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/vagrant-openstack-provider/config.rb', line 332 def validate(machine) errors = _detected_errors errors << I18n.t('vagrant_openstack.config.password_required') if @password.nil? || @password.empty? errors << I18n.t('vagrant_openstack.config.username_required') if @username.nil? || @username.empty? errors << I18n.t('vagrant_openstack.config.tenant_name_required') if @tenant_name.nil? || @tenant_name.empty? errors << I18n.t('vagrant_openstack.config.invalid_endpoint_type') unless %w(publicURL adminURL internalURL).include?(@endpoint_type) validate_ssh_username(machine, errors) validate_stack_config(errors) validate_ssh_timeout(errors) if machine.config.ssh.private_key_path puts I18n.t('vagrant_openstack.config.keypair_name_required').yellow unless @keypair_name || @public_key_path else errors << I18n.t('vagrant_openstack.config.private_key_missing') if @keypair_name || @public_key_path end { openstack_compute_url: @openstack_compute_url, openstack_network_url: @openstack_network_url, openstack_volume_url: @openstack_volume_url, openstack_orchestration_url: @openstack_orchestration_url, openstack_image_url: @openstack_image_url, openstack_auth_url: @openstack_auth_url }.each_pair do |key, value| errors << I18n.t('vagrant_openstack.config.invalid_uri', key: key, uri: value) unless value.nil? || valid_uri?(value) end { 'Openstack Provider' => errors } end |