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 string
import Template
29 from typing
import NoReturn
, Optional
30 from urllib
.parse
import urlparse
32 from ops
.main
import main
33 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
34 from opslib
.osm
.interfaces
.prometheus
import PrometheusClient
35 from opslib
.osm
.pod
import (
38 IngressResourceV3Builder
,
41 from opslib
.osm
.validator
import ModelValidator
, validator
44 logger
= logging
.getLogger(__name__
)
49 class ConfigModel(ModelValidator
):
52 site_url
: Optional
[str]
53 ingress_whitelist_source_range
: Optional
[str]
54 tls_secret_name
: Optional
[str]
56 @validator("max_file_size")
57 def validate_max_file_size(cls
, v
):
59 raise ValueError("value must be equal or greater than 0")
62 @validator("site_url")
63 def validate_site_url(cls
, v
):
66 if not parsed
.scheme
.startswith("http"):
67 raise ValueError("value must start with http")
70 @validator("ingress_whitelist_source_range")
71 def validate_ingress_whitelist_source_range(cls
, v
):
77 class GrafanaCharm(CharmedOsmBase
):
78 """GrafanaCharm Charm."""
80 def __init__(self
, *args
) -> NoReturn
:
81 """Prometheus Charm constructor."""
82 super().__init
__(*args
, oci_image
="image")
84 self
.prometheus_client
= PrometheusClient(self
, "prometheus")
85 self
.framework
.observe(
86 self
.on
["prometheus"].relation_changed
, self
.configure_pod
88 self
.framework
.observe(
89 self
.on
["prometheus"].relation_broken
, self
.configure_pod
92 def _build_dashboard_files(self
, config
: ConfigModel
):
93 files_builder
= FilesV3Builder()
94 files_builder
.add_file(
96 Path("files/default_dashboards.yaml").read_text(),
98 if config
.osm_dashboards
:
99 osm_dashboards_mapping
= {
100 "kafka_exporter_dashboard.json": "files/kafka_exporter_dashboard.json",
101 "mongodb_exporter_dashboard.json": "files/mongodb_exporter_dashboard.json",
102 "mysql_exporter_dashboard.json": "files/mysql_exporter_dashboard.json",
103 "nodes_exporter_dashboard.json": "files/nodes_exporter_dashboard.json",
104 "summary_dashboard.json": "files/summary_dashboard.json",
106 for file_name
, path
in osm_dashboards_mapping
.items():
107 files_builder
.add_file(file_name
, Path(path
).read_text())
108 return files_builder
.build()
110 def _build_datasources_files(self
):
111 files_builder
= FilesV3Builder()
112 files_builder
.add_file(
113 "datasource_prometheus.yaml",
114 Template(Path("files/default_datasources.yaml").read_text()).substitute(
115 prometheus_host
=self
.prometheus_client
.hostname
,
116 prometheus_port
=self
.prometheus_client
.port
,
119 return files_builder
.build()
121 def _check_missing_dependencies(self
):
122 missing_relations
= []
124 if self
.prometheus_client
.is_missing_data_in_app():
125 missing_relations
.append("prometheus")
127 if missing_relations
:
128 raise RelationsMissing(missing_relations
)
130 def build_pod_spec(self
, image_info
):
132 config
= ConfigModel(**dict(self
.config
))
134 self
._check
_missing
_dependencies
()
135 # Create Builder for the PodSpec
136 pod_spec_builder
= PodSpecV3Builder()
138 container_builder
= ContainerV3Builder(self
.app
.name
, image_info
)
139 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
140 container_builder
.add_http_readiness_probe(
143 initial_delay_seconds
=10,
148 container_builder
.add_http_liveness_probe(
151 initial_delay_seconds
=60,
153 failure_threshold
=10,
155 container_builder
.add_volume_config(
157 "/etc/grafana/provisioning/dashboards/",
158 self
._build
_dashboard
_files
(config
),
160 container_builder
.add_volume_config(
162 "/etc/grafana/provisioning/datasources/",
163 self
._build
_datasources
_files
(),
165 container
= container_builder
.build()
166 # Add container to pod spec
167 pod_spec_builder
.add_container(container
)
168 # Add ingress resources to pod spec if site url exists
170 parsed
= urlparse(config
.site_url
)
172 "nginx.ingress.kubernetes.io/proxy-body-size": "{}".format(
173 str(config
.max_file_size
) + "m"
174 if config
.max_file_size
> 0
175 else config
.max_file_size
178 ingress_resource_builder
= IngressResourceV3Builder(
179 f
"{self.app.name}-ingress", annotations
182 if config
.ingress_whitelist_source_range
:
184 "nginx.ingress.kubernetes.io/whitelist-source-range"
185 ] = config
.ingress_whitelist_source_range
187 if parsed
.scheme
== "https":
188 ingress_resource_builder
.add_tls(
189 [parsed
.hostname
], config
.tls_secret_name
192 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
194 ingress_resource_builder
.add_rule(parsed
.hostname
, self
.app
.name
, PORT
)
195 ingress_resource
= ingress_resource_builder
.build()
196 pod_spec_builder
.add_ingress_resource(ingress_resource
)
197 return pod_spec_builder
.build()
200 if __name__
== "__main__":