from ipaddress import ip_network
+import json
import logging
from typing import NoReturn, Optional
from urllib.parse import urlparse
+from charms.kafka_k8s.v0.kafka import KafkaEvents, KafkaRequires
from ops.main import main
from opslib.osm.charm import CharmedOsmBase, RelationsMissing
from opslib.osm.interfaces.http import HttpServer
-from opslib.osm.interfaces.kafka import KafkaClient
from opslib.osm.interfaces.keystone import KeystoneClient
from opslib.osm.interfaces.mongo import MongoClient
from opslib.osm.interfaces.prometheus import PrometheusClient
from opslib.osm.pod import (
ContainerV3Builder,
IngressResourceV3Builder,
+ PodRestartPolicy,
PodSpecV3Builder,
)
from opslib.osm.validator import ModelValidator, validator
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]
mongodb_uri: Optional[str]
+ image_pull_policy: str
+ debug_mode: bool
+ security_context: bool
+ tcpsocket_liveness_probe: Optional[str]
+ tcpsocket_readiness_probe: Optional[str]
@validator("auth_backend")
def validate_auth_backend(cls, v):
raise ValueError("mongodb_uri is not properly formed")
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]
+
+ @staticmethod
+ def _validate_tcpsocket_probe(probe_str) -> dict:
+ valid_attributes = (
+ "initial_delay_seconds",
+ "timeout_seconds",
+ "period_seconds",
+ "success_threshold",
+ "failure_threshold",
+ )
+ if probe_str:
+ probe_dict = json.loads(probe_str)
+ if all(attribute in valid_attributes for attribute in probe_dict):
+ return probe_dict
+ raise ValueError(
+ "One or more attributes are not accepted by the tcpsocket probe configuration"
+ )
+ return {}
+
+ @validator("tcpsocket_readiness_probe")
+ def validate_tcpsocket_readiness_probe(cls, v):
+ try:
+ return ConfigModel._validate_tcpsocket_probe(v)
+ except Exception as e:
+ raise ValueError(f"tcpsocket_readiness_probe configuration error: {e}")
+
+ @validator("tcpsocket_liveness_probe")
+ def validate_tcpsocket_liveness_probe(cls, v):
+ try:
+ return ConfigModel._validate_tcpsocket_probe(v)
+ except Exception as e:
+ raise ValueError(f"tcpsocket_liveness_probe configuration error: {e}")
+
class NbiCharm(CharmedOsmBase):
+ on = KafkaEvents()
+
def __init__(self, *args) -> NoReturn:
- super().__init__(*args, oci_image="image")
+ super().__init__(
+ *args,
+ oci_image="image",
+ vscode_workspace=VSCODE_WORKSPACE,
+ )
+ if self.config.get("debug_mode"):
+ self.enable_debug_mode(
+ pubkey=self.config.get("debug_pubkey"),
+ hostpaths={
+ "NBI": {
+ "hostpath": self.config.get("debug_nbi_local_path"),
+ "container-path": "/usr/lib/python3/dist-packages/osm_nbi",
+ },
+ "osm_common": {
+ "hostpath": self.config.get("debug_common_local_path"),
+ "container-path": "/usr/lib/python3/dist-packages/osm_common",
+ },
+ },
+ )
- self.kafka_client = KafkaClient(self, "kafka")
- self.framework.observe(self.on["kafka"].relation_changed, self.configure_pod)
- self.framework.observe(self.on["kafka"].relation_broken, self.configure_pod)
+ self.kafka = KafkaRequires(self)
+ self.framework.observe(self.on.kafka_available, self.configure_pod)
+ self.framework.observe(self.on.kafka_broken, self.configure_pod)
self.mongodb_client = MongoClient(self, "mongodb")
self.framework.observe(self.on["mongodb"].relation_changed, self.configure_pod)
def _check_missing_dependencies(self, config: ConfigModel):
missing_relations = []
- if self.kafka_client.is_missing_data_in_unit():
+ if not self.kafka.host or not self.kafka.port:
missing_relations.append("kafka")
if not config.mongodb_uri and self.mongodb_client.is_missing_data_in_unit():
missing_relations.append("mongodb")
def build_pod_spec(self, image_info):
# Validate config
config = ConfigModel(**dict(self.config))
-
if config.mongodb_uri and not self.mongodb_client.is_missing_data_in_unit():
raise Exception("Mongodb data cannot be provided via config and relation")
# Check relations
self._check_missing_dependencies(config)
+ security_context_enabled = (
+ config.security_context if not config.debug_mode else False
+ )
+
# Create Builder for the PodSpec
- pod_spec_builder = PodSpecV3Builder()
+ pod_spec_builder = PodSpecV3Builder(
+ enable_security_context=security_context_enabled
+ )
+
+ # Add secrets to the pod
+ mongodb_secret_name = f"{self.app.name}-mongodb-secret"
+ pod_spec_builder.add_secret(
+ mongodb_secret_name,
+ {
+ "uri": config.mongodb_uri or self.mongodb_client.connection_string,
+ "commonkey": config.database_commonkey,
+ },
+ )
# Build Init Container
pod_spec_builder.add_init_container(
"command": [
"sh",
"-c",
- f"until (nc -zvw1 {self.kafka_client.host} {self.kafka_client.port} ); do sleep 3; done; exit 0",
+ f"until (nc -zvw1 {self.kafka.host} {self.kafka.port} ); do sleep 3; done; exit 0",
],
}
)
# 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=security_context_enabled,
+ )
container_builder.add_port(name=self.app.name, port=PORT)
container_builder.add_tcpsocket_readiness_probe(
PORT,
- initial_delay_seconds=5,
- timeout_seconds=5,
+ initial_delay_seconds=config.tcpsocket_readiness_probe.get(
+ "initial_delay_seconds", 5
+ ),
+ timeout_seconds=config.tcpsocket_readiness_probe.get("timeout_seconds", 5),
+ period_seconds=config.tcpsocket_readiness_probe.get("period_seconds", 10),
+ success_threshold=config.tcpsocket_readiness_probe.get(
+ "success_threshold", 1
+ ),
+ failure_threshold=config.tcpsocket_readiness_probe.get(
+ "failure_threshold", 3
+ ),
)
container_builder.add_tcpsocket_liveness_probe(
PORT,
- initial_delay_seconds=45,
- timeout_seconds=10,
+ initial_delay_seconds=config.tcpsocket_liveness_probe.get(
+ "initial_delay_seconds", 45
+ ),
+ timeout_seconds=config.tcpsocket_liveness_probe.get("timeout_seconds", 10),
+ period_seconds=config.tcpsocket_liveness_probe.get("period_seconds", 10),
+ success_threshold=config.tcpsocket_liveness_probe.get(
+ "success_threshold", 1
+ ),
+ failure_threshold=config.tcpsocket_liveness_probe.get(
+ "failure_threshold", 3
+ ),
)
container_builder.add_envs(
{
"OSMNBI_SERVER_ENABLE_TEST": config.enable_test,
"OSMNBI_STATIC_DIR": "/app/osm_nbi/html_public",
# Kafka configuration
- "OSMNBI_MESSAGE_HOST": self.kafka_client.host,
+ "OSMNBI_MESSAGE_HOST": self.kafka.host,
"OSMNBI_MESSAGE_DRIVER": "kafka",
- "OSMNBI_MESSAGE_PORT": self.kafka_client.port,
+ "OSMNBI_MESSAGE_PORT": self.kafka.port,
# Database configuration
"OSMNBI_DATABASE_DRIVER": "mongo",
- "OSMNBI_DATABASE_URI": config.mongodb_uri
- or self.mongodb_client.connection_string,
- "OSMNBI_DATABASE_COMMONKEY": config.database_commonkey,
# Storage configuration
"OSMNBI_STORAGE_DRIVER": "mongo",
"OSMNBI_STORAGE_PATH": "/app/storage",
"OSMNBI_STORAGE_COLLECTION": "files",
- "OSMNBI_STORAGE_URI": config.mongodb_uri
- or self.mongodb_client.connection_string,
# Prometheus configuration
"OSMNBI_PROMETHEUS_HOST": self.prometheus_client.hostname,
"OSMNBI_PROMETHEUS_PORT": self.prometheus_client.port,
"OSMNBI_LOG_LEVEL": config.log_level,
}
)
+ container_builder.add_secret_envs(
+ secret_name=mongodb_secret_name,
+ envs={
+ "OSMNBI_DATABASE_URI": "uri",
+ "OSMNBI_DATABASE_COMMONKEY": "commonkey",
+ "OSMNBI_STORAGE_URI": "uri",
+ },
+ )
if config.auth_backend == "internal":
container_builder.add_env("OSMNBI_AUTHENTICATION_BACKEND", "internal")
elif config.auth_backend == "keystone":
- container_builder.add_envs(
+ keystone_secret_name = f"{self.app.name}-keystone-secret"
+ pod_spec_builder.add_secret(
+ keystone_secret_name,
{
- "OSMNBI_AUTHENTICATION_BACKEND": "keystone",
- "OSMNBI_AUTHENTICATION_AUTH_URL": self.keystone_client.host,
- "OSMNBI_AUTHENTICATION_AUTH_PORT": self.keystone_client.port,
- "OSMNBI_AUTHENTICATION_USER_DOMAIN_NAME": self.keystone_client.user_domain_name,
- "OSMNBI_AUTHENTICATION_PROJECT_DOMAIN_NAME": self.keystone_client.project_domain_name,
- "OSMNBI_AUTHENTICATION_SERVICE_USERNAME": self.keystone_client.username,
- "OSMNBI_AUTHENTICATION_SERVICE_PASSWORD": self.keystone_client.password,
- "OSMNBI_AUTHENTICATION_SERVICE_PROJECT": self.keystone_client.service,
- }
+ "url": self.keystone_client.host,
+ "port": self.keystone_client.port,
+ "user_domain": self.keystone_client.user_domain_name,
+ "project_domain": self.keystone_client.project_domain_name,
+ "service_username": self.keystone_client.username,
+ "service_password": self.keystone_client.password,
+ "service_project": self.keystone_client.service,
+ },
+ )
+ container_builder.add_env("OSMNBI_AUTHENTICATION_BACKEND", "keystone")
+ container_builder.add_secret_envs(
+ secret_name=keystone_secret_name,
+ envs={
+ "OSMNBI_AUTHENTICATION_AUTH_URL": "url",
+ "OSMNBI_AUTHENTICATION_AUTH_PORT": "port",
+ "OSMNBI_AUTHENTICATION_USER_DOMAIN_NAME": "user_domain",
+ "OSMNBI_AUTHENTICATION_PROJECT_DOMAIN_NAME": "project_domain",
+ "OSMNBI_AUTHENTICATION_SERVICE_USERNAME": "service_username",
+ "OSMNBI_AUTHENTICATION_SERVICE_PASSWORD": "service_password",
+ "OSMNBI_AUTHENTICATION_SERVICE_PROJECT": "service_project",
+ },
)
container = container_builder.build()
else config.max_file_size
),
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS",
- "kubernetes.io/ingress.class": "public",
}
+ if config.ingress_class:
+ annotations["kubernetes.io/ingress.class"] = config.ingress_class
ingress_resource_builder = IngressResourceV3Builder(
f"{self.app.name}-ingress", annotations
)
ingress_resource = ingress_resource_builder.build()
pod_spec_builder.add_ingress_resource(ingress_resource)
- logger.debug(pod_spec_builder.build())
+ # Add restart policy
+ restart_policy = PodRestartPolicy()
+ restart_policy.add_secrets()
+ pod_spec_builder.set_restart_policy(restart_policy)
return pod_spec_builder.build()
+VSCODE_WORKSPACE = {
+ "folders": [
+ {"path": "/usr/lib/python3/dist-packages/osm_nbi"},
+ {"path": "/usr/lib/python3/dist-packages/osm_common"},
+ {"path": "/usr/lib/python3/dist-packages/osm_im"},
+ ],
+ "settings": {},
+ "launch": {
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "NBI",
+ "type": "python",
+ "request": "launch",
+ "module": "osm_nbi.nbi",
+ "justMyCode": False,
+ }
+ ],
+ },
+}
+
+
if __name__ == "__main__":
main(NbiCharm)
projects / osm / devops.git / blobdiff