2 # Copyright 2021 Canonical Ltd.
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
16 # For those usages not covered by the Apache License, Version 2.0 please
17 # contact: legal@canonical.com
19 # To get in touch with the maintainers, please contact:
20 # osm-charmers@lists.launchpad.net
24 from ipaddress
import ip_network
25 from typing
import Any
, Dict
, List
26 from urllib
.parse
import urlparse
28 logger
= logging
.getLogger(__name__
)
31 def _validate_ip_network(network
: str) -> bool:
32 """Validate IP network.
35 network (str): IP network range.
38 bool: True if valid, false otherwise.
51 def _validate_data(config_data
: Dict
[str, Any
], relation_data
: Dict
[str, Any
]) -> bool:
52 """Validates passed information.
55 config_data (Dict[str, Any]): configuration information.
56 relation_data (Dict[str, Any]): relation information
59 ValueError: when config and/or relation data is not valid.
62 "site_url": lambda value
, _
: isinstance(value
, str)
65 "ingress_whitelist_source_range": lambda value
, _
: _validate_ip_network(value
),
66 "tls_secret_name": lambda value
, _
: isinstance(value
, str)
70 relation_validators
= {
71 "kafka_host": lambda value
, _
: isinstance(value
, str) and len(value
) > 0,
72 "kafka_port": lambda value
, _
: isinstance(value
, str)
78 for key
, validator
in config_validators
.items():
79 valid
= validator(config_data
.get(key
), config_data
)
84 for key
, validator
in relation_validators
.items():
85 valid
= validator(relation_data
.get(key
), relation_data
)
91 raise ValueError("Errors found in: {}".format(", ".join(problems
)))
96 def _make_pod_ports(port
: int) -> List
[Dict
[str, Any
]]:
97 """Generate pod ports details.
100 port (int): port to expose.
103 List[Dict[str, Any]]: pod port details.
105 return [{"name": "kafka-exporter", "containerPort": port
, "protocol": "TCP"}]
108 def _make_pod_envconfig(
109 config
: Dict
[str, Any
], relation_state
: Dict
[str, Any
]
111 """Generate pod environment configuration.
114 config (Dict[str, Any]): configuration information.
115 relation_state (Dict[str, Any]): relation state information.
118 Dict[str, Any]: pod environment configuration.
125 def _make_pod_ingress_resources(
126 config
: Dict
[str, Any
], app_name
: str, port
: int
127 ) -> List
[Dict
[str, Any
]]:
128 """Generate pod ingress resources.
131 config (Dict[str, Any]): configuration information.
132 app_name (str): application name.
133 port (int): port to expose.
136 List[Dict[str, Any]]: pod ingress resources.
138 site_url
= config
.get("site_url")
143 parsed
= urlparse(site_url
)
145 if not parsed
.scheme
.startswith("http"):
148 ingress_whitelist_source_range
= config
["ingress_whitelist_source_range"]
152 if ingress_whitelist_source_range
:
154 "nginx.ingress.kubernetes.io/whitelist-source-range"
155 ] = ingress_whitelist_source_range
157 ingress_spec_tls
= None
159 if parsed
.scheme
== "https":
160 ingress_spec_tls
= [{"hosts": [parsed
.hostname
]}]
161 tls_secret_name
= config
["tls_secret_name"]
163 ingress_spec_tls
[0]["secretName"] = tls_secret_name
165 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
168 "name": "{}-ingress".format(app_name
),
169 "annotations": annotations
,
173 "host": parsed
.hostname
,
179 "serviceName": app_name
,
190 ingress
["spec"]["tls"] = ingress_spec_tls
195 def _make_readiness_probe(port
: int) -> Dict
[str, Any
]:
196 """Generate readiness probe.
199 port (int): service port.
202 Dict[str, Any]: readiness probe.
206 "path": "/api/health",
209 "initialDelaySeconds": 10,
212 "successThreshold": 1,
213 "failureThreshold": 3,
217 def _make_liveness_probe(port
: int) -> Dict
[str, Any
]:
218 """Generate liveness probe.
221 port (int): service port.
224 Dict[str, Any]: liveness probe.
228 "path": "/api/health",
231 "initialDelaySeconds": 60,
232 "timeoutSeconds": 30,
233 "failureThreshold": 10,
237 def _make_pod_command(relation
: Dict
[str, Any
]) -> List
[str]:
238 """Generate the startup command.
241 relation (Dict[str, Any]): Relation information.
244 List[str]: command to startup the process.
248 "--kafka.server={}:{}".format(
249 relation
.get("kafka_host"), relation
.get("kafka_port")
257 image_info
: Dict
[str, str],
258 config
: Dict
[str, Any
],
259 relation_state
: Dict
[str, Any
],
260 app_name
: str = "kafka-exporter",
263 """Generate the pod spec information.
266 image_info (Dict[str, str]): Object provided by
267 OCIImageResource("image").fetch().
268 config (Dict[str, Any]): Configuration information.
269 relation_state (Dict[str, Any]): Relation state information.
270 app_name (str, optional): Application name. Defaults to "ro".
271 port (int, optional): Port for the container. Defaults to 9090.
274 Dict[str, Any]: Pod spec dictionary for the charm.
279 _validate_data(config
, relation_state
)
281 ports
= _make_pod_ports(port
)
282 env_config
= _make_pod_envconfig(config
, relation_state
)
283 readiness_probe
= _make_readiness_probe(port
)
284 liveness_probe
= _make_liveness_probe(port
)
285 ingress_resources
= _make_pod_ingress_resources(config
, app_name
, port
)
286 command
= _make_pod_command(relation_state
)
293 "imageDetails": image_info
,
294 "imagePullPolicy": "Always",
296 "envConfig": env_config
,
299 "readinessProbe": readiness_probe
,
300 "livenessProbe": liveness_probe
,
304 "kubernetesResources": {
305 "ingressResources": ingress_resources
or [],