Skip to content

Commit 187a4da

Browse files
esmerelcnorris-cs
andauthored
Apply suggestions from code review
Co-authored-by: Craig Norris <[email protected]> Signed-off-by: esmerel <[email protected]>
1 parent 717effe commit 187a4da

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

installation/docker.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Current available images can be deployed in multiple architectures.
55

66
## Start Docker
77

8-
Use the following command to start Docker with Fluent Bit.
8+
Use the following command to start Docker with Fluent Bit:
99

1010
```shell
1111
docker run -ti cr.fluentbit.io/fluent/fluent-bit
@@ -172,7 +172,7 @@ The following checks were performed on each of these signatures:
172172
```
173173

174174
Replace `cosign` with the binary installed if it has a different name
175-
(for example: `cosign-linux-amd64`).
175+
(for example, `cosign-linux-amd64`).
176176

177177
Keyless signing is also provided but is still experimental:
178178

@@ -201,7 +201,8 @@ documentation.
201201
-i cpu -o stdout -f 1
202202
```
203203

204-
That command will let Fluent Bit measure CPU usage every second and flush the results to the standard output, e.g:
204+
That command lets Fluent Bit measure CPU usage every second and flushes the results
205+
to the standard output. For example:
205206

206207
```shell
207208
[2019/10/01 12:29:02] [ info] [engine] started
@@ -213,7 +214,7 @@ That command will let Fluent Bit measure CPU usage every second and flush the re
213214
### Why there is no Fluent Bit Docker image based on Alpine Linux?
214215

215216
Alpine Linux uses Musl C library instead of Glibc. Musl isn't fully compatible with
216-
Glibc which generated many issues in the following areas when used with Fluent Bit:
217+
Glibc, which generated many issues in the following areas when used with Fluent Bit:
217218

218219
- Memory Allocator: To run properly in high-load environments, Fluent Bit uses
219220
Jemalloc as a default memory allocator which reduces fragmentation and provides
@@ -223,24 +224,24 @@ Glibc which generated many issues in the following areas when used with Fluent B
223224
plugins in Fluent Bit.
224225
- Alpine Linux Musl Time format parser doesn't support Glibc extensions.
225226
- The Fluent Bit maintainers' preference for base images are Distroless and
226-
Debian for security and maintenance reasons .
227+
Debian for security and maintenance reasons.
227228

228229
### Why use Distroless containers?
229230

230231
The reasons for using Distroless are well covered in
231232
[Why should I use Distroless images?](https://github.com/GoogleContainerTools/distroless#why-should-i-use-distroless-images).
232233

233-
- Only include what you need, reduce the attack surface available.
234+
- Include only what you need, reduce the attack surface available.
234235
- Reduces size and improves performance.
235236
- Reduces false positives on scans (and reduces resources required for scanning).
236237
- Reduces supply chain security requirements to only what you need.
237238
- Helps prevent unauthorised processes or users interacting with the container.
238-
- Less need to harden the container (and container runtime, K8S, and so on).
239+
- Less need to harden the container (and container runtime, K8s, and so on).
239240
- Faster CI/CD processes.
240241

241242
With any choice, there are downsides:
242243

243-
- No shell or package manager to update/add things.
244+
- No shell or package manager to update or add things.
244245
- Generally, dynamic updating is a bad idea in containers as the time it's done
245246
affects the outcome: two containers started at different times using the same
246247
base image can perform differently or get different dependencies.
@@ -264,7 +265,7 @@ For debugging, debug containers are available now in K8S:
264265

265266
- This can be a significantly different container from the one you want to
266267
investigate, with lots of extra tools or even a different base.
267-
- No resource limits applied to this container - can be good or bad.
268-
- Runs in pod namespaces, it's another container that can access everything the others can.
268+
- No resource limits applied to this container, which can be good or bad.
269+
- Runs in pod namespaces. It's another container that can access everything the others can.
269270
- Might need architecture of the pod to share volumes or other information.
270271
- Requires more recent versions of K8S and the container runtime plus RBAC allowing it.

0 commit comments

Comments
 (0)