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
29 from string
import Template
30 from typing
import NoReturn
, Optional
31 from urllib
.parse
import urlparse
33 from ops
.main
import main
34 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
35 from opslib
.osm
.interfaces
.grafana
import GrafanaCluster
36 from opslib
.osm
.interfaces
.mysql
import MysqlClient
37 from opslib
.osm
.interfaces
.prometheus
import PrometheusClient
38 from opslib
.osm
.pod
import (
41 IngressResourceV3Builder
,
45 from opslib
.osm
.validator
import ModelValidator
, validator
48 logger
= logging
.getLogger(__name__
)
51 class ConfigModel(ModelValidator
):
57 site_url
: Optional
[str]
58 cluster_issuer
: Optional
[str]
59 ingress_class
: Optional
[str]
60 ingress_whitelist_source_range
: Optional
[str]
61 tls_secret_name
: Optional
[str]
62 image_pull_policy
: str
64 @validator("log_level")
65 def validate_log_level(cls
, v
):
66 allowed_values
= ("debug", "info", "warn", "error", "critical")
67 if v
not in allowed_values
:
70 f
'incorrect value. Allowed values are "{separator.join(allowed_values)}"'
74 @validator("max_file_size")
75 def validate_max_file_size(cls
, v
):
77 raise ValueError("value must be equal or greater than 0")
80 @validator("site_url")
81 def validate_site_url(cls
, v
):
84 if not parsed
.scheme
.startswith("http"):
85 raise ValueError("value must start with http")
88 @validator("ingress_whitelist_source_range")
89 def validate_ingress_whitelist_source_range(cls
, v
):
94 @validator("image_pull_policy")
95 def validate_image_pull_policy(cls
, v
):
98 "ifnotpresent": "IfNotPresent",
102 if v
not in values
.keys():
103 raise ValueError("value must be always, ifnotpresent or never")
107 class GrafanaCharm(CharmedOsmBase
):
108 """GrafanaCharm Charm."""
110 def __init__(self
, *args
) -> NoReturn
:
111 """Prometheus Charm constructor."""
112 super().__init
__(*args
, oci_image
="image", mysql_uri
=True)
113 # Initialize relation objects
114 self
.prometheus_client
= PrometheusClient(self
, "prometheus")
115 self
.grafana_cluster
= GrafanaCluster(self
, "cluster")
116 self
.mysql_client
= MysqlClient(self
, "db")
118 event_observer_mapping
= {
119 self
.on
["prometheus"].relation_changed
: self
.configure_pod
,
120 self
.on
["prometheus"].relation_broken
: self
.configure_pod
,
121 self
.on
["db"].relation_changed
: self
.configure_pod
,
122 self
.on
["db"].relation_broken
: self
.configure_pod
,
124 for event
, observer
in event_observer_mapping
.items():
125 self
.framework
.observe(event
, observer
)
127 def _build_dashboard_files(self
, config
: ConfigModel
):
128 files_builder
= FilesV3Builder()
129 files_builder
.add_file(
130 "dashboard_osm.yaml",
131 Path("templates/default_dashboards.yaml").read_text(),
133 if config
.osm_dashboards
:
134 osm_dashboards_mapping
= {
135 "kafka_exporter_dashboard.json": "templates/kafka_exporter_dashboard.json",
136 "mongodb_exporter_dashboard.json": "templates/mongodb_exporter_dashboard.json",
137 "mysql_exporter_dashboard.json": "templates/mysql_exporter_dashboard.json",
138 "nodes_exporter_dashboard.json": "templates/nodes_exporter_dashboard.json",
139 "summary_dashboard.json": "templates/summary_dashboard.json",
141 for file_name
, path
in osm_dashboards_mapping
.items():
142 files_builder
.add_file(file_name
, Path(path
).read_text())
143 return files_builder
.build()
145 def _build_datasources_files(self
):
146 files_builder
= FilesV3Builder()
147 files_builder
.add_file(
148 "datasource_prometheus.yaml",
149 Template(Path("templates/default_datasources.yaml").read_text()).substitute(
150 prometheus_host
=self
.prometheus_client
.hostname
,
151 prometheus_port
=self
.prometheus_client
.port
,
154 return files_builder
.build()
156 def _check_missing_dependencies(self
, config
: ConfigModel
, external_db
: bool):
157 missing_relations
= []
159 if self
.prometheus_client
.is_missing_data_in_app():
160 missing_relations
.append("prometheus")
162 if not external_db
and self
.mysql_client
.is_missing_data_in_unit():
163 missing_relations
.append("db")
165 if missing_relations
:
166 raise RelationsMissing(missing_relations
)
168 def build_pod_spec(self
, image_info
, **kwargs
):
170 config
= ConfigModel(**dict(self
.config
))
171 mysql_config
= kwargs
["mysql_config"]
172 if mysql_config
.mysql_uri
and not self
.mysql_client
.is_missing_data_in_unit():
173 raise Exception("Mysql data cannot be provided via config and relation")
176 external_db
= True if mysql_config
.mysql_uri
else False
177 self
._check
_missing
_dependencies
(config
, external_db
)
179 # Get initial password
180 admin_initial_password
= self
.grafana_cluster
.admin_initial_password
181 if not admin_initial_password
:
182 admin_initial_password
= _generate_random_password()
183 self
.grafana_cluster
.set_initial_password(admin_initial_password
)
185 # Create Builder for the PodSpec
186 pod_spec_builder
= PodSpecV3Builder()
188 # Add secrets to the pod
189 grafana_secret_name
= f
"{self.app.name}-admin-secret"
190 pod_spec_builder
.add_secret(
193 "admin-password": admin_initial_password
,
194 "mysql-url": mysql_config
.mysql_uri
or self
.mysql_client
.get_uri(),
199 container_builder
= ContainerV3Builder(
200 self
.app
.name
, image_info
, config
.image_pull_policy
202 container_builder
.add_port(name
=self
.app
.name
, port
=config
.port
)
203 container_builder
.add_http_readiness_probe(
206 initial_delay_seconds
=10,
211 container_builder
.add_http_liveness_probe(
214 initial_delay_seconds
=60,
216 failure_threshold
=10,
218 container_builder
.add_volume_config(
220 "/etc/grafana/provisioning/dashboards/",
221 self
._build
_dashboard
_files
(config
),
223 container_builder
.add_volume_config(
225 "/etc/grafana/provisioning/datasources/",
226 self
._build
_datasources
_files
(),
229 container_builder
.add_envs(
231 "GF_SERVER_HTTP_PORT": config
.port
,
232 "GF_LOG_LEVEL": config
.log_level
,
233 "GF_SECURITY_ADMIN_USER": config
.admin_user
,
236 container_builder
.add_secret_envs(
237 secret_name
=grafana_secret_name
,
239 "GF_SECURITY_ADMIN_PASSWORD": "admin-password",
240 "GF_DATABASE_URL": "mysql-url",
243 container
= container_builder
.build()
244 pod_spec_builder
.add_container(container
)
246 # Add Pod restart policy
247 restart_policy
= PodRestartPolicy()
248 restart_policy
.add_secrets(secret_names
=(grafana_secret_name
,))
249 pod_spec_builder
.set_restart_policy(restart_policy
)
251 # Add ingress resources to pod spec if site url exists
253 parsed
= urlparse(config
.site_url
)
255 "nginx.ingress.kubernetes.io/proxy-body-size": "{}".format(
256 str(config
.max_file_size
) + "m"
257 if config
.max_file_size
> 0
258 else config
.max_file_size
261 if config
.ingress_class
:
262 annotations
["kubernetes.io/ingress.class"] = config
.ingress_class
263 ingress_resource_builder
= IngressResourceV3Builder(
264 f
"{self.app.name}-ingress", annotations
267 if config
.ingress_whitelist_source_range
:
269 "nginx.ingress.kubernetes.io/whitelist-source-range"
270 ] = config
.ingress_whitelist_source_range
272 if config
.cluster_issuer
:
273 annotations
["cert-manager.io/cluster-issuer"] = config
.cluster_issuer
275 if parsed
.scheme
== "https":
276 ingress_resource_builder
.add_tls(
277 [parsed
.hostname
], config
.tls_secret_name
280 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
282 ingress_resource_builder
.add_rule(
283 parsed
.hostname
, self
.app
.name
, config
.port
285 ingress_resource
= ingress_resource_builder
.build()
286 pod_spec_builder
.add_ingress_resource(ingress_resource
)
287 return pod_spec_builder
.build()
290 def _generate_random_password():
291 return secrets
.token_hex(16)
294 if __name__
== "__main__":