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
23 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 "cluster_issuer": lambda value
, _
: isinstance(value
, str)
68 "ingress_whitelist_source_range": lambda value
, _
: _validate_ip_network(value
),
69 "tls_secret_name": lambda value
, _
: isinstance(value
, str)
73 relation_validators
= {
74 "mongodb_connection_string": lambda value
, _
: (
75 isinstance(value
, str) and value
.startswith("mongodb://")
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.
109 "name": "mongo-exporter",
110 "containerPort": port
,
116 def _make_pod_envconfig(
117 config
: Dict
[str, Any
], relation_state
: Dict
[str, Any
]
119 """Generate pod environment configuration.
122 config (Dict[str, Any]): configuration information.
123 relation_state (Dict[str, Any]): relation state information.
126 Dict[str, Any]: pod environment configuration.
128 parsed
= urlparse(relation_state
.get("mongodb_connection_string"))
131 "MONGODB_URI": f
"mongodb://{parsed.netloc.split(',')[0]}{parsed.path}",
135 envconfig
["MONGODB_URI"] += f
"?{parsed.query}"
140 def _make_pod_ingress_resources(
141 config
: Dict
[str, Any
], app_name
: str, port
: int
142 ) -> List
[Dict
[str, Any
]]:
143 """Generate pod ingress resources.
146 config (Dict[str, Any]): configuration information.
147 app_name (str): application name.
148 port (int): port to expose.
151 List[Dict[str, Any]]: pod ingress resources.
153 site_url
= config
.get("site_url")
158 parsed
= urlparse(site_url
)
160 if not parsed
.scheme
.startswith("http"):
163 ingress_whitelist_source_range
= config
["ingress_whitelist_source_range"]
164 cluster_issuer
= config
["cluster_issuer"]
168 if ingress_whitelist_source_range
:
170 "nginx.ingress.kubernetes.io/whitelist-source-range"
171 ] = ingress_whitelist_source_range
174 annotations
["cert-manager.io/cluster-issuer"] = cluster_issuer
176 ingress_spec_tls
= None
178 if parsed
.scheme
== "https":
179 ingress_spec_tls
= [{"hosts": [parsed
.hostname
]}]
180 tls_secret_name
= config
["tls_secret_name"]
182 ingress_spec_tls
[0]["secretName"] = tls_secret_name
184 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
187 "name": "{}-ingress".format(app_name
),
188 "annotations": annotations
,
192 "host": parsed
.hostname
,
198 "serviceName": app_name
,
209 ingress
["spec"]["tls"] = ingress_spec_tls
214 def _make_readiness_probe(port
: int) -> Dict
[str, Any
]:
215 """Generate readiness probe.
218 port (int): service port.
221 Dict[str, Any]: readiness probe.
225 "path": "/api/health",
228 "initialDelaySeconds": 10,
231 "successThreshold": 1,
232 "failureThreshold": 3,
236 def _make_liveness_probe(port
: int) -> Dict
[str, Any
]:
237 """Generate liveness probe.
240 port (int): service port.
243 Dict[str, Any]: liveness probe.
247 "path": "/api/health",
250 "initialDelaySeconds": 60,
251 "timeoutSeconds": 30,
252 "failureThreshold": 10,
257 image_info
: Dict
[str, str],
258 config
: Dict
[str, Any
],
259 relation_state
: Dict
[str, Any
],
260 app_name
: str = "mongodb-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
)
292 "imageDetails": image_info
,
293 "imagePullPolicy": "Always",
295 "envConfig": env_config
,
297 "readinessProbe": readiness_probe
,
298 "livenessProbe": liveness_probe
,
302 "kubernetesResources": {
303 "ingressResources": ingress_resources
or [],