elasticsearch:opensearch: add documentation for aws_service_name option #1032
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pipeline/outputs/opensearch.md
Outdated
| @@ -21,10 +21,11 @@ The following instructions assumes that you have a fully operational OpenSearch | |||
| | AWS\_STS\_Endpoint | Specify the custom sts endpoint to be used with STS API for Amazon OpenSearch Service | | | |||
| | AWS\_Role\_ARN | AWS IAM Role to assume to put records to your Amazon cluster | | | |||
| | AWS\_External\_ID | External ID for the AWS IAM Role specified with `aws_role_arn` | | | |||
| | AWS\_Service\_Name | Service name to be used in AWS Sigv4 signature. For integration with Amazon OpenSearch Serverless, set to `aoss` | es | | |||
There was a problem hiding this comment.
Can we add a serverless example?
There was a problem hiding this comment.
Added an example and a period.
lizsnyder
reviewed
Mar 1, 2023
pipeline/outputs/opensearch.md
Outdated
| @@ -157,3 +158,21 @@ Without this you will see errors like: | |||
| ```text | |||
| {"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"}],"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"},"status":400} | |||
| ``` | |||
|
|
|||
| ### Amazon OpenSearch Serverless <a id="#aws-opensearch-serverless"></a> | |||
| Amazon OpenSearch Serverless an offering that eliminates your need to manage OpenSearch clusters. All existing Fluent Bit OpenSearch output plugin options work with OpenSearch Serverless. The only difference with serverless from a Fluent Bit POV is that you must specify the service name as `aoss` (Amazon OpenSearch Serverless) when you enable `AWS_Auth`: | |||
pipeline/outputs/opensearch.md
Outdated
| @@ -157,3 +158,21 @@ Without this you will see errors like: | |||
| ```text | |||
| {"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"}],"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"},"status":400} | |||
| ``` | |||
|
|
|||
| ### Amazon OpenSearch Serverless <a id="#aws-opensearch-serverless"></a> | |||
| Amazon OpenSearch Serverless an offering that eliminates your need to manage OpenSearch clusters. All existing Fluent Bit OpenSearch output plugin options work with OpenSearch Serverless. The only difference with serverless from a Fluent Bit POV is that you must specify the service name as `aoss` (Amazon OpenSearch Serverless) when you enable `AWS_Auth`: | |||
There was a problem hiding this comment.
For Fluent Bit, the only difference is that you must specify the service name...
pipeline/outputs/opensearch.md
Outdated
|
|
||
| **Data Access Permissions** | ||
|
|
||
| When sending logs to OpenSearch Serverless, your AWS IAM entity needs [OpenSearch Serverless Data Access permisions](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html). Give your IAM entity the following Data Access permissions to your serverless collection: |
matthewfala
force-pushed
the
aoss
branch
2 times, most recently
from
f310b37
to
0aef94e
Compare
lizsnyder
approved these changes
Mar 1, 2023
PettitWesley
reviewed
Mar 1, 2023
| @@ -21,6 +21,7 @@ The **es** output plugin, allows to ingest your records into an [Elasticsearch]( | |||
| | AWS\_STS\_Endpoint | Specify the custom sts endpoint to be used with STS API for Amazon OpenSearch Service | | | |||
| | AWS\_Role\_ARN | AWS IAM Role to assume to put records to your Amazon cluster | | | |||
| | AWS\_External\_ID | External ID for the AWS IAM Role specified with `aws_role_arn` | | | |||
| | 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 | | |||
There was a problem hiding this comment.
I'm worried this relative FAQ link won't work but I guess it does...
There was a problem hiding this comment.
I think it does work. I tried it in vscode and the reference was found. In the diff, it takes me to https://github.com/fluent/fluent-bit-docs/blob/aoss/pipeline/outputs/opensearch.md
PettitWesley
approved these changes
Mar 1, 2023
Signed-off-by: Matthew Fala <falamatt@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OpenSearch Serverless Support
Added the following option to support serverless:
See the following PRs that are in review:
fluent/fluent-bit#6448
fluent/fluent-bit#6612