-
Notifications
You must be signed in to change notification settings - Fork 9
/
plugin.spec
465 lines (433 loc) · 21 KB
/
plugin.spec
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
152
153
154
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
186
187
188
189
190
191
192
193
194
195
196
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
240
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
278
279
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
326
327
328
329
330
331
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
---
config:
plugin_type: install
subparsers:
cloud-config:
description: Collection of overcloud configuration tasks
include_groups: ["Ansible options", "Inventory", "Common options", "Answers file"]
groups:
- title: Tasks Control
options:
tasks:
type: ListOfFileNames
help: |
Provide a option to run one or more tasks to the cloud. If you run two or more tasks
at once, you need to separate them with commas
Example: infrared cloud-config --task task1,task3,task2
Note: Tasks represent playbooks, which are stored in the 'lookup_dir' folder in plugin
directory. Task run in the same order as they are provided.
lookup_dir: 'post_tasks'
required: yes
- title: OSP version parameters
options:
mirror:
type: Value
help: |
Enable usage of specified mirror (for rpm, pip etc) [brq,qeos,tlv - or hostname].
(Specified mirror needs to proxy multiple rpm source hosts and pypi packages.)
version:
type: Value
help: |
The product version (product == director)
Numbers are for OSP releases
Names are for RDO releases
Note: It is not mandatory, if not provided plugin will use value from automatic version discovery
choices:
- "7"
- "8"
- "9"
- "10"
- "11"
- "12"
- "13"
- "14"
- "15"
- "16"
- "16.1"
- "16.2"
- "17.0"
- "17.1"
- kilo
- liberty
- mitaka
- newton
- ocata
- pike
- queens
- rocky
- stein
- train
build:
help: |
String represents a timestamp of the OSP puddle.
Note: for versions 6 < OSPd < 10 to specify director
version use '--director-build' flag.
(for the given product core version).
Supports any rhos-release labels.
RDO supported labels: master-tripleo-ci
Examples: "passed_phase1", "2016-08-11.1", "Y1", "Z3", "GA"
type: Value
director-build:
help: |
String represents a timestamp of the OSP director puddle
(for the given product core version). Only applies for
6 < OSPd < 10, and could be used with '--build' flag.
Note: for versions >= 10 only the --build flag should be used to
specify a puddle.
Supports any rhos-release labels.
Examples: "passed_phase1", "2016-08-11.1", "Y1", "Z3", "GA"
If missing, will equal to "latest".
type: Value
buildmods:
type: Value
help: |
List of flags for rhos-release module.
Currently works with
pin - pin puddle (dereference 'latest' links to prevent content from changing)
flea - enable flea repos
unstable - this will enable brew repos or poodles (in old releases)
cdn - use internal mirrors of the CDN repos. (internal use)
none - use none of those flags
default: pin
enable-testing-repos:
type: Value
help: |
Let you the option to enable testing/pending repos with rhos-release. Multiple values have to be coma separated.
Examples: --enable-testing-repos rhel,extras,ceph or --enable-testing-repos all
- title: Common parameters
options:
overcloud-stack:
type: Value
help: The overcloud stack name
default: overcloud
splitstack:
type: Bool
default: no
help: |
If customer has already provisioned nodes for an overcloud splitstack should be used to utilize these
nodes.(https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/11/html/director_installation_and_usage/chap-configuring_basic_overcloud_requirements_on_pre_provisioned_nodes)
overcloud-ssh-user:
type: Value
help: Defines the overcloud ssh user name (Deprecated)
- title: TripleO User
options:
user-name:
type: Value
help: The installation user name. Will be generated if missing
default: stack
user-password:
type: Value
help: The installation user password
default: stack
- title: Service Discovery
options:
resync:
type: Bool
help: |
Whether we need to resync services.
Used with service discovery.
default: False
- title: External Network
options:
deployment-files:
type: Value
help: |
Name of folder in cloud's user on undercloud, which containing the templates of
the overcloud deployment.
network-protocol:
type: Value
help: The overcloud network backend.
default: ipv4
choices:
- ipv4
- ipv6
- ipv6-all
public-net-name:
type: Value
help: |
Specifies the name of the public network.
NOTE: If not provided it will use the default one for the OSP version
public-subnet:
type: VarFile
help: |
Subnet detail for "public" external network on the overcloud as post-install.
(CIDR, Allocation Pool, Gateway)
__LISTYAMLS__
default: default_subnet
external-vlan:
type: Value
help: |
An Optional external VLAN ID of the external network (Not to be confused with the Public API network)
external-dhcp:
type: Bool
default: False
help: |
DHCP can be enabled for external subnets optionally
external-shared:
type: Bool
default: False
help: |
Make external network shared
external-mtu:
type: Value
help: |
A custom MTU value can be set for external network optionally.
external-transparent-vlan:
type: Bool
default: False
help: |
Enable VLAN transparency on the external network
- title: Private network
options:
private-subnet:
type: VarFile
help: |
Subnet detail for private network on the overcloud as post-install.
(CIDR, Allocation Pool, Gateway)
__LISTYAMLS__
default: default_subnet
- title: Scale down nodes
options:
node-name:
type: Value
help: |
Name of the node to remove
shutdown:
type: Bool
default: False
help: |
Shut node before doing scale down so that is is unreachable
- title: Scale up nodes
options:
scale-nodes:
type: ListValue
help: |
List of compute nodes to be added.
Example: compute-3,compute-4,compute-5
NOTE: When you scale up splitstack deployment, you can use all "OSP version parameters" to
control rhos_release options.
required_when: "use-limit == True"
use-limit:
type: Bool
default: False
help: |
Use limit option when performing scale up
- title: Ironic Configuration
options:
vbmc-username:
type: Value
default: admin
help: |
VBMC username (Necessary when Ironic's driver is 'pxe_ipmitool' - OSP >= 11)
vbmc-password:
type: Value
default: password
help: |
VBMC password (Necessary when Ironic's driver is 'pxe_ipmitool' - OSP >= 11)
vbmc-host:
type: Value
default: undercloud
choices:
- "hypervisor"
- "undercloud"
help: |
Specifies on what server the virtualbmc service should be installed.
NOTE: If you use non default value for the option, and you execute introspection
and deploy (--introspect yes/--deploy yes) in different IR runs, you need to provide
the option on both runs.
resource-class-enabled:
type: Bool
default: True
help: |
Scheduling based on resource classes, a Compute service flavor is able to use the
node's resource_class field (available starting with Bare Metal API version 1.21)
for scheduling, instead of the CPU, RAM, and disk properties defined in the flavor.
A flavor can request exactly one instance of a bare metal resource class.
(https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html#scheduling-based-on-resource-classes)
Scheduling based on resource classes is enabled by default if OSP>=12. This option
allows to disable it.
Example: --resource-class-enabled False
resource-class-override:
type: NestedList
action: append
help: |
This option allows to create custom resource class and tie it to flavor and instances.
The 'node' field supports 'controller' or 'controller-0' patterns.
Example:
--resource-class-override name=baremetal-ctr,flavor=controller,node=controller
--resource-class-override name=baremetal-cmp,flavor=compute,node=compute-0
--resource-class-override name=baremetal-other,flavor=compute,node=swift-0:baremetal
image_direct_deploy:
type: Value
help: |
This option (when set to direct) sets the direct deploy flag on nodes in ironic, instead of the default
iscsi method.
default: iscsi
choices:
- iscsi
- direct
- title: Tempest
options:
image:
type: Value
help: |
An image to be uploaded to glance and used for testing. Path have to be a url.
imageid:
type: Value
help: |
Predifined UUID for the image.
imageid_alt:
type: Value
help: |
Predifined UUID for the alternative image.
image_packages:
type: Value
help: |
Comma delimited list of packages to install in the image
image_password:
type: Value
help: |
Password to be set in guest image for root user
tester-node:
type: Value
help: |
The name of the node from where the tests will be run
(tempest, tobiko, rally, etc) and the post/config tasks
are performed.
NOTE: currently the only tasks applied to this node is
the generation of extra ssh keys and their exchange
with overcloud nodes.
tester-username:
type: Value
help: The installation user name that will be used on the tester-node.
- title: Workload Launch
options:
workload-image-url:
type: Value
default: 'https://download.cirros-cloud.net/0.5.2/cirros-0.5.2-x86_64-disk.img'
help: |
Image source URL that should be used for uploading the workload Glance image
workload-memory:
type: Value
default: '512'
help: |
Amount of memory allocated to test workload flavor
workload-vcpu:
type: Value
default: '1'
help: |
Amount of vcpus allocated to test workload flavor
workload-disk:
type: Value
default: '5'
help: |
Disk size allocated to test workload flavor
workload-flavorid:
type: Value
default: '100'
help: |
Unique id of the new flavor
workload-index:
type: Value
default: '1'
help: |
Number of workload objects to be created
workload-flavor-extra-specs:
type: NestedDict
action: append
default: {}
help: |
Metadata dictionary for flavor extra specs
Usage: --workload-flavor-extra-specs "hw:mem_encryption"=True
workload-image-properties:
type: ListValue
help: |
List of properties supplied to the image created with 'image' param
Usage: --workload-image-properties="hw_firmware_type=uefi,hw_machine_type=q35"
NOTE: 'image' param should be set
- title: Deployment Description
options:
ntp-server:
type: Value
help: Ntp server name (or IP) to use.
default: clock.redhat.com
hybrid:
type: Bool
help: Specifies whether deploying a hybrid environment.
default: no
- title: Storage
options:
storage-external:
type: Bool
help: Whether to use an external storage rather than setting it up with the director.
default: no
storage-backend:
type: Value
choices:
- ceph
- swift
- netapp-iscsi
- netapp-nfs
- lvm
help: |
The storage (mainly cinder) that we would like to use.
If not supplied, Infrared will try to discover storage nodes and select appropriate backed.
The 'lvm' value will be used when storage nodes were not found.
NOTE: when not using external storage, this will set the default for "--storage-nodes" to 1.
cinder-tripleo-volume-backend:
type: Value
help: |
In multibackend Cinder deployments, this parameter should be used to populate
the default volume types backend, i.e. set the volume type for the 'tripleo' backend.
# see https://review.opendev.org/c/openstack/tempest/+/875372 and the corresponding
# devstack change https://review.opendev.org/c/openstack/devstack/+/877337
cinder-multiattach-volume-type:
type: Value
default: 'multiattach'
help: |
The volume type that is configured (and created if it does not exist) with the multiattach
property set, required by a few tempest tests.
manila-backend:
type: Value
choices:
- cephfs-native
- cephfs-nfs
help: |
The manila backend that we would like to use.
- title: Control Node Placement
options:
specific-node-ids:
type: Bool
default: no
help: |
Default tagging behaviour is to set properties/capabilities profile, which is based on the
node_type for all nodes from this type. If this value is set to true/yes, default behaviour
will be overwritten and profile will be removed, node id will be added to properties/capabilities
and scheduler hints will be generated.
Examples of node IDs include controller-0, controller-1, compute-0, compute-1, and so forth.
- title: Replace controller
options:
controller-to-remove:
type: Value
help: |
The controller node name to be replaced.
Example: --controller-to-remove="controller-1"
controller-to-add:
type: Value
help: |
The controller node name to be added instead the old one.
Example: --controller-to-add="controller-1"
use-the-same-node:
type: Bool
help: Specifies do we need to re-use the same node for replacement
default: no
- title: BGP
options:
bgp-enabled:
type: Bool
help: |
This flag should be enabled when running cloud-config
tasks on an OSP environment with BGP functionality configured.
When it is set to True, some tasks may be added or skipped
For example: some routes may be skipped, since BGP adds them automatically
default: no