elastic / elastic/beats

[docs-patrol] Document WII AWS credential flow and env var requirements

Open
#53,165 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 1h
Merged PRs (30d)
370

Description

Recent code changes in the repository have introduced documentation drift. The following changes need corresponding documentation updates.

Changes Requiring Documentation Updates

1. Document the new workload-identity-issuer (WII) AWS credential flow and required env vars

Commit(s): 58b25c858a

What changed:

  • Added a new identity-federation path for AWS credentials when WORKLOAD_IDENTITY_ISSUER_URL is set, including hard requirements for WORKLOAD_IDENTITY_SSL_CERT_FILE, WORKLOAD_IDENTITY_SSL_KEY_FILE, and role_arn.
    • x-pack/libbeat/common/aws/credentials.go:195-220
  • Added new workload-identity environment variables:
    • x-pack/libbeat/common/identityfederation/wii.go:29-32

Documentation impact:

  • The AWS credentials docs still list only existing access key/profile/role patterns and do not describe the WII flow or required env vars:
    • docs/reference/filebeat/filebeat-input-aws-s3.md:949-964
    • docs/reference/filebeat/filebeat-module-aws.md:290-305
    • docs/reference/metricbeat/metricbeat-module-aws.md:288-303
  • These docs should add an explicit identity-federation section for the WII path, including:
    • activation condition (WORKLOAD_IDENTITY_ISSUER_URL)
    • required variables (WORKLOAD_IDENTITY_SSL_CERT_FILE, WORKLOAD_IDENTITY_SSL_KEY_FILE)
    • optional CA variable (WORKLOAD_IDENTITY_SSL_CA_FILE)
    • required role_arn
    • precedence/fallback expectations relative to existing OIDC/IRSA paths

Suggested Actions

  • Update AWS credentials docs in Filebeat/Metricbeat references to include the WII credential flow and environment variable requirements introduced in 58b25c858a.
  • Add one short config example for agentless identity federation using use_cloud_connectors with the new WII env vars.

What is this? | From workflow: Docs Patrol

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

  • expires on Sep 18, 2026, 2:24 PM UTC

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the credential flow in x-pack/libbeat/common/aws/credentials.go:195-220 and the variables in x-pack/libbeat/common/identityfederation/wii.go:29-32. Update the AWS sections in the three listed Filebeat and Metricbeat reference files, including activation, required and optional variables, role_arn, precedence, and a use_cloud_connectors example. Done means all referenced docs consistently describe the WII flow and its environment requirements.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, go
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.