# pylint: disable=E0213
+import base64
from ipaddress import ip_network
import logging
from typing import NoReturn, Optional
from urllib.parse import urlparse
+import bcrypt
+from oci_image import OCIImageResource
from ops.framework import EventBase
from ops.main import main
from opslib.osm.charm import CharmedOsmBase
ModelValidator,
validator,
)
+import requests
logger = logging.getLogger(__name__)
default_target: str
max_file_size: int
site_url: Optional[str]
+ cluster_issuer: Optional[str]
+ ingress_class: Optional[str]
ingress_whitelist_source_range: Optional[str]
tls_secret_name: Optional[str]
enable_web_admin_api: bool
+ image_pull_policy: str
+ security_context: bool
+ web_config_username: str
+ web_config_password: str
@validator("web_subpath")
def validate_web_subpath(cls, v):
ip_network(v)
return v
+ @validator("image_pull_policy")
+ def validate_image_pull_policy(cls, v):
+ values = {
+ "always": "Always",
+ "ifnotpresent": "IfNotPresent",
+ "never": "Never",
+ }
+ v = v.lower()
+ if v not in values.keys():
+ raise ValueError("value must be always, ifnotpresent or never")
+ return values[v]
+
class PrometheusCharm(CharmedOsmBase):
self._publish_prometheus_info,
)
+ # Registering actions
+ self.framework.observe(
+ self.on.backup_action, # pylint: disable=E1101
+ self._on_backup_action,
+ )
+
def _publish_prometheus_info(self, event: EventBase) -> NoReturn:
- self.prometheus.publish_info(self.app.name, PORT)
+ config = ConfigModel(**dict(self.config))
+ self.prometheus.publish_info(
+ self.app.name,
+ PORT,
+ user=config.web_config_username,
+ password=config.web_config_password,
+ )
- def _build_files(self, config: ConfigModel):
+ def _on_backup_action(self, event: EventBase) -> NoReturn:
+ url = f"http://{self.model.app.name}:{PORT}/api/v1/admin/tsdb/snapshot"
+ result = requests.post(url)
+
+ if result.status_code == 200:
+ event.set_results({"backup-name": result.json()["name"]})
+ else:
+ event.fail(f"status-code: {result.status_code}")
+
+ def _build_config_file(self, config: ConfigModel):
files_builder = FilesV3Builder()
files_builder.add_file(
"prometheus.yml",
)
return files_builder.build()
+ def _build_webconfig_file(self):
+ files_builder = FilesV3Builder()
+ files_builder.add_file("web.yml", "web-config-file", secret=True)
+ return files_builder.build()
+
def build_pod_spec(self, image_info):
# Validate config
config = ConfigModel(**dict(self.config))
# Create Builder for the PodSpec
- pod_spec_builder = PodSpecV3Builder()
+ pod_spec_builder = PodSpecV3Builder(
+ enable_security_context=config.security_context
+ )
+
+ # Build Backup Container
+ backup_image = OCIImageResource(self, "backup-image")
+ backup_image_info = backup_image.fetch()
+ backup_container_builder = ContainerV3Builder("prom-backup", backup_image_info)
+ backup_container = backup_container_builder.build()
+
+ # Add backup container to pod spec
+ pod_spec_builder.add_container(backup_container)
+
+ # Add pod secrets
+ prometheus_secret_name = f"{self.app.name}-secret"
+ pod_spec_builder.add_secret(
+ prometheus_secret_name,
+ {
+ "web-config-file": (
+ "basic_auth_users:\n"
+ f" {config.web_config_username}: {self._hash_password(config.web_config_password)}\n"
+ )
+ },
+ )
+
# Build Container
- container_builder = ContainerV3Builder(self.app.name, image_info)
+ container_builder = ContainerV3Builder(
+ self.app.name,
+ image_info,
+ config.image_pull_policy,
+ run_as_non_root=config.security_context,
+ )
container_builder.add_port(name=self.app.name, port=PORT)
+ token = self._base64_encode(
+ f"{config.web_config_username}:{config.web_config_password}"
+ )
container_builder.add_http_readiness_probe(
"/-/ready",
PORT,
initial_delay_seconds=10,
timeout_seconds=30,
+ http_headers=[("Authorization", f"Basic {token}")],
)
container_builder.add_http_liveness_probe(
"/-/healthy",
PORT,
initial_delay_seconds=30,
period_seconds=30,
+ http_headers=[("Authorization", f"Basic {token}")],
)
command = [
"/bin/prometheus",
"--config.file=/etc/prometheus/prometheus.yml",
+ "--web.config.file=/etc/prometheus/web-config/web.yml",
"--storage.tsdb.path=/prometheus",
"--web.console.libraries=/usr/share/prometheus/console_libraries",
"--web.console.templates=/usr/share/prometheus/consoles",
command.append("--web.enable-admin-api")
container_builder.add_command(command)
container_builder.add_volume_config(
- "config", "/etc/prometheus", self._build_files(config)
+ "config", "/etc/prometheus", self._build_config_file(config)
+ )
+ container_builder.add_volume_config(
+ "web-config",
+ "/etc/prometheus/web-config",
+ self._build_webconfig_file(),
+ secret_name=prometheus_secret_name,
)
container = container_builder.build()
# Add container to pod spec
str(config.max_file_size) + "m"
if config.max_file_size > 0
else config.max_file_size
- ),
+ )
}
+ if config.ingress_class:
+ annotations["kubernetes.io/ingress.class"] = config.ingress_class
ingress_resource_builder = IngressResourceV3Builder(
f"{self.app.name}-ingress", annotations
)
"nginx.ingress.kubernetes.io/whitelist-source-range"
] = config.ingress_whitelist_source_range
+ if config.cluster_issuer:
+ annotations["cert-manager.io/cluster-issuer"] = config.cluster_issuer
+
if parsed.scheme == "https":
ingress_resource_builder.add_tls(
[parsed.hostname], config.tls_secret_name
pod_spec_builder.add_ingress_resource(ingress_resource)
return pod_spec_builder.build()
+ def _hash_password(self, password):
+ hashed_password = bcrypt.hashpw(password.encode("utf-8"), bcrypt.gensalt())
+ return hashed_password.decode()
+
+ def _base64_encode(self, phrase: str) -> str:
+ return base64.b64encode(phrase.encode("utf-8")).decode("utf-8")
+
if __name__ == "__main__":
main(PrometheusCharm)