Skip to content

docs: clarify ServiceMonitor and PrometheusRule defaults and alternatives #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Soju06 wants to merge 1 commit into from
+31 −0
Closed

docs: clarify ServiceMonitor and PrometheusRule defaults and alternatives #309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions deploy/helm/codex-lb/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,13 @@ metrics:
port: 9090
serviceMonitor:
# @param metrics.serviceMonitor.enabled Create a ServiceMonitor for Prometheus Operator
# Defaults to false because it requires the Prometheus Operator CRDs to be installed.
# Enable this when running kube-prometheus-stack or standalone Prometheus Operator.
# Without ServiceMonitor, configure prometheus.io annotations for scraping:
# commonAnnotations:
# prometheus.io/scrape: "true"
# prometheus.io/port: "9090"
# prometheus.io/path: "/metrics"
enabled: false
# @param metrics.serviceMonitor.interval Metrics scrape interval
interval: 30s
Expand All @@ -306,6 +313,8 @@ metrics:
relabelings: []
prometheusRule:
# @param metrics.prometheusRule.enabled Create PrometheusRule for alerting
# Requires Prometheus Operator. Includes alerts for: high error rate, circuit breaker open,
# all accounts exhausted, high request latency. See templates/prometheusrule.yaml for details.
enabled: false
# @param metrics.prometheusRule.additionalLabels Additional labels for PrometheusRule
additionalLabels: {}
Expand Down Expand Up @@ -355,6 +364,28 @@ externalDatabase:
# @param externalDatabase.existingSecret Secret containing external DB credentials
existingSecret: ""

# @section Database initialization parameters
dbInit:
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove unsupported dbInit values until templates exist

This change adds a dbInit section that claims to enable a pre-install database initialization Job, but the chart has no template path that consumes .Values.dbInit (I checked deploy/helm/codex-lb/templates/**). In practice, dbInit.enabled: true is a no-op, so operators can believe DB/users were provisioned when nothing ran. Please either include the actual hook/job implementation in the same change or defer this values block until that functionality exists.

Useful? React with 👍 / 👎.

# @param dbInit.enabled Enable pre-install Job to create databases/users on external PostgreSQL
enabled: false
# @param dbInit.host External PostgreSQL host
host: ""
# @param dbInit.port External PostgreSQL port
port: "5432"
# @param dbInit.adminUser Admin username for creating databases/users
adminUser: "adminuser"
# @param dbInit.adminPassword Admin password (use adminPasswordSecret for production)
adminPassword: ""
# @param dbInit.adminPasswordSecret Reference to existing Secret for admin password
adminPasswordSecret: {}
# name: pg-admin-secret
# key: password
# @param dbInit.databases List of databases and users to create
databases:
- name: codexlb
user: codexlb
password: changeme

# @section Migration parameters
migration:
# @param migration.enabled Run database migration Job on install/upgrade
Expand Down
Loading