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 # pylint: disable=E0213
25 from ipaddress
import ip_network
27 from pathlib
import Path
28 from typing
import NoReturn
, Optional
29 from urllib
.parse
import urlparse
31 from ops
.main
import main
32 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
33 from opslib
.osm
.interfaces
.grafana
import GrafanaDashboardTarget
34 from opslib
.osm
.interfaces
.mysql
import MysqlClient
35 from opslib
.osm
.interfaces
.prometheus
import PrometheusScrapeTarget
36 from opslib
.osm
.pod
import (
38 IngressResourceV3Builder
,
41 from opslib
.osm
.validator
import ModelValidator
, validator
44 logger
= logging
.getLogger(__name__
)
49 class ConfigModel(ModelValidator
):
50 site_url
: Optional
[str]
51 cluster_issuer
: Optional
[str]
52 ingress_whitelist_source_range
: Optional
[str]
53 tls_secret_name
: Optional
[str]
54 mysql_uri
: Optional
[str]
56 @validator("site_url")
57 def validate_site_url(cls
, v
):
60 if not parsed
.scheme
.startswith("http"):
61 raise ValueError("value must start with http")
64 @validator("ingress_whitelist_source_range")
65 def validate_ingress_whitelist_source_range(cls
, v
):
70 @validator("mysql_uri")
71 def validate_mysql_uri(cls
, v
):
72 if v
and not v
.startswith("mysql://"):
73 raise ValueError("mysql_uri is not properly formed")
77 class MysqlExporterCharm(CharmedOsmBase
):
78 def __init__(self
, *args
) -> NoReturn
:
79 super().__init
__(*args
, oci_image
="image")
81 # Provision Kafka relation to exchange information
82 self
.mysql_client
= MysqlClient(self
, "mysql")
83 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
84 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
86 # Register relation to provide a Scraping Target
87 self
.scrape_target
= PrometheusScrapeTarget(self
, "prometheus-scrape")
88 self
.framework
.observe(
89 self
.on
["prometheus-scrape"].relation_joined
, self
._publish
_scrape
_info
92 # Register relation to provide a Dasboard Target
93 self
.dashboard_target
= GrafanaDashboardTarget(self
, "grafana-dashboard")
94 self
.framework
.observe(
95 self
.on
["grafana-dashboard"].relation_joined
, self
._publish
_dashboard
_info
98 def _publish_scrape_info(self
, event
) -> NoReturn
:
99 """Publishes scraping information for Prometheus.
102 event (EventBase): Prometheus relation event.
104 if self
.unit
.is_leader():
106 urlparse(self
.model
.config
["site_url"]).hostname
107 if self
.model
.config
["site_url"]
108 else self
.model
.app
.name
111 if self
.model
.config
.get("site_url", "").startswith("https://"):
113 elif self
.model
.config
.get("site_url", "").startswith("http://"):
116 self
.scrape_target
.publish_info(
119 metrics_path
="/metrics",
120 scrape_interval
="30s",
121 scrape_timeout
="15s",
124 def _publish_dashboard_info(self
, event
) -> NoReturn
:
125 """Publish dashboards for Grafana.
128 event (EventBase): Grafana relation event.
130 if self
.unit
.is_leader():
131 self
.dashboard_target
.publish_info(
133 dashboard
=Path("files/mysql_exporter_dashboard.json").read_text(),
136 def _check_missing_dependencies(self
, config
: ConfigModel
):
137 """Check if there is any relation missing.
140 config (ConfigModel): object with configuration information.
143 RelationsMissing: if kafka is missing.
145 missing_relations
= []
147 if not config
.mysql_uri
and self
.mysql_client
.is_missing_data_in_unit():
148 missing_relations
.append("mysql")
150 if missing_relations
:
151 raise RelationsMissing(missing_relations
)
153 def build_pod_spec(self
, image_info
):
154 """Build the PodSpec to be used.
157 image_info (str): container image information.
160 Dict: PodSpec information.
163 config
= ConfigModel(**dict(self
.config
))
165 if config
.mysql_uri
and not self
.mysql_client
.is_missing_data_in_unit():
166 raise Exception("Mysql data cannot be provided via config and relation")
169 self
._check
_missing
_dependencies
(config
)
171 # Create Builder for the PodSpec
172 pod_spec_builder
= PodSpecV3Builder()
175 container_builder
= ContainerV3Builder(self
.app
.name
, image_info
)
176 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
177 container_builder
.add_http_readiness_probe(
180 initial_delay_seconds
=10,
186 container_builder
.add_http_liveness_probe(
189 initial_delay_seconds
=60,
191 failure_threshold
=10,
195 config
.mysql_uri
.replace("mysql://", "").split("/")[0]
197 else f
"root:{self.mysql_client.root_password}@{self.mysql_client.host}:{self.mysql_client.port}"
200 container_builder
.add_envs(
202 "DATA_SOURCE_NAME": data_source
,
205 container
= container_builder
.build()
207 # Add container to PodSpec
208 pod_spec_builder
.add_container(container
)
210 # Add ingress resources to PodSpec if site url exists
212 parsed
= urlparse(config
.site_url
)
214 ingress_resource_builder
= IngressResourceV3Builder(
215 f
"{self.app.name}-ingress", annotations
218 if config
.ingress_whitelist_source_range
:
220 "nginx.ingress.kubernetes.io/whitelist-source-range"
221 ] = config
.ingress_whitelist_source_range
223 if config
.cluster_issuer
:
224 annotations
["cert-manager.io/cluster-issuer"] = config
.cluster_issuer
226 if parsed
.scheme
== "https":
227 ingress_resource_builder
.add_tls(
228 [parsed
.hostname
], config
.tls_secret_name
231 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
233 ingress_resource_builder
.add_rule(parsed
.hostname
, self
.app
.name
, PORT
)
234 ingress_resource
= ingress_resource_builder
.build()
235 pod_spec_builder
.add_ingress_resource(ingress_resource
)
237 logger
.debug(pod_spec_builder
.build())
239 return pod_spec_builder
.build()
242 if __name__
== "__main__":
243 main(MysqlExporterCharm
)