Skip to content

Commit e4dd99d

Browse files
Merge pull request #1995 from fluent/alexakreizinger/sc-142625/update-page-titles-in-fluent-bit-summary
2 parents ec223dc + feaaa7c commit e4dd99d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+464
-1113
lines changed

SUMMARY.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,63 +24,63 @@
2424

2525
## Installation
2626

27-
* [Getting Started with Fluent Bit](installation/getting-started-with-fluent-bit.md)
28-
* [Upgrade Notes](installation/upgrade-notes.md)
29-
* [Supported Platforms](installation/supported-platforms.md)
27+
* [Get started with Fluent Bit](installation/getting-started-with-fluent-bit.md)
28+
* [Upgrade notes](installation/upgrade-notes.md)
29+
* [Supported platforms](installation/supported-platforms.md)
3030
* [Requirements](installation/requirements.md)
3131
* [Sources](installation/sources/README.md)
32-
* [Download Source Code](installation/sources/download-source-code.md)
33-
* [Build and Install](installation/sources/build-and-install.md)
34-
* [Build with Static Configuration](installation/sources/build-with-static-configuration.md)
35-
* [Linux Packages](installation/linux/README.md)
32+
* [Download source code](installation/sources/download-source-code.md)
33+
* [Build and install](installation/sources/build-and-install.md)
34+
* [Build with static configuration](installation/sources/build-with-static-configuration.md)
35+
* [Linux packages](installation/linux/README.md)
3636
* [Amazon Linux](installation/linux/amazon-linux.md)
37-
* [Alma / Rocky Linux](installation/linux/alma-rocky.md)
38-
* [Redhat / CentOS](installation/linux/redhat-centos.md)
37+
* [Rocky Linux and Alma Linux ](installation/linux/alma-rocky.md)
38+
* [Red Hat and CentOS](installation/linux/redhat-centos.md)
3939
* [Debian](installation/linux/debian.md)
4040
* [Ubuntu](installation/linux/ubuntu.md)
41-
* [Raspbian / Raspberry Pi](installation/linux/raspbian-raspberry-pi.md)
41+
* [Raspbian and Raspberry Pi](installation/linux/raspbian-raspberry-pi.md)
4242
* [Docker](installation/docker.md)
4343
* [Containers on AWS](installation/aws-container.md)
4444
* [Amazon EC2](installation/amazon-ec2.md)
4545
* [Kubernetes](installation/kubernetes.md)
4646
* [macOS](installation/macos.md)
4747
* [Windows](installation/windows.md)
48-
* [Yocto / Embedded Linux](installation/yocto-embedded-linux.md)
49-
* [Buildroot / Embedded Linux](installation/buildroot-embedded-linux.md)
48+
* [Yocto embedded Linux](installation/yocto-embedded-linux.md)
49+
* [Buildroot embedded Linux](installation/buildroot-embedded-linux.md)
5050

5151
## Administration
5252

53-
* [Configuring Fluent Bit](administration/configuring-fluent-bit/README.md)
54-
* [YAML Configuration](administration/configuring-fluent-bit/yaml/README.md)
53+
* [Configure Fluent Bit](administration/configuring-fluent-bit/README.md)
54+
* [YAML configuration](administration/configuring-fluent-bit/yaml/README.md)
5555
* [Service](administration/configuring-fluent-bit/yaml/service-section.md)
5656
* [Parsers](administration/configuring-fluent-bit/yaml/parsers-section.md)
57-
* [Multiline Parsers](administration/configuring-fluent-bit/yaml/multiline-parsers-section.md)
57+
* [Multiline parsers](administration/configuring-fluent-bit/yaml/multiline-parsers-section.md)
5858
* [Pipeline](administration/configuring-fluent-bit/yaml/pipeline-section.md)
5959
* [Plugins](administration/configuring-fluent-bit/yaml/plugins-section.md)
60-
* [Upstream Servers](administration/configuring-fluent-bit/yaml/upstream-servers-section.md)
61-
* [Environment Variables](administration/configuring-fluent-bit/yaml/environment-variables-section.md)
60+
* [Upstream servers](administration/configuring-fluent-bit/yaml/upstream-servers-section.md)
61+
* [Environment variables](administration/configuring-fluent-bit/yaml/environment-variables-section.md)
6262
* [Includes](administration/configuring-fluent-bit/yaml/includes-section.md)
6363
* [Classic mode](administration/configuring-fluent-bit/classic-mode/README.md)
64-
* [Format and Schema](administration/configuring-fluent-bit/classic-mode/format-schema.md)
65-
* [Configuration File](administration/configuring-fluent-bit/classic-mode/configuration-file.md)
64+
* [Format and schema](administration/configuring-fluent-bit/classic-mode/format-schema.md)
65+
* [Configuration file](administration/configuring-fluent-bit/classic-mode/configuration-file.md)
6666
* [Variables](administration/configuring-fluent-bit/classic-mode/variables.md)
6767
* [Commands](administration/configuring-fluent-bit/classic-mode/commands.md)
68-
* [Upstream Servers](administration/configuring-fluent-bit/classic-mode/upstream-servers.md)
69-
* [Record Accessor](administration/configuring-fluent-bit/classic-mode/record-accessor.md)
68+
* [Upstream servers](administration/configuring-fluent-bit/classic-mode/upstream-servers.md)
69+
* [Record accessor syntax](administration/configuring-fluent-bit/classic-mode/record-accessor.md)
7070
* [Unit Sizes](administration/configuring-fluent-bit/unit-sizes.md)
71-
* [Multiline Parsing](administration/configuring-fluent-bit/multiline-parsing.md)
72-
* [Transport Security](administration/transport-security.md)
73-
* [Buffering and Storage](administration/buffering-and-storage.md)
71+
* [Multiline parsing](administration/configuring-fluent-bit/multiline-parsing.md)
72+
* [TLS](administration/transport-security.md)
73+
* [Buffering and storage](administration/buffering-and-storage.md)
7474
* [Backpressure](administration/backpressure.md)
75-
* [Scheduling and Retries](administration/scheduling-and-retries.md)
75+
* [Scheduling and retries](administration/scheduling-and-retries.md)
7676
* [Networking](administration/networking.md)
77-
* [Memory Management](administration/memory-management.md)
77+
* [Memory management](administration/memory-management.md)
7878
* [Monitoring](administration/monitoring.md)
7979
* [Multithreading](administration/multithreading.md)
80-
* [HTTP Proxy](administration/http-proxy.md)
81-
* [Hot Reload](administration/hot-reload.md)
80+
* [HTTP proxy](administration/http-proxy.md)
81+
* [Hot reload](administration/hot-reload.md)
8282
* [Troubleshooting](administration/troubleshooting.md)
83-
* [Performance Tips](administration/performance.md)
83+
* [Performance tips](administration/performance.md)
8484
* [AWS credentials](administration/aws-credentials.md)
8585

