Refactors integrations

modules/sdcore-control-plane-k8s/outputs.tf

@@ -1,39 +1,24 @@
 # Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-# Cross-model integrations
+# Integration offers for external systems
 
 output "amf_fiveg_n2_offer_url" {
   description = ""
   value       = juju_offer.amf-fiveg-n2.url
 }
 
+# Outputs required to consume external offers
+
 output "nms_app_name" {
   description = "Name of the deployed NMS application."
   value       = module.nms.app_name
 }
-
 output "fiveg_n4_endpoint" {
   description = "Name of the endpoint to integrate with fiveg_n4 interface."
   value       = module.nms.fiveg_n4_endpoint
 }
-
 output "fiveg_gnb_identity_endpoint" {
   description = "Name of the endpoint to integrate with fiveg_gnb_identity interface."
   value       = module.nms.fiveg_gnb_identity_endpoint
 }
-
-output "grafana_agent_app_name" {
-  description = "Name of the deployed Grafana-agent application."
-  value       = module.grafana-agent.app_name
-}
-
-output "send_remote_write_endpoint" {
-  description = "Name of the endpoint to forward client charms metrics and associated alert rules to Prometheus using prometheus_remote_write interface."
-  value       = module.grafana-agent.send_remote_write_endpoint
-}
-
-output "logging_consumer_endpoint" {
-  description = "Name of the endpoint to send the logs to Loki using loki_push_api interface."
-  value       = module.grafana-agent.logging_consumer_endpoint
-}

modules/sdcore-control-plane-k8s/variables.tf

@@ -89,7 +89,7 @@ variable "deploy_cos" {
   default     = false
 }
 variable "use_existing_cos" {
-  description = ""
+  description = "Allows integrating with an existing COS deployment. When set to `true`, `cos_model_name`, `prometheus_remote_write_offer_url` and `loki_logging_offer_url` are required."
   type        = bool
   default     = false
 }
@@ -106,7 +106,7 @@ variable "prometheus_remote_write_offer_url" {
   default     = ""
 
   validation {
-    condition     = var.use_existing_cos && length(var.prometheus_remote_write_offer_url) != 0
+    condition     = ! var.use_existing_cos || (var.use_existing_cos && length(var.prometheus_remote_write_offer_url) != 0)
     error_message = "Variable `prometheus_remote_write_offer_url` is required."
   }
 }
@@ -116,7 +116,7 @@ variable "loki_logging_offer_url" {
   default     = ""
 
   validation {
-    condition     = var.use_existing_cos && length(var.loki_logging_offer_url) != 0
+    condition     = ! var.use_existing_cos || (var.use_existing_cos && length(var.loki_logging_offer_url) != 0)
     error_message = "Variable `loki_logging_offer_url` is required."
   }
 }

modules/sdcore-k8s/main.tf

@@ -843,6 +843,12 @@ resource "juju_offer" "amf-fiveg-n2" {
   endpoint         = module.amf.fiveg_n2_endpoint
 }
 
