Skip to content

[AWS] Update README - EC2 Instance IAM Role for AWS Authentication - #13434

Merged
zmoog merged 6 commits into
elastic:mainfrom
ecs-chrisg:update-aws-integration-docs
May 20, 2025
Merged

zmoog merged 6 commits into
elastic:mainfrom
ecs-chrisg:update-aws-integration-docs

Conversation

@ecs-chrisg

@ecs-chrisg ecs-chrisg commented Apr 6, 2025 •

Copy link
Copy Markdown
Contributor

Proposed commit message

Update AWS readme - Add a subsection to the AWS Credentials section explaining how to use an EC2 instance's IAM role for AWS authentication.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@ecs-chrisg
ecs-chrisg marked this pull request as ready for review April 6, 2025 02:30
@ecs-chrisg
ecs-chrisg requested review from a team as code owners April 6, 2025 02:30
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@elastic-sonarqube

Copy link
Copy Markdown

@andrewkroh andrewkroh added Integration:aws AWS Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] labels Apr 7, 2025

@bturquet bturquet left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ecs-chrisg

Copy link
Copy Markdown
Contributor Author

@bturquet Thanks! Should I update changelog.yml and manifest.yml to make this PR version 3.3.1?

@zmoog

zmoog commented May 7, 2025 •

Copy link
Copy Markdown
Contributor

@bturquet Thanks! Should I update changelog.yml and manifest.yml to make this PR version 3.3.1?

Hey @ecs-chrisg, yes, we should always add new changes on top of the latest ones first.

If we need to support previous stack versions (e.g., 8.15.x), we can backport the change. However, adding it as the latest is fine since this is a pure-docs change.

Once merged, these changes will be available at https://www.elastic.co/docs/reference/integrations/aws/ and Kibana versions matching:

conditions:
  kibana:
    version: "~8.16.6 || ~8.17.4 || ^8.18.0 || ^9.0.0"

So a user on 8.15 or earlier stack versions will not see the updated docs in Kibana.

@ecs-chrisg

Copy link
Copy Markdown
Contributor Author

@zmoog Makes sense! Newer versions of the integration keep getting merged to main in the time since this PR was opened, so I have to keep updating this integration's version # to stay up to date. I just updated manifest.yml and changelog.yml to 3.3.2.

@zmoog

zmoog commented May 20, 2025 •

Copy link
Copy Markdown
Contributor

In the packages/aws/manifest.yml file:

  • version is the actual integration version.
  • format_version is the package-spec version this integration uses.

The two accidentally had almost the same values, creating an ambiguity.

For example, if we bump the integration version to 3.3.2, there must be an entry for 3.3.2 at the top of the changelog.yml file

@zmoog
zmoog enabled auto-merge (squash) May 20, 2025 07:19
@elastic-sonarqube

Copy link
Copy Markdown

@zmoog
zmoog merged commit e9682b7 into elastic:main May 20, 2025
@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package aws - 3.3.2 containing this change is available at https://epr.elastic.co/package/aws/3.3.2/

anupratharamachandran pushed a commit to anupratharamachandran/integrations that referenced this pull request Jun 2, 2025
…lastic#13434)

Update AWS readme - Add a subsection to the AWS Credentials section explaining how to use an EC2 instance's IAM role for AWS authentication.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Integration:aws AWS Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[aws] Improve documentation on using EC2 IAM Role directly

5 participants