aboutsummaryrefslogtreecommitdiff
path: root/kolla/engine_adapter/engine.py
blob: dc38f4541dbc3c433611e26eae8b4deaaa5796d9 (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
# 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 enum import Enum
from kolla.image.utils import LOG

try:
    import docker
except (ImportError):
    LOG.debug("Docker python library was not found")

try:
    import podman
except (ImportError, ModuleNotFoundError):
    LOG.debug("Podman python library was not found")
    pass


class Engine(Enum):

    DOCKER = "docker"
    PODMAN = "podman"


class UnsupportedEngineError(ValueError):

    def __init__(self, engine_name):
        super().__init__()
        self.engine_name = engine_name

    def __str__(self):
        return f'Unsupported engine name given: "{self.engine_name}"'


def getEngineException(conf):
    if conf.engine == Engine.DOCKER.value:
        return (docker.errors.DockerException)
    elif conf.engine == Engine.PODMAN.value:
        return (podman.errors.exceptions.APIError,
                podman.errors.exceptions.PodmanError)
    else:
        raise UnsupportedEngineError(conf.engine)


def getEngineClient(conf):
    if conf.engine == Engine.DOCKER.value:
        kwargs_env = docker.utils.kwargs_from_env()
        return docker.DockerClient(version='auto', **kwargs_env)
    elif conf.engine == Engine.PODMAN.value:
        client = podman.PodmanClient(base_url=conf.podman_base_url)
        try:
            client.version()
        except podman.errors.exceptions.APIError as e:
            e.explanation += (". Check if podman service is active and "
                              "the address to podman.sock is set correctly "
                              "through --podman_base_url")
            raise e
        return client
    else:
        raise UnsupportedEngineError(conf.engine)