heat.engine.clients.os.nova module

class heat.engine.clients.os.nova.FlavorConstraint

Bases: heat.engine.clients.os.nova.NovaBaseConstraint

expected_exceptions = (<class 'novaclient.exceptions.NotFound'>,)

resource_getter_name = 'find_flavor_by_name_or_id'

class heat.engine.clients.os.nova.HostConstraint

Bases: heat.engine.clients.os.nova.NovaBaseConstraint

expected_exceptions = (<class 'novaclient.exceptions.NotFound'>,)

resource_getter_name = 'get_host'

class heat.engine.clients.os.nova.KeypairConstraint

Bases: heat.engine.clients.os.nova.NovaBaseConstraint

resource_getter_name = 'get_keypair'

validate_with_client(client, key_name)

class heat.engine.clients.os.nova.NovaBaseConstraint

Bases: heat.engine.constraints.BaseCustomConstraint

resource_client_name = 'nova'

class heat.engine.clients.os.nova.NovaClientPlugin(context)

Bases: heat.engine.clients.microversion_mixin.MicroversionMixin, heat.engine.clients.client_plugin.ClientPlugin

COMPUTE = 'compute'

NOVA_API_VERSION = '2.1'

absolute_limits()

Return the absolute limits as a dictionary.

associate_floatingip(server_id, floatingip_id)

associate_floatingip_address(server_id, fip_address)

attach_volume(server_id, volume_id, device)

static build_ignition_data(metadata, userdata)

build_userdata(metadata, userdata=None, instance_user=None, user_data_format='HEAT_CFNTOOLS')

Build multipart data blob for CloudInit and Ignition.

Data blob includes user-supplied Metadata, user data, and the required Heat in-instance configuration.

Parameters

• resource (heat.engine.Resource) – the resource implementation

• userdata (str or None) – user data string

• instance_user (string) – the user to create on the server

• user_data_format (string) – Format of user data to return

Returns

multipart mime as a string

check_delete_server_complete(server_id)

Wait for server to disappear from Nova.

check_detach_volume_complete(server_id, attach_id)

Check that nova server lost attachment.

This check is needed for immediate reattachment when updating: there might be some time between cinder marking volume as ‘available’ and nova removing attachment from its own objects, so we check that nova already knows that the volume is detached.

check_interface_attach(server_id, port_id)

check_interface_detach(server_id, port_id)

check_rebuild(server_id)

Verify that a rebuilding server is rebuilt.

Raise error if it ends up in an ERROR state.

check_resize(server_id, flavor)

Verify that a resizing server is properly resized.

If that’s the case, confirm the resize, if not raise an error.

check_verify_resize(server_id)

deferred_server_statuses = {'BUILD', 'HARD_REBOOT', 'PASSWORD', 'REBOOT', 'RESCUE', 'RESIZE', 'REVERT_RESIZE', 'SHUTOFF', 'SUSPENDED', 'VERIFY_RESIZE'}

detach_volume(server_id, attach_id)

dissociate_floatingip(floatingip_id)

dissociate_floatingip_address(fip_address)

exceptions_module = <module 'novaclient.exceptions' from '/home/zuul/src/opendev.org/openstack/heat/.tox/docs/lib/python3.10/site-packages/novaclient/exceptions.py'>

fetch_server(server_id)

Fetch fresh server object from Nova.

Log warnings and return None for non-critical API errors. Use this method in various check_*_complete resource methods, where intermittent errors can be tolerated.

fetch_server_attr(server_id, attr)

find_flavor_by_name_or_id(flavor)

Find the specified flavor by name or id.

Parameters

flavor – the name of the flavor to find

Returns

the id of :flavor:

get_console_urls(server)

Return dict-like structure of server’s console urls.

The actual console url is lazily resolved on access.

get_flavor(flavor_identifier)

Get the flavor object for the specified flavor name or id.

Parameters

flavor_identifier – the name or id of the flavor to find

Returns

a flavor object with name or id :flavor:

get_host(hypervisor_hostname)

Gets list of matching hypervisors by specified name.

Parameters

hypervisor_hostname – the name of host to find

Returns

list of matching hypervisor hosts

Raises

nova client exceptions.NotFound –

get_ip(server, net_type, ip_version)

Return the server’s IP of the given type and version.

get_keypair(key_name)

Get the public key specified by :key_name:

Parameters

key_name – the name of the key to look for

Returns

the keypair (name, public_key) for :key_name:

Raises

exception.EntityNotFound –

get_max_microversion()

get_server(server)

Return fresh server object.

Substitutes Nova’s NotFound for Heat’s EntityNotFound, to be returned to user as HTTP error.

get_status(server)

Return the server’s status.

Parameters

server – server object

Returns

status as a string

interface_attach(server_id, port_id=None, net_id=None, fip=None, security_groups=None)

interface_detach(server_id, port_id)

is_bad_request(ex)

is_conflict(ex)

Returns True if the exception is a conflict.

static is_ignition_format(userdata)

is_not_found(ex)

Returns True if the exception is a not-found.

is_over_limit(ex)

Returns True if the exception is an over-limit.

is_unprocessable_entity(ex)

is_version_supported(version)

max_microversion = None

meta_serialize(metadata)

Serialize non-string metadata values before sending them to Nova.

meta_update(server, metadata)

Delete/Add the metadata in nova as needed.

rebuild(server_id, image_id, password=None, preserve_ephemeral=False, meta=None, files=None)

Rebuild the server and call check_rebuild to verify.

refresh_server(server)

Refresh server’s attributes.

Also log warnings for non-critical API errors.

rename(server, name)

Update the name for a server.

resize(server_id, flavor_id)

Resize the server.

server_to_ipaddress(server)

Return the server’s IP address, fetching it from Nova.

service_types = ['compute']

verify_resize(server_id)

class heat.engine.clients.os.nova.ServerConstraint

Bases: heat.engine.clients.os.nova.NovaBaseConstraint

resource_getter_name = 'get_server'