1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
141
142
143
144
145
146
147
148
149
150
151
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from openstack import fields
from openstack import resource
RETRIABLE_STATUS_CODES = [
# HTTP Conflict - happens if a node is locked
409,
# HTTP Service Unavailable happens if there's no free conductor
503,
]
"""HTTP status codes that should be retried."""
PROVISIONING_VERSIONS = {
'abort': 13,
'adopt': 17,
'clean': 15,
'inspect': 6,
'manage': 4,
'provide': 4,
'rescue': 38,
'unrescue': 38,
'unhold': 85,
'service': 87,
}
"""API microversions introducing provisioning verbs."""
# Based on https://docs.openstack.org/ironic/latest/contributor/states.html
EXPECTED_STATES = {
'active': 'active',
'adopt': 'available',
'clean': 'manageable',
'deleted': 'available',
'inspect': 'manageable',
'manage': 'manageable',
'provide': 'available',
'rebuild': 'active',
'rescue': 'rescue',
}
"""Mapping of provisioning actions to expected stable states."""
EXPECTED_POWER_STATES = {
'power on': 'power on',
'power off': 'power off',
'rebooting': 'power on',
'soft power off': 'power off',
'soft rebooting': 'power on',
}
"""Mapping of target power states to expected power states."""
STATE_VERSIONS = {
'available': '1.1',
'enroll': '1.11',
'manageable': '1.4',
}
"""API versions when certain states were introduced."""
VIF_VERSION = '1.28'
"""API version in which the VIF operations were introduced."""
VIF_OPTIONAL_PARAMS_VERSION = '1.67'
"""API version in which the VIF optional parameters were introduced."""
INJECT_NMI_VERSION = '1.29'
"""API vresion in which support for injecting NMI was introduced."""
CONFIG_DRIVE_REBUILD_VERSION = '1.35'
"""API version in which rebuild accepts a configdrive."""
RESET_INTERFACES_VERSION = '1.45'
"""API version in which the reset_interfaces parameter was introduced."""
CONFIG_DRIVE_DICT_VERSION = '1.56'
"""API version in which configdrive can be a dictionary."""
DEPLOY_STEPS_VERSION = '1.69'
"""API version in which deploy_steps was added to node provisioning."""
CHANGE_BOOT_MODE_VERSION = '1.76'
"""API version in which boot_mode and secure_boot states can be changed"""
FIRMWARE_VERSION = '1.86'
"""API version in which firmware components of a node can be accessed"""
RUNBOOKS_VERSION = '1.92'
"""API version in which a runbook can be used in place of arbitrary steps
for provisioning"""
class Resource(resource.Resource):
base_path: str
@classmethod
def list(cls, session, details=False, **params):
"""This method is a generator which yields resource objects.
This resource object list generator handles pagination and takes query
params for response filtering.
:param session: The session to use for making this request.
:type session: :class:`~keystoneauth1.adapter.Adapter`
:param bool details: Whether to return detailed node records
:param dict params: These keyword arguments are passed through the
:meth:`~openstack.resource.QueryParameter._transpose` method
to find if any of them match expected query parameters to be
sent in the *params* argument to
:meth:`~keystoneauth1.adapter.Adapter.get`.
:return: A generator of :class:`openstack.resource.Resource` objects.
:raises: :exc:`~openstack.exceptions.InvalidResourceQuery` if query
contains invalid params.
"""
base_path = cls.base_path
if details:
base_path += '/detail'
return super().list(
session, paginated=True, base_path=base_path, **params
)
def comma_separated_list(value):
if value is None:
return None
else:
return ','.join(value)
def fields_type(value, resource_type):
if value is None:
return None
resource_mapping = {
key: value.name
for key, value in resource_type.__dict__.items()
if isinstance(value, fields.Body)
}
return comma_separated_list(resource_mapping.get(x, x) for x in value)
|
