From 3ad639e7c5e31feb09c8c6975cd453590a4b96c6 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Sat, 19 Oct 2024 14:54:50 -0400 Subject: [PATCH] Add Documentation To ES Configuration Signed-off-by: Mahad Zaryab --- pkg/es/config/config.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/es/config/config.go b/pkg/es/config/config.go index 72f566c25c5..5cf9429e6d4 100644 --- a/pkg/es/config/config.go +++ b/pkg/es/config/config.go @@ -155,6 +155,7 @@ type Sniffing struct { // Enabled, if set to true, enables sniffing for the ElasticSearch client. Enabled bool `mapstructure:"enabled"` // UseHTTPS, if set to true, sets the HTTP scheme to HTTPS when performing sniffing. + // For ESV8, the scheme is set to HTTPS by default, so this configuration is ignored. UseHTTPS bool `mapstructure:"use_https"` } @@ -188,6 +189,8 @@ type BasicAuthentication struct { // when making HTTP requests. Note that TokenFilePath and AllowTokenFromContext // should not both be enabled. If both TokenFilePath and AllowTokenFromContext are set, // the TokenFilePath will be ignored. +// For more information about token-based authentication in elasticsearch, check out +// https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html. type BearerTokenAuthentication struct { // FilePath contains the path to a file containing a bearer token. FilePath string `mapstructure:"file_path"`