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 "mysql_host": lambda value
, _
: isinstance(value
, str) and len(value
) > 0,
72 "mysql_port": lambda value
, _
: isinstance(value
, str) and int(value
) > 0,
73 "mysql_user": lambda value
, _
: isinstance(value
, str) and len(value
) > 0,
74 "mysql_password": lambda value
, _
: isinstance(value
, str) and len(value
) > 0,
75 "mysql_root_password": lambda value
, _
: isinstance(value
, str)
80 for key
, validator
in config_validators
.items():
81 valid
= validator(config_data
.get(key
), config_data
)
86 for key
, validator
in relation_validators
.items():
87 valid
= validator(relation_data
.get(key
), relation_data
)
93 raise ValueError("Errors found in: {}".format(", ".join(problems
)))
98 def _make_pod_ports(port
: int) -> List
[Dict
[str, Any
]]:
99 """Generate pod ports details.
102 port (int): port to expose.
105 List[Dict[str, Any]]: pod port details.
107 return [{"name": "mysqld-exporter", "containerPort": port
, "protocol": "TCP"}]
110 def _make_pod_envconfig(
111 config
: Dict
[str, Any
], relation_state
: Dict
[str, Any
]
113 """Generate pod environment configuration.
116 config (Dict[str, Any]): configuration information.
117 relation_state (Dict[str, Any]): relation state information.
120 Dict[str, Any]: pod environment configuration.
123 "DATA_SOURCE_NAME": "root:{mysql_root_password}@({mysql_host}:{mysql_port})/".format(
131 def _make_pod_ingress_resources(
132 config
: Dict
[str, Any
], app_name
: str, port
: int
133 ) -> List
[Dict
[str, Any
]]:
134 """Generate pod ingress resources.
137 config (Dict[str, Any]): configuration information.
138 app_name (str): application name.
139 port (int): port to expose.
142 List[Dict[str, Any]]: pod ingress resources.
144 site_url
= config
.get("site_url")
149 parsed
= urlparse(site_url
)
151 if not parsed
.scheme
.startswith("http"):
154 ingress_whitelist_source_range
= config
["ingress_whitelist_source_range"]
158 if ingress_whitelist_source_range
:
160 "nginx.ingress.kubernetes.io/whitelist-source-range"
161 ] = ingress_whitelist_source_range
163 ingress_spec_tls
= None
165 if parsed
.scheme
== "https":
166 ingress_spec_tls
= [{"hosts": [parsed
.hostname
]}]
167 tls_secret_name
= config
["tls_secret_name"]
169 ingress_spec_tls
[0]["secretName"] = tls_secret_name
171 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
174 "name": "{}-ingress".format(app_name
),
175 "annotations": annotations
,
179 "host": parsed
.hostname
,
185 "serviceName": app_name
,
196 ingress
["spec"]["tls"] = ingress_spec_tls
201 def _make_readiness_probe(port
: int) -> Dict
[str, Any
]:
202 """Generate readiness probe.
205 port (int): service port.
208 Dict[str, Any]: readiness probe.
212 "path": "/api/health",
215 "initialDelaySeconds": 10,
218 "successThreshold": 1,
219 "failureThreshold": 3,
223 def _make_liveness_probe(port
: int) -> Dict
[str, Any
]:
224 """Generate liveness probe.
227 port (int): service port.
230 Dict[str, Any]: liveness probe.
234 "path": "/api/health",
237 "initialDelaySeconds": 60,
238 "timeoutSeconds": 30,
239 "failureThreshold": 10,
244 image_info
: Dict
[str, str],
245 config
: Dict
[str, Any
],
246 relation_state
: Dict
[str, Any
],
247 app_name
: str = "mysqld-exporter",
250 """Generate the pod spec information.
253 image_info (Dict[str, str]): Object provided by
254 OCIImageResource("image").fetch().
255 config (Dict[str, Any]): Configuration information.
256 relation_state (Dict[str, Any]): Relation state information.
257 app_name (str, optional): Application name. Defaults to "ro".
258 port (int, optional): Port for the container. Defaults to 9090.
261 Dict[str, Any]: Pod spec dictionary for the charm.
266 _validate_data(config
, relation_state
)
268 ports
= _make_pod_ports(port
)
269 env_config
= _make_pod_envconfig(config
, relation_state
)
270 readiness_probe
= _make_readiness_probe(port
)
271 liveness_probe
= _make_liveness_probe(port
)
272 ingress_resources
= _make_pod_ingress_resources(config
, app_name
, port
)
279 "imageDetails": image_info
,
280 "imagePullPolicy": "Always",
282 "envConfig": env_config
,
284 "readinessProbe": readiness_probe
,
285 "livenessProbe": liveness_probe
,
289 "kubernetesResources": {
290 "ingressResources": ingress_resources
or [],