8686
## Local testing

administration/aws-credentials.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
1-
# AWS Credentials
1+
# AWS credentials
22

3-
Plugins that interact with AWS services fetch credentials from the following providers
4-
in order. Only the first provider that provides credentials is used.
3+
Plugins that interact with AWS services fetch credentials from the following providers in order. Only the first provider that provides credentials is used.
54

65
- [Environment variables](#environment-variables)
76
- [Shared configuration and credentials files](#shared-configuration-and-credentials-files)
87
- [EKS Web Identity Token (OIDC)](#eks-web-identity-token-oidc)
98
- [ECS HTTP credentials endpoint](#ecs-http-credentials-endpoint)
109
- [EC2 Instance Profile Credentials (IMDS)](#ec2-instance-profile-credentials-imds)
1110

12-
All AWS plugins additionally support a `role_arn` (or `AWS_ROLE_ARN`, for
13-
[Elasticsearch](../pipeline/outputs/elasticsearch.md)) configuration parameter. If
14-
specified, the fetched credentials are used to assume the given role.
11+
All AWS plugins additionally support a `role_arn` (or `AWS_ROLE_ARN`, for [Elasticsearch](../pipeline/outputs/elasticsearch.md)) configuration parameter. If specified, the fetched credentials are used to assume the given role.
1512

1613
## Environment variables
1714

18-
Plugins use the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` (and optionally
19-
`AWS_SESSION_TOKEN`) environment variables if set.
15+
Plugins use the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` (and optionally `AWS_SESSION_TOKEN`) environment variables if set.
2016

2117
## Shared configuration and credentials files
2218

23-
Plugins read the shared `config` file at `$AWS_CONFIG_FILE` (or `$HOME/.aws/config`),
24-
and the shared credentials file at `$AWS_SHARED_CREDENTIALS_FILE` (or
25-
`$HOME/.aws/credentials`) to fetch the credentials for the profile named
26-
`$AWS_PROFILE` or `$AWS_DEFAULT_PROFILE` (or "default"). See
27-
[Configuration and credential file settings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
19+
Plugins read the shared `config` file at `$AWS_CONFIG_FILE` (or `$HOME/.aws/config`), and the shared credentials file at `$AWS_SHARED_CREDENTIALS_FILE` (or `$HOME/.aws/credentials`) to fetch the credentials for the profile named `$AWS_PROFILE` or `$AWS_DEFAULT_PROFILE` (or "default"). See [Configuration and credential file settings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
2820

2921
The shared settings evaluate in the following order:
3022

@@ -37,22 +29,16 @@ No other settings are supported.
3729

3830
## EKS Web Identity Token (OIDC)
3931

40-
Credentials are fetched using a signed web identity token for a Kubernetes service account.
41-
See [IAM roles for service accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html).
32+
Credentials are fetched using a signed web identity token for a Kubernetes service account. See [IAM roles for service accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html).
4233

4334
## ECS HTTP credentials endpoint
4435

45-
Credentials are fetched for the ECS task's role. See
46-
[Amazon ECS task IAM role](https://docs.aws.amazon.com/AmazonECS/latest/userguide/task-iam-roles.html).
36+
Credentials are fetched for the ECS task's role. See [Amazon ECS task IAM role](https://docs.aws.amazon.com/AmazonECS/latest/userguide/task-iam-roles.html).
4737

4838
## EKS Pod Identity credentials
4939

50-
Credentials are fetched using a pod identity endpoint. See
51-
[Learn how EKS Pod Identity grants pods access to AWS services](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html).
40+
Credentials are fetched using a pod identity endpoint. See [Learn how EKS Pod Identity grants pods access to AWS services](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html).
5241

5342
## EC2 instance profile credentials (IMDS)
5443

55-
Fetches credentials for the EC2 instance profile's role. See
56-
[IAM roles for Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html).
57-
As of Fluent Bit version 1.8.8, IMDSv2 is used by default and IMDSv1 might be disabled.
58-
Prior versions of Fluent Bit require enabling IMDSv1 on EC2.
44+
Fetches credentials for the EC2 instance profile's role. See [IAM roles for Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html). As of Fluent Bit version 1.8.8, IMDSv2 is used by default and IMDSv1 might be disabled. Prior versions of Fluent Bit require enabling IMDSv1 on EC2.

0 commit comments

Comments
 (0)