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 cluster_issuer
: Optional
[str]
54 ingress_class
: Optional
[str]
55 ingress_whitelist_source_range
: Optional
[str]
56 tls_secret_name
: Optional
[str]
57 image_pull_policy
: Optional
[str]
59 @validator("max_file_size")
60 def validate_max_file_size(cls
, v
):
62 raise ValueError("value must be equal or greater than 0")
65 @validator("site_url")
66 def validate_site_url(cls
, v
):
69 if not parsed
.scheme
.startswith("http"):
70 raise ValueError("value must start with http")
73 @validator("ingress_whitelist_source_range")
74 def validate_ingress_whitelist_source_range(cls
, v
):
79 @validator("image_pull_policy")
80 def validate_image_pull_policy(cls
, v
):
83 "ifnotpresent": "IfNotPresent",
87 if v
not in values
.keys():
88 raise ValueError("value must be always, ifnotpresent or never")
92 class GrafanaCharm(CharmedOsmBase
):
93 """GrafanaCharm Charm."""
95 def __init__(self
, *args
) -> NoReturn
:
96 """Prometheus Charm constructor."""
97 super().__init
__(*args
, oci_image
="image")
99 self
.prometheus_client
= PrometheusClient(self
, "prometheus")
100 self
.framework
.observe(
101 self
.on
["prometheus"].relation_changed
, self
.configure_pod
103 self
.framework
.observe(
104 self
.on
["prometheus"].relation_broken
, self
.configure_pod
107 def _build_dashboard_files(self
, config
: ConfigModel
):
108 files_builder
= FilesV3Builder()
109 files_builder
.add_file(
110 "dashboard_osm.yaml",
111 Path("templates/default_dashboards.yaml").read_text(),
113 if config
.osm_dashboards
:
114 osm_dashboards_mapping
= {
115 "kafka_exporter_dashboard.json": "templates/kafka_exporter_dashboard.json",
116 "mongodb_exporter_dashboard.json": "templates/mongodb_exporter_dashboard.json",
117 "mysql_exporter_dashboard.json": "templates/mysql_exporter_dashboard.json",
118 "nodes_exporter_dashboard.json": "templates/nodes_exporter_dashboard.json",
119 "summary_dashboard.json": "templates/summary_dashboard.json",
121 for file_name
, path
in osm_dashboards_mapping
.items():
122 files_builder
.add_file(file_name
, Path(path
).read_text())
123 return files_builder
.build()
125 def _build_datasources_files(self
):
126 files_builder
= FilesV3Builder()
127 files_builder
.add_file(
128 "datasource_prometheus.yaml",
129 Template(Path("templates/default_datasources.yaml").read_text()).substitute(
130 prometheus_host
=self
.prometheus_client
.hostname
,
131 prometheus_port
=self
.prometheus_client
.port
,
134 return files_builder
.build()
136 def _check_missing_dependencies(self
):
137 missing_relations
= []
139 if self
.prometheus_client
.is_missing_data_in_app():
140 missing_relations
.append("prometheus")
142 if missing_relations
:
143 raise RelationsMissing(missing_relations
)
145 def build_pod_spec(self
, image_info
):
147 config
= ConfigModel(**dict(self
.config
))
149 self
._check
_missing
_dependencies
()
150 # Create Builder for the PodSpec
151 pod_spec_builder
= PodSpecV3Builder()
153 container_builder
= ContainerV3Builder(
154 self
.app
.name
, image_info
, config
.image_pull_policy
156 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
157 container_builder
.add_http_readiness_probe(
160 initial_delay_seconds
=10,
165 container_builder
.add_http_liveness_probe(
168 initial_delay_seconds
=60,
170 failure_threshold
=10,
172 container_builder
.add_volume_config(
174 "/etc/grafana/provisioning/dashboards/",
175 self
._build
_dashboard
_files
(config
),
177 container_builder
.add_volume_config(
179 "/etc/grafana/provisioning/datasources/",
180 self
._build
_datasources
_files
(),
182 container
= container_builder
.build()
183 # Add container to pod spec
184 pod_spec_builder
.add_container(container
)
185 # Add ingress resources to pod spec if site url exists
187 parsed
= urlparse(config
.site_url
)
189 "nginx.ingress.kubernetes.io/proxy-body-size": "{}".format(
190 str(config
.max_file_size
) + "m"
191 if config
.max_file_size
> 0
192 else config
.max_file_size
195 if config
.ingress_class
:
196 annotations
["kubernetes.io/ingress.class"] = config
.ingress_class
197 ingress_resource_builder
= IngressResourceV3Builder(
198 f
"{self.app.name}-ingress", annotations
201 if config
.ingress_whitelist_source_range
:
203 "nginx.ingress.kubernetes.io/whitelist-source-range"
204 ] = config
.ingress_whitelist_source_range
206 if config
.cluster_issuer
:
207 annotations
["cert-manager.io/cluster-issuer"] = config
.cluster_issuer
209 if parsed
.scheme
== "https":
210 ingress_resource_builder
.add_tls(
211 [parsed
.hostname
], config
.tls_secret_name
214 annotations
["nginx.ingress.kubernetes.io/ssl-redirect"] = "false"
216 ingress_resource_builder
.add_rule(parsed
.hostname
, self
.app
.name
, PORT
)
217 ingress_resource
= ingress_resource_builder
.build()
218 pod_spec_builder
.add_ingress_resource(ingress_resource
)
219 return pod_spec_builder
.build()
222 if __name__
== "__main__":