Skip to content

[Release] Update docs for the 9.6.0 release#51813

Open
elastic-vault-github-plugin-prod[bot] wants to merge 1 commit into
mainfrom
update-dev-docs-9.6.0
Open

[Release] Update docs for the 9.6.0 release#51813
elastic-vault-github-plugin-prod[bot] wants to merge 1 commit into
mainfrom
update-dev-docs-9.6.0

Conversation

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Update the docs for next minor 9.6.0.

Merge after the release branch for 9.4.3 is created.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🤖 GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)
  • /test : Run the Buildkite pipeline.

@mergify

mergify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @elastic-vault-github-plugin-prod[bot]? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

@github-actions

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

TL;DR

The failed Buildkite steps are generated-file checks, not test failures. The PR updated libbeat/docs/version.asciidoc, but did not commit all generated modules.d/*.yml.disabled doc-link updates, and it also missed the generated deploy/kubernetes/heartbeat-kubernetes.yaml image tag update.

Remediation

  • Run and commit the generated outputs from make -C filebeat update, make -C x-pack/filebeat update, make -C metricbeat update, make -C x-pack/metricbeat update, and make -C deploy/kubernetes all.
  • Validate with the failing Buildkite commands: make -C filebeat check update, make -C x-pack/filebeat check update, make -C metricbeat check update, make -C x-pack/metricbeat check update, then make -C deploy/kubernetes all && make check-no-changes.
Investigation details

Root Cause

This is a generated-output drift/configuration failure caused by the PR's version file change. The PR changes libbeat/docs/version.asciidoc from :stack-version: 9.3.0 / :doc-branch: current to :stack-version: 9.6.0 / :doc-branch: main.

For the modules.d files, Mage exposes beat_doc_branch in dev-tools/mage/settings.go:105-107, reads it from libbeat/docs/version.asciidoc via DefaultBeatBuildVariableSources.DocBranch in dev-tools/mage/settings.go:443-449, and uses it in the module header template in dev-tools/mage/modules.go:30-34:

# Docs: https://www.elastic.co/guide/en/beats/{{.BeatName}}/{{ beat_doc_branch }}/{{.BeatName}}-module-{{.Module}}.html

The failed beats all wire update/config to regenerate modules.d: filebeat/magefile.go:128-139, metricbeat/magefile.go:121-124 and metricbeat/magefile.go:174-179, x-pack/filebeat/magefile.go:146-159, and x-pack/metricbeat/magefile.go:195-208. Representative committed generated files still contain the old doc branch, for example metricbeat/modules.d/apache.yml.disabled:1-2 has https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-apache.html, and x-pack/filebeat/modules.d/aws.yml.disabled:1-2 has https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-module-aws.html.

For Kubernetes manifests, deploy/kubernetes/Makefile:1-3 includes heartbeat in ALL and derives BEAT_VERSION from libbeat/docs/version.asciidoc; deploy/kubernetes/Makefile:24-33 regenerates each *-kubernetes.yaml by replacing %VERSION%. The PR updated auditbeat/filebeat/metricbeat manifests, but deploy/kubernetes/heartbeat-kubernetes.yaml:172-174 still has image: docker.elastic.co/beats/heartbeat-wolfi:9.3.0, while Buildkite regenerated it to 9.6.0.

Evidence

Error: some files are not up-to-date. Run 'make update' then review and commit the changes. Modified: [filebeat/modules.d/apache.yml.disabled ... filebeat/modules.d/traefik.yml.disabled]
make: *** [../libbeat/scripts/Makefile:141: check] Error 1
  • Failed job: x-pack/filebeat: Run check/update
Error: some files are not up-to-date. Run 'make update' then review and commit the changes. Modified: [x-pack/filebeat/modules.d/activemq.yml.disabled ... x-pack/filebeat/modules.d/zoom.yml.disabled]
make: *** [../../dev-tools/make/mage.mk:21: check] Error 1
  • Failed job: Metricbeat: Run check/update
Error: some files are not up-to-date. Run 'make update' then review and commit the changes. Modified: [metricbeat/modules.d/aerospike.yml.disabled ... metricbeat/modules.d/zookeeper.yml.disabled]
make: *** [../dev-tools/make/mage.mk:21: check] Error 1
  • Failed job: x-pack/metricbeat: Run check/update
Error: some files are not up-to-date. Run 'make update' then review and commit the changes. Modified: [x-pack/metricbeat/modules.d/activemq.yml.disabled ... x-pack/metricbeat/modules.d/tomcat.yml.disabled]
make: *** [../../dev-tools/make/mage.mk:21: check] Error 1
  • Failed job: Checks / deploy-k8s
diff --git a/deploy/kubernetes/heartbeat-kubernetes.yaml b/deploy/kubernetes/heartbeat-kubernetes.yaml
-        image: docker.elastic.co/beats/heartbeat-wolfi:9.3.0
+        image: docker.elastic.co/beats/heartbeat-wolfi:9.6.0
deploy/kubernetes/heartbeat-kubernetes.yaml: needs update
make: *** [Makefile:119: check-no-changes] Error 1

Verification

Not run locally; the local checkout is not the PR head. The Buildkite logs already show the exact generated files that become dirty after the PR's version/doc-branch change.


What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@belimawr

belimawr commented Jul 8, 2026

Copy link
Copy Markdown
Member

make update needs to be run at the root of the repo.

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

Labels

automation docs in progress Pull request is currently in progress. release skip-changelog Team:Automation Label for the Observability productivity team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants