Skip to content

Commit acbc0e1

Browse files
authored
[chore][docs] Add documentation to ElasticSearch configuration (#6103)
## Which problem is this PR solving? - Part of #6059 ## Description of the changes - Added some remaining documentation to the ElasticSearch configuration that was left over from #6090 ## How was this change tested? - CI ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [x] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `yarn lint` and `yarn test` Signed-off-by: Mahad Zaryab <[email protected]>
1 parent fe700fe commit acbc0e1

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

pkg/es/config/config.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ type Sniffing struct {
155155
// Enabled, if set to true, enables sniffing for the ElasticSearch client.
156156
Enabled bool `mapstructure:"enabled"`
157157
// UseHTTPS, if set to true, sets the HTTP scheme to HTTPS when performing sniffing.
158+
// For ESV8, the scheme is set to HTTPS by default, so this configuration is ignored.
158159
UseHTTPS bool `mapstructure:"use_https"`
159160
}
160161

@@ -188,6 +189,8 @@ type BasicAuthentication struct {
188189
// when making HTTP requests. Note that TokenFilePath and AllowTokenFromContext
189190
// should not both be enabled. If both TokenFilePath and AllowTokenFromContext are set,
190191
// the TokenFilePath will be ignored.
192+
// For more information about token-based authentication in elasticsearch, check out
193+
// https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html.
191194
type BearerTokenAuthentication struct {
192195
// FilePath contains the path to a file containing a bearer token.
193196
FilePath string `mapstructure:"file_path"`

0 commit comments

Comments
 (0)