Skip to content

Commit aa74397

Browse files
committed
Install: build: various; style
Signed-off-by: Lynette Miles <[email protected]>
1 parent 9d601c3 commit aa74397

File tree

8 files changed

+33
-25
lines changed

8 files changed

+33
-25
lines changed

installation/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The recommended way to deploy Fluent Bit for Kubernetes is with the official [He
2828

2929
If you are using Red Hat OpenShift you must set up Security Context Constraints (SCC) using the relevant option in the helm chart.
3030

31-
### Installing with Helm Chart
31+
### Installing with Helm chart
3232

3333
[Helm](https://helm.sh) is a package manager for Kubernetes and lets you deploy application packages into your running cluster. Fluent Bit is distributed using a Helm chart found in the [Fluent Helm Charts repository](https://github.com/fluent/helm-charts).
3434

installation/macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Fluent Bit is compatible with the latest Apple macOS software for x86_64 and App
44

55
## Installation packages
66

7-
Installation packages can be found [here](https://packages.fluentbit.io/macos/).
7+
Installation packages can be found [in the Fluent Bit repository](https://packages.fluentbit.io/macos/).
88

99
## Requirements
1010

installation/upgrade-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ The `td-agent-bit` package is no longer provided after this release. Users shoul
1616

1717
If you are migrating from previous version of Fluent Bit, review the following important changes:
1818

19-
### Tail Input Plugin
19+
### Tail input plugin
2020

2121
By default, the tail input plugin follows a file from the end after the service starts, instead of reading it from the beginning. Every file found when the plugin starts is followed from it last position. New files discovered at runtime or when files rotate are read from the beginning.
2222

2323
To keep the old behavior, set the option `read_from_head` to `true`.
2424

25-
### Stackdriver Output Plugin
25+
### Stackdriver output plugin
2626

2727
The `project_id` of [resource](https://cloud.google.com/logging/docs/reference/v2/rest/v2/MonitoredResource) in [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) sent to Google Cloud Logging would be set to the `project_id` rather than the project number. To learn the difference between Project ID and project number, see [Creating and managing projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#before_you_begin).
2828

@@ -44,15 +44,15 @@ If you are migrating from Fluent Bit v1.2 to v1.3, there are no breaking changes
4444

4545
## Fluent Bit v1.2
4646

47-
### Docker, JSON, Parsers and Decoders
47+
### Docker, JSON, parsers, and decoders
4848

4949
Fluent Bit v1.2 fixed many issues associated with JSON encoding and decoding.
5050

5151
For example, when parsing Docker logs, it's no longer necessary to use decoders. The new Docker parser looks like this:
5252

5353
```python [PARSER] Name docker Format json Time_Key time Time_Format %Y-%m-%dT%H:%M:%S.%L Time_Keep On ```
5454

55-
### Kubernetes Filter
55+
### Kubernetes filter
5656

5757
Fluent Bit made improvements to Kubernetes Filter handling of stringified `log` messages. If the `Merge_Log` option is enabled, it will try to handle the log content as a JSON map, if so, it will add the keys to the root map.
5858

installation/windows.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,20 @@ The latest stable version is 4.0.5. Each version is available from the following
8585

8686
| INSTALLERS | SHA256 CHECKSUMS |
8787
|----------- | ---------------- |
88-
| [fluent-bit-4.0.5-win32.exe](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.exe) | [31d1d98f3c9a8cb829abc448de93ef859b63d02852c8529482fe284ed1176356](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.exe.sha256) |
89-
| [fluent-bit-4.0.5-win32.zip](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.zip) | [98463c4a2d49392a2a01a8942f9ec6096328845c71476b5fd8a6055487101772](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.zip.sha256) |
90-
| [fluent-bit-4.0.5-win64.exe](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.exe) | [935bc64cd81140e37c3e59aeed65e96a5e2c1e255252d2084754f2e829f04301](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.exe.sha256) |
91-
| [fluent-bit-4.0.5-win64.zip](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.zip) | [f0c101bfd889c6f327dc74914e6084b77dbad9c9d64fe58a63fddd836aa29fec](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.zip.sha256) |
92-
| [fluent-bit-4.0.5-winarm64.exe](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.exe) | [be71a4c9ce51d69ea7ae18b32670c377e21039d4543a362ee06cee519e6c5308](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.exe.sha256) |
93-
| [fluent-bit-4.0.5-winarm64.zip](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.zip) | [b39bfc3901b6da135acdc5fd16ce36ba7c6195efa7c68635815991816c35882e](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.zip.sha256) |
88+
| [`fluent-bit-4.0.5-win32.exe`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.exe) | [`31d1d98f3c9a8cb829abc448de93ef859b63d02852c8529482fe284ed1176356`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.exe.sha256) |
89+
| [`fluent-bit-4.0.5-win32.zip`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.zip) | [`98463c4a2d49392a2a01a8942f9ec6096328845c71476b5fd8a6055487101772`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.zip.sha256) |
90+
| [`fluent-bit-4.0.5-win64.exe`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.exe) | [`935bc64cd81140e37c3e59aeed65e96a5e2c1e255252d2084754f2e829f04301`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.exe.sha256) |
91+
| [`fluent-bit-4.0.5-win64.zip`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.zip) | [`f0c101bfd889c6f327dc74914e6084b77dbad9c9d64fe58a63fddd836aa29fec`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.zip.sha256) |
92+
| [`fluent-bit-4.0.5-winarm64.exe`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.exe) | [`be71a4c9ce51d69ea7ae18b32670c377e21039d4543a362ee06cee519e6c5308`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.exe.sha256) |
93+
| [`fluent-bit-4.0.5-winarm64.zip`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.zip) | [`b39bfc3901b6da135acdc5fd16ce36ba7c6195efa7c68635815991816c35882e`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.zip.sha256) |
9494

9595
These are now using the Github Actions built versions. Legacy AppVeyor builds are still available (AMD 32/64 only) at releases.fluentbit.io but are deprecated.
9696

9797
MSI installers are also available:
9898

99-
- [fluent-bit-4.0.5-win32.msi](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.msi)
100-
- [fluent-bit-4.0.5-win64.msi](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.msi)
101-
- [fluent-bit-4.0.5-winarm64.msi](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.msi)
99+
- [`fluent-bit-4.0.5-win32.msi`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win32.msi)
100+
- [`fluent-bit-4.0.5-win64.msi`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-win64.msi)
101+
- [`fluent-bit-4.0.5-winarm64.msi`](https://packages.fluentbit.io/windows/fluent-bit-4.0.5-winarm64.msi)
102102

103103
To check the integrity, use the `Get-FileHash` cmdlet for PowerShell.
104104

@@ -164,10 +164,10 @@ Fluent Bit v2.0.x
164164

165165
To halt the process, press `Control+C` in the terminal.
166166

167-
## Installing from the EXE installer
167+
## Installing from the executable installer
168168

169-
1. Download an EXE installer for the appropriate 32-bit or 64-bit build.
170-
1. Double-click the EXE installer you've downloaded. The installation wizard starts.
169+
1. Download an `EXE` installer for the appropriate 32-bit or 64-bit build.
170+
1. Double-click the `EXE` installer you've downloaded. The installation wizard starts.
171171

172172
1. Click **Next** and finish the installation. By default, Fluent Bit is installed in `C:\Program Files\fluent-bit\`.
173173

@@ -189,7 +189,7 @@ The uninstaller also supports a silent uninstall using the same `/S` flag. This
189189

190190
## Windows service support
191191

192-
Windows services are equivalent to daemons in UNIX (long-running background processes). For v1.5.0 and later, Fluent Bit has native support for Windows services.
192+
Windows services are equivalent to daemons in Unix (long-running background processes). For v1.5.0 and later, Fluent Bit has native support for Windows services.
193193

194194
For example, you have the following installation layout:
195195

@@ -279,7 +279,7 @@ Remove the service (requires PowerShell 6.0 or later)
279279
Remove-Service fluent-bit
280280
```
281281
282-
## Compile from Source
282+
## Compile from source
283283
284284
If you need to create a custom executable, use the following procedure to compile Fluent Bit by yourself.
285285
@@ -294,7 +294,7 @@ start vs.exe
294294
295295
1. Choose `C++ Build Tools` and `C++ CMake tools for Windows` and wait until the process finishes.
296296
297-
1. Install flex and bison. One way to install them on Windows is to use [winflexbison](https://github.com/lexxmark/winflexbison).
297+
1. Install flex and bison. One way to install them on Windows is to use [`winflexbison`](https://github.com/lexxmark/winflexbison).
298298
299299
```shell
300300
wget -o winflexbison.zip https://github.com/lexxmark/winflexbison/releases/download/v2.5.22/win_flex_bison-2.5.22.zip

installation/yocto-embedded-linux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Fluent Bit distributes two main recipes, one for testing/dev purposes and one wi
66

77
| Version | Recipe | Description |
88
| :--- | :--- | :--- |
9-
| `devel` | [fluent-bit\_git.bb](https://github.com/fluent/fluent-bit/blob/master/fluent-bit_git.bb) | Build Fluent Bit from Git master. Use for development and testing purposes only. |
10-
| `v1.8.11` | [fluent-bit\_1.8.11.bb](https://github.com/fluent/fluent-bit/blob/v1.8.11/fluent-bit_1.8.11.bb) | Build latest stable version of Fluent Bit. |
9+
| `devel` | [fluent-bit_git.bb](https://github.com/fluent/fluent-bit/blob/master/fluent-bit_git.bb) | Build Fluent Bit from Git master. Use for development and testing purposes only. |
10+
| `v1.8.11` | [fluent-bit_1.8.11.bb](https://github.com/fluent/fluent-bit/blob/v1.8.11/fluent-bit_1.8.11.bb) | Build latest stable version of Fluent Bit. |
1111

1212
It's strongly recommended to always use the stable release of the Fluent Bit recipe and not the one from Git master for production deployments.
1313

1414
## Fluent Bit and other architectures
1515

16-
Fluent Bit &gt;= v1.1.x fully supports `x86_64`, `x86`, `arm32v7`, and `arm64v8`.
16+
Fluent Bit 1.1.x and later fully supports `x86_64`, `x86`, `arm32v7`, and `arm64v8`.

vale-styles/FluentBit/Acronyms.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
1010
exceptions:
1111
- AAD
1212
- ACL
13+
- AMD
1314
- ANSI
1415
- API
1516
- ARN
@@ -57,6 +58,7 @@ exceptions:
5758
- HTTP
5859
- HTTPS
5960
- IAM
61+
- IBM
6062
- IDE
6163
- IMDS
6264
- ISO
@@ -72,12 +74,14 @@ exceptions:
7274
- MIME
7375
- MAC
7476
- MQTT
77+
- MSI
7578
- MSK
7679
- NATS
7780
- NET
7881
- NGINX
7982
- NIC
8083
- NOTE
84+
- NSIS
8185
- NVDA
8286
- OAP
8387
- OOM

vale-styles/FluentBit/Headings.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ exceptions:
6868
- Grafana Cloud
6969
- Graylog Extended Log Format
7070
- gRPC
71+
- Helm
72+
- Homebrew
7173
- HTTP
7274
- I
7375
- InfluxDB
@@ -95,8 +97,9 @@ exceptions:
9597
- OIDC
9698
- Okta
9799
- OpenMetrics
98-
- OpenSearch
99100
- OpenObserve
101+
- OpenSearch
102+
- OpenShift
100103
- OpenTelemetry
101104
- Opsgenie
102105
- Oracle Cloud Infrastructure Logging Analytics

vale-styles/FluentBit/Spelling-exceptions.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ grpc_service
9292
gzip
9393
HashiCorp
9494
HEC
95+
Homebrew
9596
hostname
9697
Hostname
9798
Ingester

0 commit comments

Comments
 (0)