+resource "juju_offer" "upf-fiveg-n3" {
+  model            = var.model_name
+  application_name = module.amf.app_name
+  endpoint         = module.amf.fiveg_n3_endpoint
+}
+
 resource "juju_integration" "prometheus" {
   count = var.deploy_cos || var.use_existing_cos ? 1 : 0
   model = var.model_name

modules/sdcore-k8s/outputs.tf

@@ -1,27 +1,25 @@
 # Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
+# Integration offers for external systems
+
 output "amf_fiveg_n2_offer_url" {
-  description = ""
+  description = "AMF `fiveg_n2` offer."
   value       = juju_offer.amf-fiveg-n2.url
 }
 
+output "upf_fiveg_n3_offer_url" {
+  description = "UPF `fiveg_n3` offer."
+  value       = juju_offer.upf-fiveg-n3.url
+}
+
+# Outputs required to consume external offers
+
 output "nms_app_name" {
   description = "Name of the deployed NMS application."
   value       = module.nms.app_name
 }
-
 output "fiveg_gnb_identity_endpoint" {
   description = "Name of the endpoint to integrate with fiveg_gnb_identity interface."
   value       = module.nms.fiveg_gnb_identity_endpoint
 }
-
-output "upf_app_name" {
-  description = "Name of the deployed UPF application."
-  value       = module.upf.app_name
-}
-
-output "fiveg_n3_endpoint" {
-  description = "Name of the endpoint used to provide information on connectivity to the N3 plane."
-  value       = module.upf.fiveg_n3_endpoint
-}

modules/sdcore-user-plane-k8s/main.tf

@@ -62,8 +62,20 @@ resource "juju_integration" "upf-logging" {
 
 # Cross-model integrations
 
+resource "juju_offer" "upf-fiveg-n3" {
+  model            = var.model_name
+  application_name = module.upf.app_name
+  endpoint         = module.upf.fiveg_n3_endpoint
+}
+
+resource "juju_offer" "upf-fiveg-n4" {
+  model            = var.model_name
+  application_name = module.upf.app_name
+  endpoint         = module.upf.fiveg_n4_endpoint
+}
+
 resource "juju_integration" "prometheus" {
-  count = var.deploy_cos ? 1 : 0
+  count = var.deploy_cos || var.use_existing_cos ? 1 : 0
   model = var.model_name
 
   application {
@@ -72,12 +84,12 @@ resource "juju_integration" "prometheus" {
   }
 
   application {
-    offer_url = module.cos-lite[0].prometheus_remote_write_offer_url
+    offer_url = length(module.cos-lite) != 0 ? module.cos-lite[0].prometheus_remote_write_offer_url : var.prometheus_remote_write_offer_url
   }
 }
 
 resource "juju_integration" "loki" {
-  count = var.deploy_cos ? 1 : 0
+  count = var.deploy_cos || var.use_existing_cos ? 1 : 0
   model = var.model_name
 
   application {
@@ -86,6 +98,6 @@ resource "juju_integration" "loki" {
   }
 
   application {
-    offer_url = module.cos-lite[0].loki_logging_offer_url
+    offer_url = length(module.cos-lite) != 0 ? module.cos-lite[0].loki_logging_offer_url : var.loki_logging_offer_url
   }
 }

modules/sdcore-user-plane-k8s/outputs.tf

@@ -1,32 +1,14 @@
 # Copyright 2024 Canonical Ltd.
 # See LICENSE file for licensing details.
 
-output "upf_app_name" {
-  description = "Name of the deployed UPF application."
-  value       = module.upf.app_name
-}
-
-output "fiveg_n3_endpoint" {
-  description = "Name of the endpoint used to provide information on connectivity to the N3 plane."
-  value       = module.upf.fiveg_n3_endpoint
-}
+# Integration offers for external systems
 
-output "fiveg_n4_endpoint" {
-  description = "Name of the endpoint used to provide information on connectivity to the N4 plane."
-  value       = module.upf.fiveg_n4_endpoint
+output "upf_fiveg_n3_offer_url" {
+  description = "UPF `fiveg_n3` offer."
+  value       = juju_offer.upf-fiveg-n3.url
 }
 
-output "grafana_agent_app_name" {
-  description = "Name of the deployed Grafana-agent application."
-  value       = module.grafana-agent.app_name
+output "upf_fiveg_n4_offer_url" {
+  description = "UPF `fiveg_n4` offer."
+  value       = juju_offer.upf-fiveg-n4.url
 }
-
-output "send_remote_write_endpoint" {
-  description = "Name of the endpoint to forward client charms metrics and associated alert rules to Prometheus using prometheus_remote_write interface."
-  value       = module.grafana-agent.send_remote_write_endpoint
-}
-
-output "logging_consumer_endpoint" {
-  description = "Name of the endpoint to send the logs to Loki using loki_push_api interface."
-  value       = module.grafana-agent.logging_consumer_endpoint
-}

modules/sdcore-user-plane-k8s/terraform.tf

@@ -5,7 +5,7 @@ terraform {
   required_providers {
     juju = {
       source  = "juju/juju"
-      version = ">= 0.11.0"
+      version = ">= 0.12.0"
     }
   }
 }

modules/sdcore-user-plane-k8s/variables.tf

@@ -44,11 +44,39 @@ variable "deploy_cos" {
   type        = bool
   default     = false
 }
+variable "use_existing_cos" {
+  description = "Allows integrating with an existing COS deployment. When set to `true`, `cos_model_name`, `prometheus_remote_write_offer_url` and `loki_logging_offer_url` are required."
+  type        = bool
+  default     = false
+}
+
 variable "cos_model_name" {
-  description = "Name of Juju model to deploy COS to."
+  description = "Name of COS Juju model. This model will be created if `deploy_cos` is set to true or used as a source when integrating with existing COS deployment."
   type        = string
   default     = "cos-lite"
 }
+
+variable "prometheus_remote_write_offer_url" {
+  description = "URL of Prometheus's `remote_write` offer. This variable is used to integrate with an existing COS deployment."
+  type        = string
+  default     = ""
+
+  validation {
+    condition     = ! var.use_existing_cos || (var.use_existing_cos && length(var.prometheus_remote_write_offer_url) != 0)
+    error_message = "Variable `prometheus_remote_write_offer_url` is required."
+  }
+}
+variable "loki_logging_offer_url" {
+  description = "URL of Loki's `logging` offer. This variable is used to integrate with an existing COS deployment."
+  type        = string
+  default     = ""
+
+  validation {
+    condition     = ! var.use_existing_cos || (var.use_existing_cos && length(var.loki_logging_offer_url) != 0)
+    error_message = "Variable `loki_logging_offer_url` is required."
+  }
+}
+
 variable "cos_configuration_config" {
   description = "COS Configuration application config. Details about available options can be found at https://charmhub.io/cos-configuration-k8s/configure."
   type        = map(string)