summaryrefslogtreecommitdiff
path: root/src/op_mode/container.py
blob: f93df0fc4e359314466925b0583972f88e252a1e (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
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
#!/usr/bin/env python3
#
# Copyright (C) 2022-2024 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import json
import sys
import subprocess

from vyos.utils.process import cmd
from vyos.utils.process import rc_cmd
import vyos.opmode

def _get_json_data(command: str) -> list:
    """
    Get container command format JSON
    """
    return cmd(f'{command} --format json')

def _get_raw_data(command: str) -> list:
    json_data = _get_json_data(command)
    data = json.loads(json_data)
    return data

def add_image(name: str):
    """ Pull image from container registry. If registry authentication
    is defined within VyOS CLI, credentials are used to login befroe pull """
    from vyos.configquery import ConfigTreeQuery

    conf = ConfigTreeQuery()
    container = conf.get_config_dict(['container', 'registry'])

    do_logout = False
    if 'registry' in container:
        for registry, registry_config in container['registry'].items():
            if 'disable' in registry_config:
                continue
            if 'authentication' in registry_config:
                do_logout = True
                if {'username', 'password'} <= set(registry_config['authentication']):
                    username = registry_config['authentication']['username']
                    password = registry_config['authentication']['password']
                    cmd = f'podman login --username {username} --password {password} {registry}'
                    rc, out = rc_cmd(cmd)
                    if rc != 0: raise vyos.opmode.InternalError(out)

    rc, output = rc_cmd(f'podman image pull {name}')
    if rc != 0:
        raise vyos.opmode.InternalError(output)

    if do_logout:
        rc_cmd('podman logout --all')

def delete_image(name: str):
    from vyos.utils.process import rc_cmd

    if name == 'all':
        # gather list of all images and pass them to the removal list
        name = cmd('sudo podman image ls --quiet')
        # If there are no container images left, we can not delete them all
        if not name: return
        # replace newline with whitespace
        name = name.replace('\n', ' ')
    rc, output = rc_cmd(f'podman image rm {name}')
    if rc != 0:
        raise vyos.opmode.InternalError(output)

def show_container(raw: bool):
    command = 'podman ps --all'
    container_data = _get_raw_data(command)
    if raw:
        return container_data
    else:
        return cmd(command)

def show_image(raw: bool):
    command = 'podman image ls'
    container_data = _get_raw_data('podman image ls')
    if raw:
        return container_data
    else:
        return cmd(command)

def show_network(raw: bool):
    command = 'podman network ls'
    container_data = _get_raw_data(command)
    if raw:
        return container_data
    else:
        return cmd(command)

def restart(name: str):
    from vyos.utils.process import rc_cmd

    rc, output = rc_cmd(f'systemctl restart vyos-container-{name}.service')
    if rc != 0:
        print(output)
        return None
    print(f'Container "{name}" restarted!')
    return output

def show_log(name: str, follow: bool = False, raw: bool = False):
    """
    Show or monitor logs for a specific container.
    Use --follow to continuously stream logs.
    """
    from vyos.configquery import ConfigTreeQuery
    conf = ConfigTreeQuery()
    container = conf.get_config_dict(['container', 'name', name],  get_first_key=True, with_recursive_defaults=True)
    log_type = container.get('log-driver')
    if log_type == 'k8s-file':
        if follow:
            log_command_list = ['sudo', 'podman', 'logs', '--follow', '--names', name]
        else:
            log_command_list = ['sudo', 'podman', 'logs', '--names', name]
    elif log_type == 'journald':
        if follow:
            log_command_list = ['journalctl', '--follow', '--unit', f'vyos-container-{name}.service']
        else:
            log_command_list = ['journalctl', '-e', '--no-pager', '--unit', f'vyos-container-{name}.service']
    elif log_type == 'none':
        print(f'Container "{name}" has disabled logs.')
        return None
    else:
        raise vyos.opmode.InternalError(f'Unknown log type "{log_type}" for container "{name}".')

    process = None
    try:
        process = subprocess.Popen(log_command_list,
                                   stdout=sys.stdout,
                                   stderr=sys.stderr)
        process.wait()
    except KeyboardInterrupt:
        if process:
            process.terminate()
            process.wait()
        return None
    except Exception as e:
        raise vyos.opmode.InternalError(f"Error starting logging command: {e} ")
    return None


if __name__ == '__main__':
    try:
        res = vyos.opmode.run(sys.modules[__name__])
        if res:
            print(res)
    except (ValueError, vyos.opmode.Error) as e:
        print(e)
        sys.exit(1)