Skip to content

docs: add operational best practices guide#6287

Merged
k8s-ci-robot merged 5 commits intokubernetes-sigs:masterfrom
gofogo:docs-configuration-best-practices
Mar 19, 2026
Merged

docs: add operational best practices guide#6287
k8s-ci-robot merged 5 commits intokubernetes-sigs:masterfrom
gofogo:docs-configuration-best-practices

Conversation

@ivankatliarchuk
Copy link
Copy Markdown
Member

@ivankatliarchuk ivankatliarchuk commented Mar 17, 2026

What does it do ?

  • New docs/advanced/operational-best-practices.md — production readiness checklist and multiple sections
  • docs/advanced/domain-filter.md — adds a top-level note clarifying that domain filter flags are application-level intent, not a strict/security enforcement boundary

Motivation

Operational problems — memory bloat from over-scoped informers, crashloops from missing CRDs or RBAC misconfiguration, silent DNS drift, state conflicts amplifying Kubernetes API pressure - are not covered anywhere in the existing docs. Users discover them in production.

Relates

  1. PR fix(source): skip sources that fail to initialize instead of crashing #6185 — fix(source): skip sources that fail to initialize instead of crashing (CLOSED)
  2. PR feat: add --kube-api-cache-sync-timeout flag for configurable cache sync timeout #6104 — feat: make RequestTimeout configurable for all sources (OPEN)
  3. PR WIP feat(source): metric and event for invalid endpoints #6242 — feat(source): metric and event for invalid endpoints (WIP/CLOSED)
  4. PR fix(google): do not retry HTTP 409 Conflict errors #6171 — fix(google): do not retry HTTP 409 Conflict errors (DRAFT)
  5. PR feat(cloudflare): support batch API for DNS record changes #6208 — feat(cloudflare): support batch API for DNS record changes (MERGED)
  6. Issue Potential memory leak in v0.20.0 on linux/arm64 with webhook provider #5965 — Potential memory leak in v0.20.0 on linux/arm64 with webhook provider (memory use)
  7. feat: add --include-domains flag for exact FQDN whitelist matching #6140

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 17, 2026
@coveralls
Copy link
Copy Markdown

coveralls commented Mar 17, 2026

Pull Request Test Coverage Report for Build 23196753102

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 78.239%

Totals Coverage Status
Change from base Build 23186150406: 0.0%
Covered Lines: 16323
Relevant Lines: 20863

💛 - Coveralls

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@vflaux
Copy link
Copy Markdown
Contributor

vflaux commented Mar 17, 2026

That was an informative read 😃
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 17, 2026
@ivankatliarchuk
Copy link
Copy Markdown
Member Author

/approve

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 19, 2026
@k8s-ci-robot k8s-ci-robot merged commit de04f34 into kubernetes-sigs:master Mar 19, 2026
18 checks passed
@ivankatliarchuk ivankatliarchuk deleted the docs-configuration-best-practices branch March 19, 2026 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants