From 452574bca1e6cd94da376697b229d52f3eb38dd2 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Thu, 14 Nov 2024 13:53:22 -0800 Subject: [PATCH 1/5] Updating for style Signed-off-by: Lynette Miles --- installation/aws-container.md | 47 +++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/installation/aws-container.md b/installation/aws-container.md index 89af22448..6c1b36d29 100644 --- a/installation/aws-container.md +++ b/installation/aws-container.md @@ -1,45 +1,57 @@ # Containers on AWS -AWS maintains a distribution of Fluent Bit combining the latest official release with a set of Go Plugins for sending logs to AWS services. AWS and Fluent Bit are working together to rewrite their plugins for inclusion in the official Fluent Bit distribution. +AWS maintains a distribution of Fluent Bit combining the latest official release with +a set of Go Plugins for sending logs to AWS services. AWS and Fluent Bit are working +together to rewrite their plugins for inclusion in the official Fluent Bit +distribution. ## Plugins -Currently, the [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contains Go Plugins for: +The [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contains Go +Plugins for: -* [Amazon CloudWatch Logs](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit) -* [Amazon Kinesis Firehose](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) -* [Amazon Kinesis Streams](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit) +- [Amazon CloudWatch](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) +- [Amazon Kinesis Data Firehose](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) +- [Amazon Kinesis Data Streams](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) -Fluent Bit includes Amazon CloudWatch Logs plugin named `cloudwatch_logs`, Amazon Kinesis Firehose plugin named `kinesis_firehose` and Amazon Kinesis Data Streams plugin named `kinesis_streams` which are higher performance than Go plugins. +- [Amazon CloudWatch Logs](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit) as `cloudwatch_logs` +- [Amazon Kinesis + Firehose](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) as `kinesis_firehose` +- [Amazon Kinesis + Streams](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit) as `kinesis_streams` -* [Amazon CloudWatch](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) -* [Amazon Kinesis Data Firehose](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) -* [Amazon Kinesis Data Streams](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) +These plugins are higher performance than Go plugins. -Also, Fluent Bit includes S3 output plugin named `s3`. +Also, Fluent Bit includes an S3 output plugin named `s3`. -* [Amazon S3](https://docs.fluentbit.io/manual/pipeline/outputs/s3) +- [Amazon S3](https://docs.fluentbit.io/manual/pipeline/outputs/s3) ## Versions and Regional Repositories -AWS vends their container image via [Docker Hub](https://hub.docker.com/r/amazon/aws-for-fluent-bit), and a set of highly available regional Amazon ECR repositories. For more information, see the [AWS for Fluent Bit GitHub repo](https://github.com/aws/aws-for-fluent-bit#public-images). +AWS vends their container image using +[Docker Hub](https://hub.docker.com/r/amazon/aws-for-fluent-bit), and a set of highly +available regional Amazon ECR repositories. For more information, see the +[AWS for Fluent Bit GitHub repository](https://github.com/aws/aws-for-fluent-bit#public-images). -The AWS for Fluent Bit image uses a custom versioning scheme because it contains multiple projects. To see what each release contains, check out the [release notes on GitHub](https://github.com/aws/aws-for-fluent-bit/releases). +The AWS for Fluent Bit image uses a custom versioning scheme because it contains +multiple projects. To see what each release contains, see the [release notes on +GitHub](https://github.com/aws/aws-for-fluent-bit/releases). ## SSM Public Parameters -AWS vends SSM Public Parameters with the regional repository link for each image. These parameters can be queried by any AWS account. +AWS vends SSM Public Parameters with the regional repository link for each image. +These parameters can be queried by any AWS account. To see a list of available version tags in a given region, run the following command: -```text +```bash aws ssm get-parameters-by-path --region eu-central-1 --path /aws/service/aws-for-fluent-bit/ --query 'Parameters[*].Name' ``` To see the ECR repository URI for a given image tag in a given region, run the following: -```text -$ aws ssm get-parameter --region ap-northeast-1 --name /aws/service/aws-for-fluent-bit/2.0.0 +```bash +aws ssm get-parameter --region ap-northeast-1 --name /aws/service/aws-for-fluent-bit/2.0.0 ``` You can use these SSM public parameters as parameters in your CloudFormation templates: @@ -51,4 +63,3 @@ Parameters: Type: AWS::SSM::Parameter::Value Default: /aws/service/aws-for-fluent-bit/latest ``` - From 795164478cb0a657221f94965865d46bed1210ff Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 3 Dec 2024 14:46:21 -0800 Subject: [PATCH 2/5] install: aws: style updates Signed-off-by: Lynette Miles --- installation/aws-container.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/installation/aws-container.md b/installation/aws-container.md index 6c1b36d29..73644c2ea 100644 --- a/installation/aws-container.md +++ b/installation/aws-container.md @@ -10,15 +10,15 @@ distribution. The [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contains Go Plugins for: -- [Amazon CloudWatch](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) -- [Amazon Kinesis Data Firehose](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) -- [Amazon Kinesis Data Streams](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) - -- [Amazon CloudWatch Logs](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit) as `cloudwatch_logs` -- [Amazon Kinesis - Firehose](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) as `kinesis_firehose` -- [Amazon Kinesis - Streams](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit) as `kinesis_streams` +- Amazon CloudWatch as `cloudwatch_logs`. + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) | + [Plugin](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit) +- Amazon Kinesis Data Firehose as `kinesis_firehose`. + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) + [Plugin](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) +- Amazon Kinesis Data Streams as `kinesis_streams`. + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) + [Plugin](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit) These plugins are higher performance than Go plugins. @@ -39,7 +39,7 @@ GitHub](https://github.com/aws/aws-for-fluent-bit/releases). ## SSM Public Parameters -AWS vends SSM Public Parameters with the regional repository link for each image. +AWS vends SSM public parameters with the regional repository link for each image. These parameters can be queried by any AWS account. To see a list of available version tags in a given region, run the following command: From cbe312df5ba3fa3ab6df654bfbbc61294c6a8a04 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 3 Dec 2024 14:49:20 -0800 Subject: [PATCH 3/5] Correcting some spacing issues Signed-off-by: Lynette Miles --- installation/aws-container.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/installation/aws-container.md b/installation/aws-container.md index 73644c2ea..fc75474a4 100644 --- a/installation/aws-container.md +++ b/installation/aws-container.md @@ -10,15 +10,15 @@ distribution. The [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contains Go Plugins for: -- Amazon CloudWatch as `cloudwatch_logs`. - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) | - [Plugin](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit) -- Amazon Kinesis Data Firehose as `kinesis_firehose`. - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) - [Plugin](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) -- Amazon Kinesis Data Streams as `kinesis_streams`. - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) - [Plugin](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit) +- Amazon CloudWatch as `cloudwatch_logs`. See the + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) or the + [Plugin repository](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit). +- Amazon Kinesis Data Firehose as `kinesis_firehose`. See the + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) or the + [Plugin repository](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit). +- Amazon Kinesis Data Streams as `kinesis_streams`. See the + [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) or the + [Plugin repository](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit). These plugins are higher performance than Go plugins. From 3fb5e40153324a1095ad9099bfbf39068b1db82d Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Tue, 3 Dec 2024 15:30:37 -0800 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- installation/aws-container.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/aws-container.md b/installation/aws-container.md index fc75474a4..629ef7ab1 100644 --- a/installation/aws-container.md +++ b/installation/aws-container.md @@ -1,6 +1,6 @@ # Containers on AWS -AWS maintains a distribution of Fluent Bit combining the latest official release with +AWS maintains a distribution of Fluent Bit that combines the latest official release with a set of Go Plugins for sending logs to AWS services. AWS and Fluent Bit are working together to rewrite their plugins for inclusion in the official Fluent Bit distribution. @@ -10,7 +10,7 @@ distribution. The [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contains Go Plugins for: -- Amazon CloudWatch as `cloudwatch_logs`. See the +- Amazon CloudWatch as `cloudwatch_logs`. See the [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) or the [Plugin repository](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit). - Amazon Kinesis Data Firehose as `kinesis_firehose`. See the From 1f180330d988226c0c1e476bb45b51a8b52de09c Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Tue, 3 Dec 2024 15:31:00 -0800 Subject: [PATCH 5/5] Update aws-container.md Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- installation/aws-container.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/installation/aws-container.md b/installation/aws-container.md index 629ef7ab1..29b9a9363 100644 --- a/installation/aws-container.md +++ b/installation/aws-container.md @@ -11,13 +11,13 @@ The [AWS for Fluent Bit](https://github.com/aws/aws-for-fluent-bit) image contai Plugins for: - Amazon CloudWatch as `cloudwatch_logs`. See the - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) or the + [Fluent Bit docs](https://docs.fluentbit.io/manual/pipeline/outputs/cloudwatch) or the [Plugin repository](https://github.com/aws/amazon-cloudwatch-logs-for-fluent-bit). - Amazon Kinesis Data Firehose as `kinesis_firehose`. See the - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) or the + [Fluent Bit docs](https://docs.fluentbit.io/manual/pipeline/outputs/firehose) or the [Plugin repository](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit). - Amazon Kinesis Data Streams as `kinesis_streams`. See the - [Fluent docs](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) or the + [Fluent Bit docs](https://docs.fluentbit.io/manual/pipeline/outputs/kinesis) or the [Plugin repository](https://github.com/aws/amazon-kinesis-streams-for-fluent-bit). These plugins are higher performance than Go plugins.