1
=== modified file 'config.yaml'
2
--- config.yaml	2019-02-03 14:50:36 +0000
3
+++ config.yaml	2021-12-16 20:35:21 +0000
4
@@ -21,7 +21,7 @@
5
21
  origin:
21
  origin:
6
22
    description: |
22
    description: |
7
23
      *DEPRECATED*. See install_sources and install_keys
23
      *DEPRECATED*. See install_sources and install_keys
9
24
      
24
10
25
      Origin of ppa or private deb repository from which to install
25
      Origin of ppa or private deb repository from which to install
11
26
      landscape-client.  May be one of the following:
26
      landscape-client.  May be one of the following:
12
27
      distro (default), ppa:somecustom/ppa or a full APT url source
27
      distro (default), ppa:somecustom/ppa or a full APT url source
13
@@ -131,4 +131,15 @@
14
131
      regardless of the setting created by the unattended-upgrades package.
131
      regardless of the setting created by the unattended-upgrades package.
15
132
    type: boolean
132
    type: boolean
16
133
    default: False
133
    default: False
18
134
134
  juju-annotations-enabled:
19
135
    description: |
20
136
      Periodically updates landscape annotations (key:value) for each juju agent
21
137
      found on the machine and the juju availability-zone (AZ) of the machine.
22
138
      Key is 'juju-${application}' OR 'juju-az-${AZ}' if an AZ is set.
23
139
      Additionally, annotations for 'juju-${application}-${unit_number}' will
24
140
      be set. Values are 'deployed=true' OR 'deployed=false' denoting presence
25
141
      of these agents.
26
142
      Example: juju-landscape-client:deployed=true
27
143
      Cronjob runs every 5 min, update frequency depends on exchange-interval.
28
144
    type: boolean
29
145
    default: False
30
135
146
31
=== modified file 'hooks/hooks.py'
32
--- hooks/hooks.py	2019-04-04 16:07:48 +0000
33
+++ hooks/hooks.py	2021-12-16 20:35:21 +0000
34
@@ -18,7 +18,8 @@
35
18
from ceph import (
18
from ceph import (
36
19
    get_ceph_client_path, write_ceph_client_keyring, write_ceph_client_config)
19
    get_ceph_client_path, write_ceph_client_keyring, write_ceph_client_config)
37
20
20
39
21
from install import install
21
from install import (
40
22
    install, create_annotations_cronjob, remove_annotations_cronjob)
41
22
23
42
23
CERT_FILE = "/etc/ssl/certs/landscape_server_ca.crt"
24
CERT_FILE = "/etc/ssl/certs/landscape_server_ca.crt"
43
24
25
44
@@ -62,6 +63,12 @@
45
62
            else:
63
            else:
46
63
                set_config[key] = value
64
                set_config[key] = value
47
64
65
48
66
    # Manage toggling of juju-annotations cronjob
49
67
    if service_config["juju-annotations-enabled"]:
50
68
        create_annotations_cronjob()
51
69
    else:
52
70
        remove_annotations_cronjob()
53
71
54
65
    relation_data.update(set_config)
72
    relation_data.update(set_config)
55
66
    if service_config.get("disable-unattended-upgrades"):
73
    if service_config.get("disable-unattended-upgrades"):
56
67
        Cnf = apt_pkg.Configuration()
74
        Cnf = apt_pkg.Configuration()
57
68
75
58
=== modified file 'hooks/install.py'
59
--- hooks/install.py	2019-02-03 14:50:36 +0000
60
+++ hooks/install.py	2021-12-16 20:35:21 +0000
61
@@ -7,14 +7,19 @@
62
7
7
63
8
import subprocess
8
import subprocess
64
9
import sys
9
import sys
65
10
from os import environ, remove
66
10
11
67
11
from charmhelpers import fetch
12
from charmhelpers import fetch
68
12
import charmhelpers.core.hookenv as hookenv
13
import charmhelpers.core.hookenv as hookenv
69
14
import charmhelpers.core.host as host
70
13
15
71
14
16
72
15
hooks = hookenv.Hooks()
17
hooks = hookenv.Hooks()
73
16
18
74
17
19
75
20
ANNOTATIONS_CRON_PATH = '/etc/cron.d/landscape-client-juju-annotations'
76
21
77
22
78
18
@hooks.hook("install")
23
@hooks.hook("install")
79
19
def install(fetch=fetch, hookenv=hookenv):
24
def install(fetch=fetch, hookenv=hookenv):
80
20
    charm_config = hookenv.config()
25
    charm_config = hookenv.config()
81
@@ -34,6 +39,11 @@
82
34
            "install", "-o", "landscape", "-g", "root", "-m", "755", "-d",
39
            "install", "-o", "landscape", "-g", "root", "-m", "755", "-d",
83
35
            data_path])
40
            data_path])
84
36
41
85
42
    if charm_config["juju-annotations-enabled"]:
86
43
        create_annotations_cronjob()
87
44
    else:
88
45
        remove_annotations_cronjob()
89
46
90
37
47
91
38
def add_apt_source(url, fetch=fetch):
48
def add_apt_source(url, fetch=fetch):
92
39
    """Add an apt source entry, with passed in key.
49
    """Add an apt source entry, with passed in key.
93
@@ -54,6 +64,30 @@
94
54
    return fetch.add_source(url, key)
64
    return fetch.add_source(url, key)
