Skip to content

docs: Document sidecarContainers for Fluent Bit - #352

Draft
promptless-for-oss wants to merge 1 commit into
kube-logging:masterfrom
Promptless:promptless/fluentbit-sidecar-containers
Draft

promptless-for-oss wants to merge 1 commit into
kube-logging:masterfrom
Promptless:promptless/fluentbit-sidecar-containers

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open in Promptless

Documents the new sidecarContainers field on the Fluent Bit spec, added in kube-logging/logging-operator#2359. Fluentd has supported user-defined sidecars since 4.5. Until now, the Fluent Bit DaemonSet ran only the containers the operator manages.

Changes:

  • logging-infrastructure/fluentbit.md: a new Sidecar containers section. It explains what the field is for, using the issue's example of a sidecar that restarts a Fluent Bit that has stopped shipping logs. It also covers where the operator places these containers in the DaemonSet pod, the names to avoid, and that the field works in both FluentbitAgent and logging.spec.fluentbit. A minimal example follows.
  • whats-new/_index.md: a bullet under ## Unreleased, the same heading other open What's new suggestions use. Rename it to the release version when this ships.

The section links to fluentbit_types.md#fluentbitspec-sidecarcontainers with relref. That anchor appears in the next generated-docs sync from the operator repository. Until then, the link opens the reference page without jumping to the field. The generated reference page wasn't edited by hand.

Verification: the site builds with Hugo 0.110.0 extended, the version CI uses, and both new links resolve.

Merge after kube-logging/logging-operator#2359 merges. You can tell it has merged when the PR shows as merged on GitHub.

Trigger Events

Comment thread content/docs/logging-infrastructure/fluentbit.md
Comment thread content/docs/logging-infrastructure/fluentbit.md
Comment thread content/docs/logging-infrastructure/fluentbit.md
Comment thread content/docs/whats-new/_index.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant