Adjust and debug wrong levelled flags in docs generator, use a workar…

…ound by double suppressing docs
grafana · Mar 5, 2025 · 398822f · 398822f
1 parent 5948836
commit 398822f
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/cmd/mimir/config-descriptor.json b/cmd/mimir/config-descriptor.json
@@ -4988,10 +4988,9 @@
               "kind": "field",
               "name": "alertmanager_url",
               "required": false,
-              "desc": "Per-tenant alertmanager client configuration. If not supplied, the tenant's notifications will be sent to the ruler-wide default.",
+              "desc": "",
               "fieldValue": null,
-              "fieldDefaultValue": "{\"AlertmanagerURL\":\"\",\"NotifierConfig\":{\"TLSEnabled\":false,\"TLS\":{\"CertPath\":\"\",\"KeyPath\":\"\",\"CAPath\":\"\",\"ServerName\":\"\",\"InsecureSkipVerify\":false,\"CipherSuites\":\"\",\"MinVersion\":\"\",\"Reader\":null},\"BasicAuth\":{\"Username\":\"\",\"Password\":{}},\"OAuth2\":{\"ClientID\":\"\",\"ClientSecret\":{},\"TokenURL\":\"\",\"Scopes\":null,\"EndpointParams\":{}},\"ProxyURL\":\"\"}}",
-              "fieldFlag": "ruler.alertmanager-client-config",
+              "fieldDefaultValue": "",
               "fieldType": "string"
             },
             {

diff --git a/docs/sources/mimir/configure/configuration-parameters/index.md b/docs/sources/mimir/configure/configuration-parameters/index.md
@@ -3885,11 +3885,10 @@ The `limits` block configures default and per-tenant limits imposed by component
 # CLI flag: -ruler.max-independent-rule-evaluation-concurrency-per-tenant
 [ruler_max_independent_rule_evaluation_concurrency_per_tenant: <int> | default = 4]
 
+# Per-tenant alertmanager client configuration. If not supplied, the tenant's
+# notifications will be sent to the ruler-wide default.
 ruler_alertmanager_client_config:
-  # Per-tenant alertmanager client configuration. If not supplied, the tenant's
-  # notifications will be sent to the ruler-wide default.
-  # CLI flag: -ruler.alertmanager-client-config
-  [alertmanager_url: <string> | default = "{\"AlertmanagerURL\":\"\",\"NotifierConfig\":{\"TLSEnabled\":false,\"TLS\":{\"CertPath\":\"\",\"KeyPath\":\"\",\"CAPath\":\"\",\"ServerName\":\"\",\"InsecureSkipVerify\":false,\"CipherSuites\":\"\",\"MinVersion\":\"\",\"Reader\":null},\"BasicAuth\":{\"Username\":\"\",\"Password\":{}},\"OAuth2\":{\"ClientID\":\"\",\"ClientSecret\":{},\"TokenURL\":\"\",\"Scopes\":null,\"EndpointParams\":{}},\"ProxyURL\":\"\"}}"]
+  [alertmanager_url: <string> | default = ""]
 
   # (advanced)
   [tls_enabled: <boolean> | default = ]

diff --git a/pkg/ruler/notifier/notifier_config.go b/pkg/ruler/notifier/notifier_config.go
@@ -20,7 +20,7 @@ var DefaultAlertmanagerClientConfig = AlertmanagerClientConfig{
 }
 
 type AlertmanagerClientConfig struct {
-	AlertmanagerURL string `yaml:"alertmanager_url"`
+	AlertmanagerURL string `yaml:"alertmanager_url" doc:"nocli"`
 	NotifierConfig  Config `yaml:",inline" json:",inline"`
 }
 

diff --git a/pkg/util/validation/limits.go b/pkg/util/validation/limits.go
@@ -221,7 +221,7 @@ type Limits struct {
 	RulerMaxRuleGroupsPerTenantByNamespace                flagext.LimitsMap[int]            `yaml:"ruler_max_rule_groups_per_tenant_by_namespace" json:"ruler_max_rule_groups_per_tenant_by_namespace" category:"experimental"`
 	RulerProtectedNamespaces                              flagext.StringSliceCSV            `yaml:"ruler_protected_namespaces" json:"ruler_protected_namespaces" category:"experimental"`
 	RulerMaxIndependentRuleEvaluationConcurrencyPerTenant int64                             `yaml:"ruler_max_independent_rule_evaluation_concurrency_per_tenant" json:"ruler_max_independent_rule_evaluation_concurrency_per_tenant" category:"experimental"`
-	RulerAlertmanagerClientConfig                         notifier.AlertmanagerClientConfig `yaml:"ruler_alertmanager_client_config" json:"ruler_alertmanager_client_config" category:"experimental"`
+	RulerAlertmanagerClientConfig                         notifier.AlertmanagerClientConfig `yaml:"ruler_alertmanager_client_config" json:"ruler_alertmanager_client_config" category:"experimental" doc:"nocli|description=Per-tenant alertmanager client configuration. If not supplied, the tenant's notifications will be sent to the ruler-wide default."`
 
 	// Store-gateway.
 	StoreGatewayTenantShardSize int `yaml:"store_gateway_tenant_shard_size" json:"store_gateway_tenant_shard_size"`

diff --git a/tools/doc-generator/parse/parser.go b/tools/doc-generator/parse/parser.go
@@ -24,6 +24,7 @@ import (
 	"github.com/thanos-io/objstore/providers/s3"
 
 	asmodel "github.com/grafana/mimir/pkg/ingester/activeseries/model"
+	"github.com/grafana/mimir/pkg/ruler/notifier"
 	"github.com/grafana/mimir/pkg/storage/tsdb"
 	"github.com/grafana/mimir/pkg/util/configdoc"
 	"github.com/grafana/mimir/pkg/util/validation"
@@ -494,6 +495,8 @@ func ReflectType(typ string) reflect.Type {
 		return reflect.TypeOf([]*validation.BlockedQuery{})
 	case "blocked_requests_config...":
 		return reflect.TypeOf([]*validation.BlockedRequest{})
+	case "ruler_alertmanager_client_config...":
+		return reflect.TypeOf(notifier.AlertmanagerClientConfig{})
 	case "map of string to float64":
 		return reflect.TypeOf(flagext.LimitsMap[float64]{})
 	case "map of string to int":