Skip to content

Commit c92ce19

Browse files
committed
pipeline: outputs: elasticsearch: add cloud_apikey setting
Signed-off-by: Soedarsono <[email protected]>
1 parent 4d309a7 commit c92ce19

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

pipeline/outputs/elasticsearch.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ The **es** output plugin, allows to ingest your records into an [Elasticsearch](
2424
| AWS\_Service\_Name | Service name to be used in AWS Sigv4 signature. For integration with Amazon OpenSearch Serverless, set to `aoss`. See the [FAQ](opensearch.md#faq) section on Amazon OpenSearch Serverless for more information. | es |
2525
| Cloud\_ID | If you are using Elastic's Elasticsearch Service you can specify the cloud\_id of the cluster running. The Cloud ID string has the format `<deployment_name>:<base64_info>`. Once decoded, the `base64_info` string has the format `<deployment_region>$<elasticsearch_hostname>$<kibana_hostname>`.
2626
| |
27-
| Cloud\_Auth | Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud | |
27+
| Cloud\_Auth | Specify the credentials that would be used to connect to Elastic's Elasticsearch Service running on Elastic Cloud | |
28+
| Cloud\_Apikey | Specify the ApiKey that would be used to connect to Elastic's Elasticsearch Service running on Elastic Cloud | |
2829
| HTTP\_User | Optional username credential for Elastic X-Pack access | |
2930
| HTTP\_Passwd | Password for user defined in HTTP\_User | |
3031
| Index | Index name | fluent-bit |
@@ -197,8 +198,11 @@ Notice that the `Port` is set to `443`, `tls` is enabled, and `AWS_Region` is se
197198

198199
### Fluent Bit + Elastic Cloud
199200

200-
Fluent Bit supports connecting to [Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html) providing just the `cloud_id` and the `cloud_auth` settings.
201-
`cloud_auth` uses the `elastic` user and password provided when the cluster was created, for details refer to the [Cloud ID usage page](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html).
201+
Fluent Bit supports connecting to [Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html) by providing `cloud_id` setting and the proper credentials. Credentials can be specified by either the `cloud_auth` or `cloud_apikey` setting.
202+
203+
`cloud_auth` uses the `elastic` user and password provided when the cluster was created. For details refer to the [Cloud ID usage page](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html).
204+
205+
`cloud_apikey` uses the cloud apikey that could be generated in the Elasticsearch Service console. For details, refer to the [Cloud API Keys page](https://www.elastic.co/guide/en/cloud/current/ec-api-keys.html).
202206

203207
Example configuration:
204208

@@ -212,6 +216,16 @@ Example configuration:
212216
Suppress_Type_Name On
213217
cloud_id elastic-obs-deployment:ZXVybxxxxxxxxxxxg==
214218
cloud_auth elastic:2vxxxxxxxxYV
219+
220+
[OUTPUT]
221+
Name es
222+
Include_Tag_Key true
223+
Tag_Key tags
224+
tls On
225+
tls.verify Off
226+
Suppress_Type_Name On
227+
cloud_id elastic-obs-deployment:ZXVybxxxxxxxxxxxg==
228+
cloud_apikey VnVhQxxxxxxxxxxxxx==
215229
```
216230

217231
### Validation Failed: 1: an id must be provided if version type or value are set

0 commit comments

Comments
 (0)