95
55
65
96
56
66
97
67
def create_annotations_cronjob():
98
68
    hookenv.log('Create juju-annotations cronjob', hookenv.DEBUG)
99
69
    unit_name = hookenv.local_unit()
100
70
    agent_name = 'unit-' + unit_name.replace('/', '-')
101
71
    zone_env = ""
102
72
    if environ['JUJU_AVAILABILITY_ZONE']:
103
73
        az = environ['JUJU_AVAILABILITY_ZONE']
104
74
        zone_env = "JUJU_AVAILABILITY_ZONE=%s" % az
105
75
    data_path = hookenv.config().get("data-path")
106
76
    if not data_path:
107
77
        data_path = "/var/lib/landscape/client"
108
78
    cronjob = (
109
79
            "*/5 * * * * root %s "
110
80
            "/var/lib/juju/agents/%s/charm/scripts/write_juju_annotations.py "
111
81
            "%s\n"
112
82
        ) % (zone_env, agent_name, data_path)
113
83
    host.write_file(ANNOTATIONS_CRON_PATH, cronjob)
114
84
115
85
116
86
def remove_annotations_cronjob():
117
87
    hookenv.log('Remove juju-annotations cronjob', hookenv.DEBUG)
118
88
    remove(ANNOTATIONS_CRON_PATH)
119
89
120
90
121
57
if __name__ == '__main__':
91
if __name__ == '__main__':
122
58
    try:
92
    try:
123
59
        sys.exit(hooks.execute(sys.argv))
93
        sys.exit(hooks.execute(sys.argv))
124
60
94
125
=== added directory 'scripts'
126
=== added file 'scripts/write_juju_annotations.py'
127
--- scripts/write_juju_annotations.py	1970-01-01 00:00:00 +0000
128
+++ scripts/write_juju_annotations.py	2021-12-16 20:35:21 +0000
129
@@ -0,0 +1,64 @@
130
1
#!/usr/bin/env python3
131
2
"""Update landscape-client juju info annotations.
132
3
133
4
usage: [JUJU_AVAILABILITY_ZONE="zone1"] write-juju-annotations [lds-data-path]
134
5
"""
135
6
136
7
import sys
137
8
import os
138
9
import re
139
10
140
11
141
12
JUJU_AGENT_DIR = "/var/lib/juju/agents"
142
13
LDS_CLIENT_DATA_PATH = "/var/lib/landscape/client"
143
14
144
15
145
16
def write_juju_annotations(argv):
146
17
    """Write annotation files in the '$DATA_PATH/annotations.d' folder.
147
18
148
19
    For each currently deployed juju unit and one annotation for the juju
149
20
    availability zone (if JUJU_AVAILABILITY_ZONE is set). The
150
21
    annotation-value/file-content is 'deployed=true'.
151
22
152
23
    For previously-deployed/removed units change the annotation value to
153
24
    'deployed=false'.
154
25
155
26
    This is used in conjunction with lp:charm-landscape-tagger.
156
27
    """
157
28
    if len(argv) == 2:
158
29
        data_path = argv[1]
159
30
    else:
160
31
        data_path = LDS_CLIENT_DATA_PATH
161
32
    annotations_folder = os.path.join(data_path, 'annotations.d')
162
33
    unit_regex = re.compile(r"^unit-(((\w|-)+)-\d+)")
163
34
    prefix = 'juju-'
164
35
165
36
    target_annotations = []
166
37
    for agent in os.listdir(JUJU_AGENT_DIR):
167
38
        result = unit_regex.match(agent)
168
39
        if result:
169
40
            unit = result[1]
170
41
            app = result[2]
171
42
            target_annotations.append(prefix + unit)
172
43
            target_annotations.append(prefix + app)
173
44
174
45
    current_annotations = \
175
46
        [a for a in os.listdir(annotations_folder) if a.startswith(prefix)]
176
47
177
48
    if "JUJU_AVAILABILITY_ZONE" in os.environ:
178
49
        target_annotations.append(
179
50
            f"juju-az-{os.environ['JUJU_AVAILABILITY_ZONE']}"
180
51
        )
181
52
182
53
    all_annotations = list(set(target_annotations + current_annotations))
183
54
    for annotation in all_annotations:
184
55
        annotation_file = os.path.join(annotations_folder, annotation)
185
56
        with open(annotation_file, "w") as f:
186
57
            if annotation in target_annotations:
187
58
                f.write("deployed=true")
188
59
            else:
189
60
                f.write("deployed=false")
190
61
191
62
192
63
if __name__ == '__main__':
193
64
    write_juju_annotations(sys.argv)
Status:	Rejected
Rejected by:	Haw Loeung on 2022-10-28
Proposed branch:	lp:~afreiberger/landscape-client-charm/add-juju-annotations
Merge into:	lp:landscape-client-charm
Diff against target:	193 lines (+119/-3) 4 files modified config.yaml (+13/-2) hooks/hooks.py (+8/-1) hooks/install.py (+34/-0) scripts/write_juju_annotations.py (+64/-0)
To merge this branch:	bzr merge lp:~afreiberger/landscape-client-charm/add-juju-annotations
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
🤖 Landscape Builder	test results		Needs Fixing on 2022-04-29
Simon Poirier (community)		2021-12-15	Needs Fixing on 2022-01-17
Review via email: mp+413315@code.launchpad.net