HYPERFLEET-549 - feat: standard configuration

Author: rh-amarin

README.md

@@ -190,9 +190,9 @@ Broker configuration is managed by the [hyperfleet-broker library](https://githu
 
 | Variable | Description | Example |
 |----------|-------------|---------|
-| `BROKER_TOPIC` | Topic name for publishing events | `hyperfleet-dev-clusters` |
+| `HYPERFLEET_BROKER_TOPIC` | Topic name for publishing events | `hyperfleet-dev-clusters` |
 
-The `BROKER_TOPIC` environment variable sets the full topic name where events will be published. When using Helm, the default topic is `{namespace}-{resourceType}` (e.g., `hyperfleet-dev-clusters`, `hyperfleet-dev-nodepools`). This enables isolation between different environments or tenants sharing the same broker. See [Naming Strategy](https://github.com/openshift-hyperfleet/architecture/blob/main/hyperfleet/components/sentinel/sentinel-naming-strategy.md) for details.
+The `HYPERFLEET_BROKER_TOPIC` environment variable sets the full topic name where events will be published. When using Helm, the default topic is `{namespace}-{resourceType}` (e.g., `hyperfleet-dev-clusters`, `hyperfleet-dev-nodepools`). This enables isolation between different environments or tenants sharing the same broker. See [Naming Strategy](https://github.com/openshift-hyperfleet/architecture/blob/main/hyperfleet/components/sentinel/sentinel-naming-strategy.md) for details.
 
 For detailed broker configuration options, see the [hyperfleet-broker documentation](https://github.com/openshift-hyperfleet/hyperfleet-broker).
 

charts/README.md

@@ -78,14 +78,14 @@ The following table lists the configurable parameters of the Sentinel chart and
 
 | Parameter | Description | Default |
 |-----------|-------------|---------|
-| `config.resourceType` | Resource type to watch | `clusters` |
-| `config.pollInterval` | Polling interval | `5s` |
-| `config.maxAgeNotReady` | Max age for not ready resources | `10s` |
-| `config.maxAgeReady` | Max age for ready resources | `30m` |
-| `config.resourceSelector` | Resource selector for sharding | See values.yaml |
-| `config.hyperfleetApi.baseUrl` | HyperFleet API base URL | `http://hyperfleet-api:8000` |
-| `config.hyperfleetApi.timeout` | API timeout | `5s` |
-| `config.messageData` | CloudEvents data payload fields | See values.yaml |
+| `config.resource_type` | Resource type to watch | `clusters` |
+| `config.poll_interval` | Polling interval | `5s` |
+| `config.max_age_not_ready` | Max age for not ready resources | `10s` |
+| `config.max_age_ready` | Max age for ready resources | `30m` |
+| `config.resource_selector` | Resource selector for sharding | See values.yaml |
+| `config.clients.hyperfleet_api.base_url` | HyperFleet API base URL | `http://hyperfleet-api:8000` |
+| `config.clients.hyperfleet_api.timeout` | API timeout | `10s` |
+| `config.message_data` | CloudEvents data payload fields | See values.yaml |
 
 ### Broker Configuration
 
@@ -94,13 +94,13 @@ The following table lists the configurable parameters of the Sentinel chart and
 | Parameter | Description | Default |
 |-----------|-------------|---------|
 | `broker.type` | Broker type (`rabbitmq` or `googlepubsub`) | `rabbitmq` |
-| `broker.topic` | Topic name for broker publishing (supports Helm templates) | `{{ .Release.Namespace }}-{{ .Values.config.resourceType }}` |
+| `broker.topic` | Topic name for broker publishing (supports Helm templates) | `{{ .Release.Namespace }}-{{ .Values.config.resource_type }}` |
 | `broker.rabbitmq.url` | RabbitMQ connection URL (format: `amqp://user:pass@host:port/vhost`) | `amqp://sentinel-user:change-me-in-production@rabbitmq.hyperfleet-system.svc.cluster.local:5672/hyperfleet` |
-| `broker.rabbitmq.exchangeType` | RabbitMQ exchange type | `topic` |
-| `broker.googlepubsub.projectId` | GCP project ID (for Pub/Sub) | `your-gcp-project-id` |
-| `broker.googlepubsub.maxOutstandingMessages` | Max outstanding messages (for Pub/Sub) | `1000` |
-| `broker.googlepubsub.numGoroutines` | Number of goroutines (for Pub/Sub) | `10` |
-| `broker.googlepubsub.createTopicIfMissing` | Auto-create topic if it doesn't exist (for Pub/Sub) | `false` |
+| `broker.rabbitmq.exchange_type` | RabbitMQ exchange type | `topic` |
+| `broker.googlepubsub.project_id` | GCP project ID (for Pub/Sub) | `your-gcp-project-id` |
+| `broker.googlepubsub.max_outstanding_messages` | Max outstanding messages (for Pub/Sub) | `1000` |
+| `broker.googlepubsub.num_goroutines` | Number of goroutines (for Pub/Sub) | `10` |
+| `broker.googlepubsub.create_topic_if_missing` | Auto-create topic if it doesn't exist (for Pub/Sub) | `false` |
 | `subscriber.parallelism` | Number of parallel workers for message processing | `1` |
 | `existingSecret` | Use existing secret for broker credentials | `""` |
 
@@ -135,10 +135,10 @@ broker:
   rabbitmq:
     # Connection URL with credentials, host, port, and vhost
     url: amqp://sentinel-prod:super-secret-password@rabbitmq.messaging.svc.cluster.local:5672/prod
-    exchangeType: topic
+    exchange_type: topic
 
 config:
-  resourceSelector:
+  resource_selector:
     - label: environment
       value: production
 ```
@@ -156,9 +156,9 @@ helm install sentinel ./charts \
 broker:
   type: googlepubsub
   googlepubsub:
-    projectId: my-gcp-project
-    maxOutstandingMessages: 1000
-    numGoroutines: 10
+    project_id: my-gcp-project
+    max_outstanding_messages: 1000
+    num_goroutines: 10
 ```
 
 ```bash
@@ -190,15 +190,15 @@ Deploy multiple Sentinel instances watching different resource shards:
 ```yaml
 # values-shard-1.yaml
 config:
-  resourceSelector:
+  resource_selector:
     - label: shard
       value: "1"
 ```
 
 ```yaml
 # values-shard-2.yaml
 config:
-  resourceSelector:
+  resource_selector:
     - label: shard
       value: "2"
 ```

charts/templates/configmap.yaml

@@ -6,30 +6,58 @@ metadata:
     {{- include "sentinel.labels" . | nindent 4 }}
 data:
   config.yaml: |
+    # Sentinel information
+    sentinel:
+      name: {{ tpl .Values.config.sentinel.name . }}
+
+    # Debug configuration
+    debug_config: {{ .Values.config.debug_config }}
+
+    # Logging configuration
+    log:
+      level: {{ .Values.config.log.level | quote }}
+      format: {{ .Values.config.log.format | quote }}
+      output: {{ .Values.config.log.output | quote }}
+
+    # Client configurations
+    clients:
+      # HyperFleet API client
+      hyperfleet_api:
+        base_url: {{ .Values.config.clients.hyperfleet_api.base_url }}
+        version: {{ .Values.config.clients.hyperfleet_api.version | quote }}
+        timeout: {{ .Values.config.clients.hyperfleet_api.timeout }}
+        retry_attempts: {{ .Values.config.clients.hyperfleet_api.retry_attempts }}
+        retry_backoff: {{ .Values.config.clients.hyperfleet_api.retry_backoff | quote }}
+        base_delay: {{ .Values.config.clients.hyperfleet_api.base_delay }}
+        max_delay: {{ .Values.config.clients.hyperfleet_api.max_delay }}
+        {{- if .Values.config.clients.hyperfleet_api.default_headers }}
+        default_headers:
+          {{- toYaml .Values.config.clients.hyperfleet_api.default_headers | nindent 10 }}
+        {{- end }}
+
+      # Broker client
+      broker:
+        topic: {{ tpl .Values.broker.topic . | quote }}
+
     # Sentinel configuration
-    resource_type: {{ .Values.config.resourceType }}
-    poll_interval: {{ .Values.config.pollInterval }}
-    max_age_not_ready: {{ .Values.config.maxAgeNotReady }}
-    max_age_ready: {{ .Values.config.maxAgeReady }}
+    resource_type: {{ .Values.config.resource_type }}
+    poll_interval: {{ .Values.config.poll_interval }}
+    max_age_not_ready: {{ .Values.config.max_age_not_ready }}
+    max_age_ready: {{ .Values.config.max_age_ready }}
 
-    {{- if .Values.config.resourceSelector }}
+    {{- if .Values.config.resource_selector }}
     # Resource selector for horizontal sharding
     resource_selector:
-      {{- range .Values.config.resourceSelector }}
+      {{- range .Values.config.resource_selector }}
       - label: {{ .label }}
         value: {{ .value | quote }}
       {{- end }}
     {{- end }}
 
-    # HyperFleet API configuration
-    hyperfleet_api:
-      endpoint: {{ .Values.config.hyperfleetApi.baseUrl }}
-      timeout: {{ .Values.config.hyperfleetApi.timeout }}
-
-    {{- if .Values.config.messageData }}
+    {{- if .Values.config.message_data }}
     # CloudEvents data payload configuration
     message_data:
-      {{- toYaml .Values.config.messageData | nindent 6 }}
+      {{- toYaml .Values.config.message_data | nindent 6 }}
     {{- end }}
 ---
 apiVersion: v1
@@ -46,24 +74,24 @@ data:
       {{- if eq .Values.broker.type "rabbitmq" }}
       rabbitmq:
         url: {{ .Values.broker.rabbitmq.url | quote }}
-        exchange_type: {{ .Values.broker.rabbitmq.exchangeType | default "topic" }}
-        {{- if .Values.broker.rabbitmq.prefetchCount }}
-        prefetch_count: {{ .Values.broker.rabbitmq.prefetchCount }}
+        exchange_type: {{ .Values.broker.rabbitmq.exchange_type | default "topic" }}
+        {{- if .Values.broker.rabbitmq.prefetch_count }}
+        prefetch_count: {{ .Values.broker.rabbitmq.prefetch_count }}
         {{- end }}
-        {{- if .Values.broker.rabbitmq.prefetchSize }}
-        prefetch_size: {{ .Values.broker.rabbitmq.prefetchSize }}
+        {{- if .Values.broker.rabbitmq.prefetch_size }}
+        prefetch_size: {{ .Values.broker.rabbitmq.prefetch_size }}
         {{- end }}
       {{- else if eq .Values.broker.type "googlepubsub" }}
       googlepubsub:
-        project_id: {{ .Values.broker.googlepubsub.projectId | quote }}
-        {{- if .Values.broker.googlepubsub.maxOutstandingMessages }}
-        max_outstanding_messages: {{ .Values.broker.googlepubsub.maxOutstandingMessages }}
+        project_id: {{ .Values.broker.googlepubsub.project_id | quote }}
+        {{- if .Values.broker.googlepubsub.max_outstanding_messages }}
+        max_outstanding_messages: {{ .Values.broker.googlepubsub.max_outstanding_messages }}
         {{- end }}
-        {{- if .Values.broker.googlepubsub.numGoroutines }}
-        num_goroutines: {{ .Values.broker.googlepubsub.numGoroutines }}
+        {{- if .Values.broker.googlepubsub.num_goroutines }}
+        num_goroutines: {{ .Values.broker.googlepubsub.num_goroutines }}
         {{- end }}
-        {{- if hasKey .Values.broker.googlepubsub "createTopicIfMissing" }}
-        create_topic_if_missing: {{ .Values.broker.googlepubsub.createTopicIfMissing }}
+        {{- if hasKey .Values.broker.googlepubsub "create_topic_if_missing" }}
+        create_topic_if_missing: {{ .Values.broker.googlepubsub.create_topic_if_missing }}
         {{- end }}
       {{- end }}
 

charts/templates/deployment.yaml

@@ -64,7 +64,7 @@ spec:
           - name: BROKER_CONFIG_FILE
             value: /etc/sentinel/broker.yaml
           # Topic name for broker publishing
-          - name: BROKER_TOPIC
+          - name: HYPERFLEET_BROKER_TOPIC
             value: {{ tpl .Values.broker.topic . | quote }}
           # Broker credentials can be overridden via environment variables from Secret
           {{- if eq .Values.broker.type "rabbitmq" }}

charts/values.yaml

@@ -75,32 +75,63 @@ podDisruptionBudget:
 
 # Sentinel configuration
 config:
+  # Sentinel information
+  sentinel:
+    # Sentinel component name - will be templated with shard value if resource selector is used
+    # Example: hyperfleet-sentinel-clusters-shard-1
+    name: hyperfleet-sentinel-{{ .Values.config.resource_type }}
+
+  # Debug configuration - log merged config on startup
+  debug_config: false
+
+  # Logging configuration
+  log:
+    level: info
+    format: json
+    output: stdout
+
+  # Client configurations
+  clients:
+    # HyperFleet API client configuration
+    hyperfleet_api:
+      # Use in-cluster service name for API endpoint
+      base_url: http://hyperfleet-api:8000
+      version: v1
+      timeout: 10s
+      retry_attempts: 3
+      retry_backoff: exponential
+      base_delay: 1s
+      max_delay: 30s
+      # Optional default headers
+      # default_headers:
+      #   X-Custom-Header: "value"
+
+    # Broker configuration
+    # Note: broker implementation details (RabbitMQ URL, etc.) are in broker section below
+    broker:
+      # Topic will be set from broker.topic template below
+      topic: ""
+
   # Resource type to watch (clusters, nodepools)
-  resourceType: clusters
+  resource_type: clusters
 
   # How often to poll the API for resource updates
-  pollInterval: 5s
+  poll_interval: 5s
 
   # Max age interval for resources not ready
-  maxAgeNotReady: 10s
+  max_age_not_ready: 10s
 
   # Max age interval for ready resources
-  maxAgeReady: 30m
+  max_age_ready: 30m
 
   # Resource selector for horizontal sharding
   # Deploy multiple Sentinel instances with different shard values
-  resourceSelector:
+  resource_selector:
     - label: shard
       value: "1"
 
-  # HyperFleet API configuration
-  hyperfleetApi:
-    # Use in-cluster service name for API endpoint
-    baseUrl: http://hyperfleet-api:8000
-    timeout: 5s
-
   # CloudEvents data payload configuration
-  messageData:
+  message_data:
     id: resource.id
     kind: resource.kind
     href: resource.href
@@ -125,25 +156,25 @@ broker:
   # Default uses Helm template: {namespace}-{resourceType} for multi-tenant isolation
   # Example result: hyperfleet-dev-clusters, hyperfleet-dev-nodepools
   # Override with a static value if needed: topic: "my-custom-topic"
-  topic: '{{ .Release.Namespace }}-{{ .Values.config.resourceType }}'
+  topic: '{{ .Release.Namespace }}-{{ .Values.config.resource_type }}'
 
   # RabbitMQ configuration
   # Uses BROKER_RABBITMQ_URL environment variable (single connection string)
   rabbitmq:
     # Connection URL format: amqp://user:password@host:port/vhost
     url: amqp://<USER>:<PASSWORD>@rabbitmq.hyperfleet-system.svc.cluster.local:5672/hyperfleet
-    exchangeType: topic
+    exchange_type: topic
 
   # Google Pub/Sub configuration (alternative to RabbitMQ)
   # projectId is written to broker.yaml ConfigMap (not Secret - it's not sensitive)
   googlepubsub:
     #REQUIRED: Replace with your actual GCP project ID
-    projectId: your-gcp-project-id
-    maxOutstandingMessages: 1000
-    numGoroutines: 10
+    project_id: your-gcp-project-id
+    max_outstanding_messages: 1000
+    num_goroutines: 10
     # Auto-creation flags (default: false - manual creation required)
     # Set to true to automatically create topics/subscriptions if they don't exist
-    createTopicIfMissing: false
+    create_topic_if_missing: false
 
 # Subscriber configuration (optional)
 subscriber: