summaryrefslogtreecommitdiffstats
path: root/snaps/openstack/create_qos.py
blob: 44e35a36ef52ab2a1ac73bbe09039df977280dc2 (plain)
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
# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
#                    and others.  All rights reserved.
#
# 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

import enum
from cinderclient.exceptions import NotFound

from snaps.config.qos import QoSConfig
from snaps.openstack.openstack_creator import OpenStackVolumeObject
from snaps.openstack.utils import cinder_utils

__author__ = 'spisarski'

logger = logging.getLogger('create_qos')

IMAGE_ACTIVE_TIMEOUT = 600
POLL_INTERVAL = 3
STATUS_ACTIVE = 'active'


class OpenStackQoS(OpenStackVolumeObject):
    """
    Class responsible for managing an qos in OpenStack
    """

    def __init__(self, os_creds, qos_settings):
        """
        Constructor
        :param os_creds: The OpenStack connection credentials
        :param qos_settings: The qos settings
        :return:
        """
        super(self.__class__, self).__init__(os_creds)

        self.qos_settings = qos_settings
        self.__qos = None

    def initialize(self):
        """
        Loads the existing QoS
        :return: The QoS domain object or None
        """
        super(self.__class__, self).initialize()

        self.__qos = cinder_utils.get_qos(
            self._cinder, qos_settings=self.qos_settings)

        return self.__qos

    def create(self):
        """
        Creates the qos in OpenStack if it does not already exist and returns
        the domain QoS object
        :return: The QoS domain object or None
        """
        self.initialize()

        if not self.__qos:
            self.__qos = cinder_utils.create_qos(
                self._cinder, self.qos_settings)

            logger.info(
                'Created qos with name - %s', self.qos_settings.name)

        return self.__qos

    def clean(self):
        """
        Cleanse environment of all artifacts
        :return: void
        """
        if self.__qos:
            try:
                cinder_utils.delete_qos(self._cinder, self.__qos)
            except NotFound:
                pass

        self.__qos = None

    def get_qos(self):
        """
        Returns the domain QoS object as it was populated when create() was
        called
        :return: the object
        """
        return self.__qos


class Consumer(enum.Enum):
    """
    QoS Specification consumer types
    deprecated - use snaps.config.qos.Consumer
    """
    front_end = 'front-end'
    back_end = 'back-end'
    both = 'both'


class QoSSettings(QoSConfig):
    """
    Class to hold the configuration settings required for creating OpenStack
    QoS objects
    deprecated
    """

    def __init__(self, **kwargs):
        from warnings import warn
        warn('Use snaps.config.qos.QoSConfig instead',
             DeprecationWarning)
        super(self.__class__, self).__init__(**kwargs)


class QoSCreationError(Exception):
    """
    Exception to be thrown when an qos cannot be created
    """

    def __init__(self, message):
        Exception.__init__(self, message)