From c0b863fe96fbaee7c602ee123e8beec8451e357c Mon Sep 17 00:00:00 2001 From: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> Date: Wed, 11 Jun 2025 15:34:01 -0700 Subject: [PATCH 1/3] pipeline: outputs: elasticsearch: add api key as valid auth type Adds documentation for the HTTP API Key authentication type to the elasticsearch output plugin Signed-off-by: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> --- pipeline/outputs/elasticsearch.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pipeline/outputs/elasticsearch.md b/pipeline/outputs/elasticsearch.md index d248d2338..c7d4a322a 100644 --- a/pipeline/outputs/elasticsearch.md +++ b/pipeline/outputs/elasticsearch.md @@ -29,6 +29,7 @@ operational Elasticsearch service running in your environment. | `Cloud_Auth` | Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud | _none_ | | `HTTP_User` | Optional username credential for Elastic X-Pack access | _none_ | | `HTTP_Passwd` | Password for user defined in `HTTP_User` | _none_ | +| `HTTP_API_Key` | API key for Elastic. If `HTTP_User` or `Cloud_Auth` are defined, this will be ignored | _none_ | | `Index` | Index name | `fluent-bit` | | `Type` | Type name | `_doc` | | `Logstash_Format` | Enable Logstash format compatibility. This option takes a Boolean value: `True/False`, `On/Off` | `Off` | @@ -56,7 +57,7 @@ be compared to the `database` and `table` concepts. ### TLS / SSL -The Elasticsearch output plugin supports TLS/SSL. +The Elasticsearch output plugin supports TLS/SSL. For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ### `write_operation` From f8f18d6703f8768bdf0ef8ced41dd9aa04fa3844 Mon Sep 17 00:00:00 2001 From: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> Date: Wed, 11 Jun 2025 17:30:34 -0700 Subject: [PATCH 2/3] add value must be base64 encoded Signed-off-by: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> --- pipeline/outputs/elasticsearch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/elasticsearch.md b/pipeline/outputs/elasticsearch.md index c7d4a322a..6fac96a80 100644 --- a/pipeline/outputs/elasticsearch.md +++ b/pipeline/outputs/elasticsearch.md @@ -29,7 +29,7 @@ operational Elasticsearch service running in your environment. | `Cloud_Auth` | Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud | _none_ | | `HTTP_User` | Optional username credential for Elastic X-Pack access | _none_ | | `HTTP_Passwd` | Password for user defined in `HTTP_User` | _none_ | -| `HTTP_API_Key` | API key for Elastic. If `HTTP_User` or `Cloud_Auth` are defined, this will be ignored | _none_ | +| `HTTP_API_Key` | API key for Elastic, must be base64 encoded. If `HTTP_User` or `Cloud_Auth` are defined, this will be ignored | _none_ | | `Index` | Index name | `fluent-bit` | | `Type` | Type name | `_doc` | | `Logstash_Format` | Enable Logstash format compatibility. This option takes a Boolean value: `True/False`, `On/Off` | `Off` | From e28f9452c2c54d3605ebf0d8a2ae4e3f21cf275f Mon Sep 17 00:00:00 2001 From: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> Date: Thu, 12 Jun 2025 08:50:22 -0700 Subject: [PATCH 3/3] Update pipeline/outputs/elasticsearch.md Co-authored-by: Adam Locke <adam.locke@chronosphere.io> Signed-off-by: Todd Kennedy <95242064+tkennedy1-godaddy@users.noreply.github.com> --- pipeline/outputs/elasticsearch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/elasticsearch.md b/pipeline/outputs/elasticsearch.md index 6fac96a80..beb7dd8b0 100644 --- a/pipeline/outputs/elasticsearch.md +++ b/pipeline/outputs/elasticsearch.md @@ -29,7 +29,7 @@ operational Elasticsearch service running in your environment. | `Cloud_Auth` | Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud | _none_ | | `HTTP_User` | Optional username credential for Elastic X-Pack access | _none_ | | `HTTP_Passwd` | Password for user defined in `HTTP_User` | _none_ | -| `HTTP_API_Key` | API key for Elastic, must be base64 encoded. If `HTTP_User` or `Cloud_Auth` are defined, this will be ignored | _none_ | +| `HTTP_API_Key` | API key for authenticating with Elasticsearch. Must be `base64` encoded. If `HTTP_User` or `Cloud_Auth` are defined, this parameter is ignored. | _none_ | | `Index` | Index name | `fluent-bit` | | `Type` | Type name | `_doc` | | `Logstash_Format` | Enable Logstash format compatibility. This option takes a Boolean value: `True/False`, `On/Off` | `Off` |