chore(docs): Update configuration docs. Add Azure Service Bus internal mq. Remove Clickhouse config.

Author: leggetter

cmd/configdocsgen/main.go

@@ -601,7 +601,11 @@ func generateYAMLPart(builder *strings.Builder, configInfo *ParsedConfig, allCon
 
 		// Required status as a comment
 		if field.Required != "" && field.Required != "N" && field.Required != "false" {
-			builder.WriteString(fmt.Sprintf("%s# Required: %s\n", indent, field.Required))
+			requiredText := field.Required
+			if field.Required == "C" {
+				requiredText = "Conditional"
+			}
+			builder.WriteString(fmt.Sprintf("%s# Required: %s\n", indent, requiredText))
 		}
 
 		// Field line

docs/pages/references/configuration.mdx

@@ -32,6 +32,7 @@ Global configurations are provided through env variables or a YAML file. ConfigM
 | `AWS_SQS_SECRET_ACCESS_KEY` | AWS Secret Access Key for SQS. Required if AWS SQS is the chosen MQ provider. | `nil` | Conditional |
 | `AZURE_SERVICEBUS_CLIENT_ID` | Service principal client ID | `nil` | Yes |
 | `AZURE_SERVICEBUS_CLIENT_SECRET` | Service principal client secret | `nil` | Yes |
+| `AZURE_SERVICEBUS_CONNECTION_STRING` | Azure Service Bus connection string | `nil` | No |
 | `AZURE_SERVICEBUS_DELIVERY_SUBSCRIPTION` | Subscription name for delivery queue | `outpost-delivery-sub` | No |
 | `AZURE_SERVICEBUS_DELIVERY_TOPIC` | Topic name for delivery queue | `outpost-delivery` | No |
 | `AZURE_SERVICEBUS_LOG_SUBSCRIPTION` | Subscription name for log queue | `outpost-log-sub` | No |
@@ -40,10 +41,6 @@ Global configurations are provided through env variables or a YAML file. ConfigM
 | `AZURE_SERVICEBUS_RESOURCE_GROUP` | Azure resource group name | `nil` | Yes |
 | `AZURE_SERVICEBUS_SUBSCRIPTION_ID` | Azure subscription ID | `nil` | Yes |
 | `AZURE_SERVICEBUS_TENANT_ID` | Azure Active Directory tenant ID | `nil` | Yes |
-| `CLICKHOUSE_ADDR` | Address (host:port) of the ClickHouse server. Example: 'localhost:9000'. Required if ClickHouse is used for log storage. | `nil` | Conditional |
-| `CLICKHOUSE_DATABASE` | Database name in ClickHouse to use. | `outpost` | No |
-| `CLICKHOUSE_PASSWORD` | Password for ClickHouse authentication. | `nil` | No |
-| `CLICKHOUSE_USERNAME` | Username for ClickHouse authentication. | `nil` | No |
 | `DELIVERY_MAX_CONCURRENCY` | Maximum number of delivery attempts to process concurrently. | `1` | No |
 | `DELIVERY_TIMEOUT_SECONDS` | Timeout in seconds for HTTP requests made during event delivery to webhook destinations. | `5` | No |
 | `DESTINATIONS_AWS_KINESIS_METADATA_IN_PAYLOAD` | If true, includes Outpost metadata (event ID, topic, etc.) within the Kinesis record payload. | `true` | No |
@@ -92,6 +89,9 @@ Global configurations are provided through env variables or a YAML file. ConfigM
 | `PUBLISH_AWS_SQS_QUEUE` | Name of the SQS queue for publishing events. Required if AWS SQS is the chosen publish MQ provider. | `nil` | Conditional |
 | `PUBLISH_AWS_SQS_REGION` | AWS Region for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider. | `nil` | Conditional |
 | `PUBLISH_AWS_SQS_SECRET_ACCESS_KEY` | AWS Secret Access Key for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider. | `nil` | Conditional |
+| `PUBLISH_AZURE_SERVICEBUS_CONNECTION_STRING` | Azure Service Bus connection string for the publish queue. Required if Azure Service Bus is the chosen publish MQ provider. | `nil` | Conditional |
+| `PUBLISH_AZURE_SERVICEBUS_SUBSCRIPTION` | Name of the Azure Service Bus subscription to read published events from. Required if Azure Service Bus is the chosen publish MQ provider. | `nil` | Conditional |
+| `PUBLISH_AZURE_SERVICEBUS_TOPIC` | Name of the Azure Service Bus topic for publishing events. Required if Azure Service Bus is the chosen publish MQ provider. | `nil` | Conditional |
 | `PUBLISH_GCP_PUBSUB_PROJECT` | GCP Project ID for the Pub/Sub publish topic. Required if GCP Pub/Sub is the chosen publish MQ provider. | `nil` | Conditional |
 | `PUBLISH_GCP_PUBSUB_SERVICE_ACCOUNT_CREDENTIALS` | JSON string or path to a file containing GCP service account credentials for the Pub/Sub publish topic. Required if GCP Pub/Sub is chosen and not using implicit credentials. | `nil` | Conditional |
 | `PUBLISH_GCP_PUBSUB_SUBSCRIPTION` | Name of the GCP Pub/Sub subscription to read published events from. Required if GCP Pub/Sub is the chosen publish MQ provider. | `nil` | Conditional |
@@ -153,21 +153,6 @@ alert:
 # Enables or disables audit logging for significant events.
 audit_log: true
 
-clickhouse:
-  # Address (host:port) of the ClickHouse server. Example: 'localhost:9000'. Required if ClickHouse is used for log storage.
-  # Required: C
-  addr: ""
-
-  # Database name in ClickHouse to use.
-  database: "outpost"
-
-  # Password for ClickHouse authentication.
-  password: ""
-
-  # Username for ClickHouse authentication.
-  username: ""
-
-
 # Maximum number of delivery attempts to process concurrently.
 delivery_max_concurrency: 1
 
@@ -243,7 +228,7 @@ mqs:
   # Configuration for using AWS SQS as the message queue. Only one MQ provider should be configured.
   aws_sqs:
     # AWS Access Key ID for SQS. Required if AWS SQS is the chosen MQ provider.
-    # Required: C
+    # Required: Conditional
     access_key_id: ""
 
     # Name of the SQS queue for delivery events.
@@ -256,11 +241,11 @@ mqs:
     log_queue: "outpost-log"
 
     # AWS Region for SQS. Required if AWS SQS is the chosen MQ provider.
-    # Required: C
+    # Required: Conditional
     region: ""
 
     # AWS Secret Access Key for SQS. Required if AWS SQS is the chosen MQ provider.
-    # Required: C
+    # Required: Conditional
     secret_access_key: ""
 
 
@@ -274,6 +259,9 @@ mqs:
     # Required: Y
     client_secret: ""
 
+    # Azure Service Bus connection string
+    connection_string: ""
+
     # Subscription name for delivery queue
     delivery_subscription: "outpost-delivery-sub"
 
@@ -318,11 +306,11 @@ mqs:
     log_topic: "outpost-log"
 
     # GCP Project ID for Pub/Sub. Required if GCP Pub/Sub is the chosen MQ provider.
-    # Required: C
+    # Required: Conditional
     project: ""
 
     # JSON string or path to a file containing GCP service account credentials for Pub/Sub. Required if GCP Pub/Sub is the chosen MQ provider and not running in an environment with implicit credentials (e.g., GCE, GKE).
-    # Required: C
+    # Required: Conditional
     service_account_credentials: ""
 
 
@@ -338,7 +326,7 @@ mqs:
     log_queue: "outpost-log"
 
     # RabbitMQ server connection URL (e.g., 'amqp://user:pass@host:port/vhost'). Required if RabbitMQ is the chosen MQ provider.
-    # Required: C
+    # Required: Conditional
     server_url: ""
 
 
@@ -350,22 +338,22 @@ otel:
   # OpenTelemetry configuration specific to logs.
   logs:
     # Specifies the OTLP exporter to use for this telemetry type (e.g., 'otlp'). Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.
-    # Required: C
+    # Required: Conditional
     exporter: ""
 
     # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL.
-    # Required: C
+    # Required: Conditional
     protocol: ""
 
 
   # OpenTelemetry configuration specific to metrics.
   metrics:
     # Specifies the OTLP exporter to use for this telemetry type (e.g., 'otlp'). Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.
-    # Required: C
+    # Required: Conditional
     exporter: ""
 
     # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL.
-    # Required: C
+    # Required: Conditional
     protocol: ""
 
 
@@ -375,11 +363,11 @@ otel:
   # OpenTelemetry configuration specific to traces.
   traces:
     # Specifies the OTLP exporter to use for this telemetry type (e.g., 'otlp'). Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.
-    # Required: C
+    # Required: Conditional
     exporter: ""
 
     # Specifies the OTLP protocol ('grpc' or 'http') for this telemetry type. Typically used with environment variables like OTEL_EXPORTER_OTLP_TRACES_PROTOCOL.
-    # Required: C
+    # Required: Conditional
     protocol: ""
 
 
@@ -413,53 +401,68 @@ portal:
   proxy_url: ""
 
   # The expected Referer URL for accessing the portal. This is a security measure. Required if the Outpost Portal is enabled/used. Example: 'https://admin.example.com'.
-  # Required: C
+  # Required: Conditional
   referer_url: ""
 
 
 # Connection URL for PostgreSQL, used as an alternative log storage. Example: 'postgres://user:pass@host:port/dbname?sslmode=disable'. Required if ClickHouse is not configured and log storage is needed.
-# Required: C
+# Required: Conditional
 postgres: ""
 
 publishmq:
   # Configuration for using AWS SQS as the publish message queue. Only one publish MQ provider should be configured.
   aws_sqs:
     # AWS Access Key ID for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     access_key_id: ""
 
     # Custom AWS SQS endpoint URL for the publish queue. Optional.
     endpoint: ""
 
     # Name of the SQS queue for publishing events. Required if AWS SQS is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     queue: ""
 
     # AWS Region for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     region: ""
 
     # AWS Secret Access Key for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     secret_access_key: ""
 
 
+  # Configuration for using Azure Service Bus as the publish message queue. Only one publish MQ provider should be configured.
+  azure_servicebus:
+    # Azure Service Bus connection string for the publish queue. Required if Azure Service Bus is the chosen publish MQ provider.
+    # Required: Conditional
+    connection_string: ""
+
+    # Name of the Azure Service Bus subscription to read published events from. Required if Azure Service Bus is the chosen publish MQ provider.
+    # Required: Conditional
+    subscription: ""
+
+    # Name of the Azure Service Bus topic for publishing events. Required if Azure Service Bus is the chosen publish MQ provider.
+    # Required: Conditional
+    topic: ""
+
+
   # Configuration for using GCP Pub/Sub as the publish message queue. Only one publish MQ provider should be configured.
   gcp_pubsub:
     # GCP Project ID for the Pub/Sub publish topic. Required if GCP Pub/Sub is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     project: ""
 
     # JSON string or path to a file containing GCP service account credentials for the Pub/Sub publish topic. Required if GCP Pub/Sub is chosen and not using implicit credentials.
-    # Required: C
+    # Required: Conditional
     service_account_credentials: ""
 
     # Name of the GCP Pub/Sub subscription to read published events from. Required if GCP Pub/Sub is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     subscription: ""
 
     # Name of the GCP Pub/Sub topic for publishing events. Required if GCP Pub/Sub is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     topic: ""
 
 
@@ -469,11 +472,11 @@ publishmq:
     exchange: ""
 
     # Name of the RabbitMQ queue for publishing events. Required if RabbitMQ is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     queue: ""
 
     # RabbitMQ server connection URL for the publish queue. Required if RabbitMQ is the chosen publish MQ provider.
-    # Required: C
+    # Required: Conditional
     server_url: ""