FilesExpand file tree

 master

/

client.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

150 lines (118 loc) · 4.58 KB

 master

/

client.py

Copy path

Top

File metadata and controls

• Code
• Blame

150 lines (118 loc) · 4.58 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

# 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.

#

import logging

from osc_lib import exceptions

from osc_lib import utils

from openstackclient.i18n import _

LOG = logging.getLogger(__name__)

DEFAULT_API_VERSION = '3'

API_VERSION_OPTION = 'os_volume_api_version'

API_NAME = "volume"

API_VERSIONS = {

"1": "cinderclient.v1.client.Client",

"2": "cinderclient.v2.client.Client",

"3": "cinderclient.v3.client.Client",

}

# Save the microversion if in use

_volume_api_version = None

def make_client(instance):

"""Returns a volume service client."""

# Defer client imports until we actually need them

from cinderclient import extension

from cinderclient.v3.contrib import list_extensions

from cinderclient.v3 import volume_snapshots

from cinderclient.v3 import volumes

# Check whether the available cinderclient supports v1 or v2

try:

from cinderclient.v1 import services # noqa

except Exception:

del API_VERSIONS['1']

try:

from cinderclient.v2 import services # noqa

except Exception:

del API_VERSIONS['2']

if _volume_api_version is not None:

version = _volume_api_version

else:

version = instance._api_version[API_NAME]

from cinderclient import api_versions

# convert to APIVersion object

version = api_versions.get_api_version(version)

if version.ver_major == '1':

# Monkey patch for v1 cinderclient

volumes.Volume.NAME_ATTR = 'display_name'

volume_snapshots.Snapshot.NAME_ATTR = 'display_name'

volume_client = utils.get_client_class(

API_NAME,

version.ver_major,

API_VERSIONS

)

LOG.debug('Instantiating volume client: %s', volume_client)

# Set client http_log_debug to True if verbosity level is high enough

http_log_debug = utils.get_effective_log_level() <= logging.DEBUG

extensions = [extension.Extension('list_extensions', list_extensions)]

# Remember interface only if it is set

kwargs = utils.build_kwargs_dict('endpoint_type', instance.interface)

endpoint_override = instance.sdk_connection.config.get_endpoint(

'block-storage')

client = volume_client(

session=instance.session,

extensions=extensions,

http_log_debug=http_log_debug,

region_name=instance.region_name,

endpoint_override=endpoint_override,

api_version=version,

**kwargs

)

return client

def build_option_parser(parser):

"""Hook to add global options"""

parser.add_argument(

'--os-volume-api-version',

metavar='<volume-api-version>',

default=utils.env('OS_VOLUME_API_VERSION'),

help=_('Volume API version, default=%s '

'(Env: OS_VOLUME_API_VERSION)') % DEFAULT_API_VERSION

)

return parser

def check_api_version(check_version):

"""Validate version supplied by user

Returns:

* True if version is OK

* False if the version has not been checked and the previous plugin

check should be performed

* throws an exception if the version is no good

"""

# Defer client imports until we actually need them

from cinderclient import api_versions

global _volume_api_version

# Copy some logic from novaclient 3.3.0 for basic version detection

# NOTE(dtroyer): This is only enough to resume operations using API

# version 3.0 or any valid version supplied by the user.

_volume_api_version = api_versions.get_api_version(check_version)

# Bypass X.latest format microversion

if not _volume_api_version.is_latest():

if _volume_api_version > api_versions.APIVersion("3.0"):

if not _volume_api_version.matches(

api_versions.MIN_VERSION,

api_versions.MAX_VERSION,

):

msg = _("versions supported by client: %(min)s - %(max)s") % {

"min": api_versions.MIN_VERSION,

"max": api_versions.MAX_VERSION,

}

raise exceptions.CommandError(msg)

return True

return False