Repository navigation
Expand file tree
/
Copy pathserver.py
More file actions
5587 lines (4992 loc) · 198 KB
/
Copy pathserver.py
File metadata and controls
5587 lines (4992 loc) · 198 KB
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2012-2013 OpenStack Foundation
#
# 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.
#
"""Compute v2 Server action implementations"""
import argparse
import base64
from collections.abc import Iterable, Sequence
import getpass
import json
import logging
import os
from typing import Any
from cliff import columns as cliff_columns
import iso8601
from openstack import exceptions as sdk_exceptions
from openstack import utils as sdk_utils
from osc_lib.cli import format_columns
from osc_lib.cli import parseractions
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.api import compute_v2
from openstackclient import command
from openstackclient.common import envvars
from openstackclient.common import pagination
from openstackclient.i18n import _
from openstackclient.identity import common as identity_common
LOG = logging.getLogger(__name__)
IMAGE_STRING_FOR_BFV = 'N/A (booted from volume)'
class PowerStateColumn(cliff_columns.FormattableColumn[int]):
"""Generate a formatted string of a server's power state."""
power_states = [
'NOSTATE', # 0x00
'Running', # 0x01
'', # 0x02
'Paused', # 0x03
'Shutdown', # 0x04
'', # 0x05
'Crashed', # 0x06
'Suspended', # 0x07
]
def human_readable(self) -> str:
try:
return self.power_states[self._value]
except Exception:
return 'N/A'
class AddressesColumn(cliff_columns.FormattableColumn[Any]):
"""Generate a formatted string of a server's addresses."""
def human_readable(self) -> str:
try:
return (
utils.format_dict_of_list(
{
k: [i['addr'] for i in v if 'addr' in i]
for k, v in self._value.items()
}
)
or ''
)
except Exception:
return 'N/A'
def machine_readable(self) -> Any:
return {
k: [i['addr'] for i in v if 'addr' in i]
for k, v in (self._value.items() if self._value else [])
}
def __lt__(self, other: object) -> bool:
if not isinstance(other, AddressesColumn):
return NotImplemented
return self.human_readable() < other.human_readable()
def __eq__(self, other: object) -> bool:
if not isinstance(other, AddressesColumn):
return NotImplemented
return self.human_readable() == other.human_readable()
def __hash__(self) -> int:
return hash(self.human_readable())
class HostColumn(cliff_columns.FormattableColumn[str | None]):
"""Generate a formatted string of a hostname."""
def human_readable(self) -> str:
if self._value is None:
return ''
return self._value
def _get_ip_address(
addresses: Any, address_type: str, ip_address_family: list[int]
) -> Any:
# Old style addresses
if address_type in addresses:
for addy in addresses[address_type]:
if int(addy['version']) in ip_address_family:
return addy['addr']
# New style addresses
new_address_type = address_type
if address_type == 'public':
new_address_type = 'floating'
if address_type == 'private':
new_address_type = 'fixed'
for network in addresses:
for addy in addresses[network]:
# Case where it is list of strings
if isinstance(addy, str):
if new_address_type == 'fixed':
return addresses[network][0]
else:
return addresses[network][-1]
# Case where it is a dict
if 'OS-EXT-IPS:type' not in addy:
continue
if addy['OS-EXT-IPS:type'] == new_address_type:
if int(addy['version']) in ip_address_family:
return addy['addr']
msg = _("ERROR: No %(type)s IP version %(family)s address found")
raise exceptions.CommandError(
msg % {"type": address_type, "family": ip_address_family}
)
def _prep_server_detail(
compute_client: Any,
image_client: Any,
server: Any,
*,
refresh: bool = True,
) -> dict[str, Any]:
"""Prepare the detailed server dict for printing
:param compute_client: a compute client instance
:param image_client: an image client instance
:param server: a Server resource
:param refresh: Flag indicating if ``server`` is already the latest version
or if it needs to be refreshed, for example when showing the latest
details of a server after creating it.
:rtype: a dict of server details
"""
info = server.to_dict()
if refresh:
server = compute_client.get_server(info['id'])
# we only update if the field is not empty, to avoid overwriting
# existing values
info.update(
**{x: y for x, y in server.to_dict().items() if x not in info or y}
)
# Some commands using this routine were originally implemented with the
# nova python wrappers, and were later migrated to use the SDK. Map the
# SDK's property names to the original property names to maintain backward
# compatibility for existing users.
column_map = {
'access_ipv4': 'accessIPv4',
'access_ipv6': 'accessIPv6',
'admin_password': 'adminPass',
'attached_volumes': 'volumes_attached',
'availability_zone': 'OS-EXT-AZ:availability_zone',
'compute_host': 'OS-EXT-SRV-ATTR:host',
'created_at': 'created',
'disk_config': 'OS-DCF:diskConfig',
'has_config_drive': 'config_drive',
'host_id': 'hostId',
'fault': 'fault',
'hostname': 'OS-EXT-SRV-ATTR:hostname',
'hypervisor_hostname': 'OS-EXT-SRV-ATTR:hypervisor_hostname',
'instance_name': 'OS-EXT-SRV-ATTR:instance_name',
'is_locked': 'locked',
'kernel_id': 'OS-EXT-SRV-ATTR:kernel_id',
'launch_index': 'OS-EXT-SRV-ATTR:launch_index',
'launched_at': 'OS-SRV-USG:launched_at',
'power_state': 'OS-EXT-STS:power_state',
'project_id': 'tenant_id',
'ramdisk_id': 'OS-EXT-SRV-ATTR:ramdisk_id',
'reservation_id': 'OS-EXT-SRV-ATTR:reservation_id',
'root_device_name': 'OS-EXT-SRV-ATTR:root_device_name',
'task_state': 'OS-EXT-STS:task_state',
'terminated_at': 'OS-SRV-USG:terminated_at',
'updated_at': 'updated',
'user_data': 'OS-EXT-SRV-ATTR:user_data',
'vm_state': 'OS-EXT-STS:vm_state',
}
# NOTE(ratailor): microversion 2.96 introduces
# pinned_availability_zone support
if sdk_utils.supports_microversion(compute_client, '2.96'):
column_map['pinned_availability_zone'] = 'pinned_availability_zone'
# NOTE(ratailor): microversion 2.100 introduces
# scheduler_hints support
if sdk_utils.supports_microversion(compute_client, '2.100'):
column_map['scheduler_hints'] = 'scheduler_hints'
# Some columns returned by openstacksdk should not be shown because they're
# either irrelevant or duplicates
ignored_columns = {
# computed columns
'interface_ip',
'location',
'private_v4',
'private_v6',
'public_v4',
'public_v6',
# create-only columns
'block_device_mapping',
'flavor_id',
'host',
'image_id',
'max_count',
'min_count',
'networks',
'personality',
# aliases
'volumes',
# unnecessary
'links',
}
# Some columns are only present in certain responses and should not be
# shown otherwise.
optional_columns = {
# only in create responses if '[api] enable_instance_password' is set
'admin_password',
# only present in errored servers
'fault',
# only present in create, detail responses
'security_groups',
}
data = {}
for key, value in info.items():
if key in ignored_columns:
continue
if key in optional_columns:
if info[key] is None:
continue
alias = column_map.get(key)
data[alias or key] = value
info = data
# NOTE(dviroel): microversion 2.100 is now retrieving scheduler_hints
# content from request_spec on detailed responses
if not sdk_utils.supports_microversion(compute_client, '2.100'):
info.pop('scheduler_hints', None)
# NOTE(ratailor): microversion 2.96 introduces
# pinned_availability_zone support
if not sdk_utils.supports_microversion(compute_client, '2.96'):
info.pop('pinned_availability_zone', None)
# Convert the image blob to a name
image_info = info.get('image', {})
if image_info and any(image_info.values()):
image_id = image_info.get('id', '')
try:
image = image_client.get_image(image_id)
info['image'] = f"{image.name} ({image_id})"
except Exception:
info['image'] = image_id
else:
# NOTE(melwitt): An server booted from a volume will have no image
# associated with it. We fill in the image with "N/A (booted from
# volume)" to help users who want to be able to grep for
# boot-from-volume servers when using the CLI.
info['image'] = IMAGE_STRING_FOR_BFV
# Convert the flavor blob to a name
flavor_info = info.get('flavor', {})
# Microversion 2.47 puts the embedded flavor into the server response
# body. The presence of the 'original_name' attribute indicates this.
if flavor_info.get('original_name') is None: # microversion < 2.47
flavor_id = flavor_info.get('id', '')
try:
flavor = compute_client.find_flavor(
flavor_id, ignore_missing=False
)
info['flavor'] = f"{flavor.name} ({flavor_id})"
except Exception:
info['flavor'] = flavor_id
else: # microversion >= 2.47
info['flavor'] = format_columns.DictColumn(flavor_info)
# there's a lot of redundant information in BDMs - strip it
if 'volumes_attached' in info:
info.update(
{
'volumes_attached': format_columns.ListDictColumn(
[
{
k: v
for k, v in volume.items()
if v is not None and k != 'location'
}
for volume in info.pop('volumes_attached') or []
]
)
}
)
if 'security_groups' in info:
info.update(
{
'security_groups': format_columns.ListDictColumn(
info.pop('security_groups'),
)
}
)
if 'tags' in info:
info.update(
{'tags': format_columns.ListColumn(info.pop('tags') or [])}
)
# Map 'networks' to 'addresses', if present. Note that the 'networks' key
# is used for create responses, otherwise it's 'addresses'. We know it'll
# be set because this is one of our optional columns.
if 'networks' in info:
info['addresses'] = format_columns.DictListColumn(
info.pop('networks', {}),
)
else:
info['addresses'] = AddressesColumn(info.get('addresses', {}))
# Map 'metadata' field to 'properties' and format
info['properties'] = format_columns.DictColumn(info.pop('metadata'))
# Migrate tenant_id to project_id naming
if 'tenant_id' in info:
info['project_id'] = info.pop('tenant_id')
# Map power state num to meaningful string
if 'OS-EXT-STS:power_state' in info:
info['OS-EXT-STS:power_state'] = PowerStateColumn(
info['OS-EXT-STS:power_state']
)
if sdk_utils.supports_microversion(compute_client, '2.100'):
if 'scheduler_hints' in info:
info['scheduler_hints'] = format_columns.DictListColumn(
info.pop('scheduler_hints', {}),
)
return info
class AddFixedIP(command.ShowOne):
_description = _("Add fixed IP address to server")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
"server",
metavar="<server>",
help=_("Server to receive the fixed IP address (name or ID)"),
)
parser.add_argument(
"network",
metavar="<network>",
help=_(
"Network to allocate the fixed IP address from (name or ID)"
),
)
parser.add_argument(
"--fixed-ip-address",
metavar="<ip-address>",
help=_("Requested fixed IP address"),
)
parser.add_argument(
'--tag',
metavar='<tag>',
help=_(
'Tag for the attached interface. '
'(supported by --os-compute-api-version 2.49 or above)'
),
)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[Sequence[str], Iterable[Any]]:
compute_client = self.app.client_manager.compute
server = compute_client.find_server(
parsed_args.server, ignore_missing=False
)
if parsed_args.tag:
if not sdk_utils.supports_microversion(compute_client, '2.49'):
msg = _(
'--os-compute-api-version 2.49 or greater is required to '
'support the --tag option'
)
raise exceptions.CommandError(msg)
if self.app.client_manager.is_network_endpoint_enabled():
network_client = self.app.client_manager.network
net_id = network_client.find_network(
parsed_args.network, ignore_missing=False
).id
else:
net_id = parsed_args.network
kwargs: dict[str, Any] = {'net_id': net_id}
if parsed_args.fixed_ip_address:
kwargs['fixed_ips'] = [
{"ip_address": parsed_args.fixed_ip_address}
]
if parsed_args.tag:
kwargs['tag'] = parsed_args.tag
interface = compute_client.create_server_interface(server.id, **kwargs)
columns: tuple[str, ...] = (
'port_id',
'server_id',
'net_id',
'mac_addr',
'port_state',
'fixed_ips',
)
column_headers: tuple[str, ...] = (
'Port ID',
'Server ID',
'Network ID',
'MAC Address',
'Port State',
'Fixed IPs',
)
if parsed_args.tag:
if sdk_utils.supports_microversion(compute_client, '2.49'):
columns += ('tag',)
column_headers += ('Tag',)
return (
column_headers,
utils.get_item_properties(
interface,
columns,
formatters={
'fixed_ips': format_columns.ListDictColumn,
},
),
)
class AddFloatingIP(command.Command):
_description = _("Add floating IP address to server")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
"server",
metavar="<server>",
help=_("Server to receive the floating IP address (name or ID)"),
)
parser.add_argument(
"ip_address",
metavar="<ip-address>",
help=_(
"Floating IP address to assign to the first available "
"server port (IP only)"
),
)
parser.add_argument(
"--fixed-ip-address",
metavar="<ip-address>",
help=_(
"Fixed IP address to associate with this floating IP address. "
"The first server port containing the fixed IP address will "
"be used"
),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
client = self.app.client_manager.network
compute_client = self.app.client_manager.compute
attrs = {}
obj = client.find_ip(
parsed_args.ip_address,
ignore_missing=False,
)
server = compute_client.find_server(
parsed_args.server, ignore_missing=False
)
ports = list(client.ports(device_id=server.id))
if not ports:
msg = _('No attached ports found to associate floating IP with')
raise exceptions.CommandError(msg)
# If the fixed IP address was specified, we need to find the
# corresponding port.
if parsed_args.fixed_ip_address:
fip_address = parsed_args.fixed_ip_address
attrs['fixed_ip_address'] = fip_address
for port in ports:
for ip in port.fixed_ips:
if ip['ip_address'] == fip_address:
attrs['port_id'] = port.id
break
else:
continue
break
if 'port_id' not in attrs:
msg = _('No port found for fixed IP address %s')
raise exceptions.CommandError(msg % fip_address)
client.update_ip(obj, **attrs)
else:
# It's possible that one or more ports are not connected to a
# router and thus could fail association with a floating IP.
# Try each port until one succeeds. If none succeed, re-raise the
# last exception.
error = None
for port in ports:
attrs['port_id'] = port.id
try:
client.update_ip(obj, **attrs)
except sdk_exceptions.NotFoundException as exp:
# 404 ExternalGatewayForFloatingIPNotFound from neutron
LOG.info(
'Skipped port %s because it is not attached to '
'an external gateway',
port.id,
)
error = exp
continue
else:
error = None
break
if error:
raise error
class AddPort(command.Command):
_description = _("Add port to server")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
"server",
metavar="<server>",
help=_("Server to add the port to (name or ID)"),
)
parser.add_argument(
"port",
metavar="<port>",
help=_("Port to add to the server (name or ID)"),
)
parser.add_argument(
'--tag',
metavar='<tag>',
help=_(
'Tag for the attached interface '
'(supported by --os-compute-api-version 2.49 or later)'
),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
compute_client = self.app.client_manager.compute
server = compute_client.find_server(
parsed_args.server, ignore_missing=False
)
if self.app.client_manager.is_network_endpoint_enabled():
network_client = self.app.client_manager.network
port_id = network_client.find_port(
parsed_args.port, ignore_missing=False
).id
else:
port_id = parsed_args.port
kwargs = {'port_id': port_id}
if parsed_args.tag:
if not sdk_utils.supports_microversion(compute_client, '2.49'):
msg = _(
'--os-compute-api-version 2.49 or greater is required to '
'support the --tag option'
)
raise exceptions.CommandError(msg)
kwargs['tag'] = parsed_args.tag
compute_client.create_server_interface(server, **kwargs)
class AddNetwork(command.Command):
_description = _("Add network to server")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
"server",
metavar="<server>",
help=_("Server to add the network to (name or ID)"),
)
parser.add_argument(
"network",
metavar="<network>",
help=_("Network to add to the server (name or ID)"),
)
parser.add_argument(
'--tag',
metavar='<tag>',
help=_(
'Tag for the attached interface. '
'(supported by --os-compute-api-version 2.49 or above)'
),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
compute_client = self.app.client_manager.compute
server = compute_client.find_server(
parsed_args.server, ignore_missing=False
)
if self.app.client_manager.is_network_endpoint_enabled():
network_client = self.app.client_manager.network
net_id = network_client.find_network(
parsed_args.network, ignore_missing=False
).id
else:
net_id = parsed_args.network
kwargs = {'net_id': net_id}
if parsed_args.tag:
if not sdk_utils.supports_microversion(compute_client, '2.49'):
msg = _(
'--os-compute-api-version 2.49 or greater is required to '
'support the --tag option'
)
raise exceptions.CommandError(msg)
kwargs['tag'] = parsed_args.tag
compute_client.create_server_interface(server, **kwargs)
class AddServerSecurityGroup(command.Command):
_description = _("Add security group(s) to server")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'server',
metavar='<server>',
help=_('Server (name or ID)'),
)
parser.add_argument(
'security_groups',
metavar='<security-group>',
nargs='+',
help=_(
'Security group(s) to add to the server (name or ID) '
'(repeat option to add multiple groups)'
),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
compute_client = self.app.client_manager.compute
server = compute_client.find_server(
parsed_args.server, ignore_missing=False
)
if self.app.client_manager.is_network_endpoint_enabled():
# the server handles both names and IDs for neutron SGs, so just
# pass things through if using neutron
security_groups = parsed_args.security_groups
else:
# however, if using nova-network then it needs names, not IDs
security_groups = []
for security_group in parsed_args.security_groups:
security_groups.append(
compute_v2.find_security_group(
compute_client, security_group
)['name']
)
errors = 0
for security_group in security_groups:
try:
# SDK wants a SecurityGroup object but will handle a dict
compute_client.add_security_group_to_server(
server,
{'name': security_group}, # type: ignore[arg-type]
)
except sdk_exceptions.HttpException as e:
errors += 1
LOG.error(
_(
"Failed to add security group with name or ID "
"'%(security_group)s' to server '%(server)s': %(e)s"
),
{
'security_group': security_group,
'server': server.id,
'e': e,
},
)
if errors > 0:
msg = _(
"%(errors)d of %(total)d security groups were not added."
) % {'errors': errors, 'total': len(security_groups)}
raise exceptions.CommandError(msg)
class AddServerVolume(command.ShowOne):
_description = _(
"""Add volume to server.
Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server
with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
)
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'server',
metavar='<server>',
help=_('Server (name or ID)'),
)
parser.add_argument(
'volume',
metavar='<volume>',
help=_('Volume to add (name or ID)'),
)
parser.add_argument(
'--device',
metavar='<device>',
help=_('Server internal device name for volume'),
)
parser.add_argument(
'--tag',
metavar='<tag>',
help=_(
'Tag for the attached volume '
'(supported by --os-compute-api-version 2.49 or above)'
),
)
# TODO(stephenfin): These should be called 'delete-on-termination' and
# 'preserve-on-termination'
termination_group = parser.add_mutually_exclusive_group()
termination_group.add_argument(
'--enable-delete-on-termination',
action='store_true',
help=_(
'Delete the volume when the server is destroyed '
'(supported by --os-compute-api-version 2.79 or above)'
),
)
termination_group.add_argument(
'--disable-delete-on-termination',
action='store_true',
help=_(
'Do not delete the volume when the server is destroyed '
'(supported by --os-compute-api-version 2.79 or above)'
),
)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[Sequence[str], Iterable[Any]]:
compute_client = self.app.client_manager.compute
volume_client = self.app.client_manager.volume
server = compute_client.find_server(
parsed_args.server,
ignore_missing=False,
)
volume = volume_client.find_volume(
parsed_args.volume,
ignore_missing=False,
)
kwargs = {"volumeId": volume.id, "device": parsed_args.device}
if parsed_args.tag:
if not sdk_utils.supports_microversion(compute_client, '2.49'):
msg = _(
'--os-compute-api-version 2.49 or greater is required to '
'support the --tag option'
)
raise exceptions.CommandError(msg)
kwargs['tag'] = parsed_args.tag
if parsed_args.enable_delete_on_termination:
if not sdk_utils.supports_microversion(compute_client, '2.79'):
msg = _(
'--os-compute-api-version 2.79 or greater is required to '
'support the --enable-delete-on-termination option.'
)
raise exceptions.CommandError(msg)
kwargs['delete_on_termination'] = True
if parsed_args.disable_delete_on_termination:
if not sdk_utils.supports_microversion(compute_client, '2.79'):
msg = _(
'--os-compute-api-version 2.79 or greater is required to '
'support the --disable-delete-on-termination option.'
)
raise exceptions.CommandError(msg)
kwargs['delete_on_termination'] = False
volume_attachment = compute_client.create_volume_attachment(
server,
**kwargs,
)
columns: tuple[str, ...] = ('id', 'server id', 'volume id', 'device')
column_headers: tuple[str, ...] = (
'ID',
'Server ID',
'Volume ID',
'Device',
)
if sdk_utils.supports_microversion(compute_client, '2.49'):
columns += ('tag',)
column_headers += ('Tag',)
if sdk_utils.supports_microversion(compute_client, '2.79'):
columns += ('delete_on_termination',)
column_headers += ('Delete On Termination',)
return (
column_headers,
utils.get_item_properties(
volume_attachment,
columns,
),
)
class NoneNICAction(argparse.Action):
def __init__(
self,
option_strings: list[str],
dest: str,
help: str | None = None,
) -> None:
super().__init__(
option_strings=option_strings,
dest=dest,
nargs=0,
default=[],
required=False,
help=help,
)
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: Any,
option_string: str | None = None,
) -> None:
# Make sure we have an empty dict rather than None
if getattr(namespace, self.dest, None) is None:
setattr(namespace, self.dest, [])
getattr(namespace, self.dest).append('none')
class AutoNICAction(argparse.Action):
def __init__(
self,
option_strings: list[str],
dest: str,
help: str | None = None,
) -> None:
super().__init__(
option_strings=option_strings,
dest=dest,
nargs=0,
default=[],
required=False,
help=help,
)
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: Any,
option_string: str | None = None,
) -> None:
# Make sure we have an empty dict rather than None
if getattr(namespace, self.dest, None) is None:
setattr(namespace, self.dest, [])
getattr(namespace, self.dest).append('auto')
class NICAction(argparse.Action):
def __init__(
self,
option_strings: list[str],
dest: str,
help: str | None = None,
metavar: str | None = None,
key: str | None = None,
) -> None:
self.key = key
super().__init__(
option_strings=option_strings,
dest=dest,
nargs=None,
const=None,
default=[],
type=None,
choices=None,
required=False,
help=help,
metavar=metavar,
)
def __call__(
self,
parser: argparse.ArgumentParser,
namespace: argparse.Namespace,
values: Any,
option_string: str | None = None,
) -> None:
# Make sure we have an empty dict rather than None
if getattr(namespace, self.dest, None) is None:
setattr(namespace, self.dest, [])
if self.key:
if ',' in values or '=' in values:
msg = _(
"Invalid argument %s; characters ',' and '=' are not "
"allowed"
)
raise argparse.ArgumentError(self, msg % values)
values = '='.join([self.key, values])
else:
# Handle the special auto/none cases but only when a key isn't set
# (otherwise those could be valid values for the key)
if values in ('auto', 'none'):
getattr(namespace, self.dest).append(values)
return
# We don't include 'tag' here by default since that requires a
# particular microversion
info = {
'net-id': '',
'port-id': '',
'v4-fixed-ip': '',
'v6-fixed-ip': '',
}
for kv_str in values.split(','):
k, _sep, v = kv_str.partition('=')
if k not in [*list(info), 'tag'] or not v:
msg = _(
"Invalid argument %s; argument must be of form "
"'net-id=net-uuid,port-id=port-uuid,v4-fixed-ip=ip-addr,"
"v6-fixed-ip=ip-addr,tag=tag'"