Add placeholder secret config for the Alarm Service (#203)

* Add Alarm Service secret config and values
ni · May 28, 2024 · 24ccbab · 24ccbab
1 parent 3a27b7e
commit 24ccbab
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 0 deletions.
diff --git a/getting-started/templates/systemlink-secrets.yaml b/getting-started/templates/systemlink-secrets.yaml
@@ -177,6 +177,24 @@ assetservice:
       ##
       replicaSetKey: "" # <ATTENTION>
 
+## Secret configuration for the Alarm Service
+##
+alarmservice:
+  secrets:
+    ## Credentials for the MongoDB cluster.
+    ##
+    mongodb:
+      ## Root user password for the database cluster.
+      ##
+      rootPassword: "" # <ATTENTION>
+      ## Limited user password to allow the service to access the database. This password cannot contain commas or any character that must be escaped in a URL.
+      ##
+      servicePassword: "" # <ATTENTION>
+      ## Key used to authenticate pods in the database cluster.
+      ## Refer to mongodb documentation for key generation: https://www.mongodb.com/docs/manual/tutorial/enforce-keyfile-access-control-in-existing-replica-set/#create-a-keyfile
+      ##
+      replicaSetKey: "" # <ATTENTION>
+
 ## Secret configuration for Grafana dashboard hosting.
 ##
 dashboardhost:

diff --git a/getting-started/templates/systemlink-values.yaml b/getting-started/templates/systemlink-values.yaml
@@ -343,6 +343,97 @@ testmonitorservice:
       ##
       certificateSubPath: *postgresCertificateFileName
 
+## Configuration for the Alarm Service
+##
+alarmservice:
+  ## Per-replica rate limiting configuration
+  ##
+  rateLimits:
+    ## Configuration for the global rate limiter that applies to all requests
+    ##
+    global:
+      ## Enable the rate limiter
+      ##
+      enabled: true
+      ## Number of token to replenish per second
+      ## 
+      tokensPerSecond: 750
+      ## Maximum number of tokens that can accumulate
+      ##
+      tokenLimit: 200
+      ## Number of requests that may queue when no tokens are available
+      ##
+      queueLimit: 0
+
+    ## Configuration for the per-user rate limiter for acknowledging alarms
+    ##
+    acknowledge:
+      ## Enable the rate limiter
+      ##
+      enabled: true
+      ## Number of token to replenish per second
+      ## 
+      tokensPerSecond: 5
+      ## Maximum number of tokens that can accumulate
+      ##
+      tokenLimit: 5
+      ## Number of requests that may queue when no tokens are available
+      ##
+      queueLimit: 1
+
+    ## Configuration for the per-API key rate limiter for creating or updating alarms
+    ##
+    createOrUpdate:
+      ## Enable the rate limiter
+      ##
+      enabled: true
+      ## Number of token to replenish per second
+      ## 
+      tokensPerSecond: 700
+      ## Maximum number of tokens that can accumulate
+      ##
+      tokenLimit: 200
+      ## Number of requests that may queue when no tokens are available
+      ##
+      queueLimit: 0
+
+    ## Configuration for the per-user rate limiter for deleting alarms
+    ##
+    delete:
+      ## Enable the rate limiter
+      ##
+      enabled: true
+      ## Number of token to replenish per second
+      ## 
+      tokensPerSecond: 10
+      ## Maximum number of tokens that can accumulate
+      ##
+      tokenLimit: 10
+      ## Number of requests that may queue when no tokens are available
+      ##
+      queueLimit: 2
+
+    ## Configuration for the per-user rate limiter for querying alarms
+    ##
+    getAndQuery:
+      ## Enable the rate limiter
+      ##
+      enabled: true
+      ## Number of token to replenish per second
+      ## 
+      tokensPerSecond: 10
+      ## Maximum number of tokens that can accumulate
+      ##
+      tokenLimit: 10
+      ## Number of requests that may queue when no tokens are available
+      ##
+      queueLimit: 2
+
+  database:
+    ## The amount of time inactive alarms will be retained in the database ([d.]hh:mm[:ss] format).
+    ##
+    inactiveAlarmCleanupInterval: 30.00:00
+
 ## Configuration for the Grafana dashboard provider.
 ##
 dashboardhost: