Skip to content

docs: clarify that AWS Bedrock requires the optional AWS SDK plugin#211

Merged
shenxianpeng merged 1 commit into
mainfrom
fix/bedrock-provider-missing-from-list
Jul 10, 2026
Merged

docs: clarify that AWS Bedrock requires the optional AWS SDK plugin#211
shenxianpeng merged 1 commit into
mainfrom
fix/bedrock-provider-missing-from-list

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jul 9, 2026

Copy link
Copy Markdown
Member

Description

Closes #210

User report that AWS Bedrock is missing from the AI Provider list (Manage Jenkins → System) after installing/upgrading the plugin.

This is intended behavior, not a defect. AWS Bedrock depends on the AWS SDK v2, which is large, so the aws-java-sdk2-core dependency is deliberately kept optional — otherwise every Explain Error user would carry the AWS SDK even if they never use Bedrock. The Bedrock descriptor is gated on that plugin via @OptionalExtension(requirePlugins="aws-java-sdk2-core"), so it only registers when the AWS SDK plugin is installed. On an instance without it, Bedrock simply doesn't appear (and nothing is logged, because nothing fails).

The gap is that this requirement was not documented, so the provider appears to "vanish" with no guidance. This PR fixes the discoverability rather than forcing the dependency on everyone.

Changes

  • README.md: document that AWS Bedrock requires the optional AWS SDK 2.x plugin (aws-java-sdk2-core), explain why it is optional, and give the install/enable steps.
  • BedrockProviderRegistrationTest: assert the Bedrock descriptor is discoverable via the same mechanism the provider dropdown uses, guarding the descriptor wiring when the AWS SDK dependency is present.

The aws-java-sdk2-core dependency stays optional — no change to what every installation is required to carry.

Related Issues

Testing done

  • Added BedrockProviderRegistrationTest verifying getDescriptorList(BaseAIProvider.class) contains BedrockProvider.DescriptorImpl.
  • Note: the jenkins-test-harness always loads declared plugin dependencies (even optional ones), so the missing-plugin production condition is not reproducible in unit tests. Manual verification on a Jenkins instance without aws-java-sdk2-core pre-installed is recommended.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests that demonstrate the feature works or the issue is fixed

Was generative AI tooling used to co-author this PR?
  • Yes (please specify below)

The AWS Bedrock provider descriptor is gated on the aws-java-sdk2-core
plugin (@OptionalExtension requirePlugins). That dependency is optional by
design so installations that don't use Bedrock are not forced to carry the
AWS SDK. The trade-off is that Bedrock is absent from the AI Provider list
until the AWS SDK plugin is installed, which was not documented.

Document the requirement and the enable steps in the README, and add a
registration test asserting the Bedrock descriptor is discoverable when the
AWS SDK dependency is present.
@shenxianpeng
shenxianpeng force-pushed the fix/bedrock-provider-missing-from-list branch from d2c5751 to c9b3c2e Compare July 9, 2026 16:46
@shenxianpeng shenxianpeng changed the title fix: keep AWS Bedrock selectable by requiring aws-java-sdk2-core docs: clarify that AWS Bedrock requires the optional AWS SDK plugin Jul 9, 2026
@shenxianpeng
shenxianpeng marked this pull request as ready for review July 9, 2026 16:48
@shenxianpeng
shenxianpeng requested a review from a team as a code owner July 9, 2026 16:48
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jul 9, 2026
@shenxianpeng
shenxianpeng merged commit d276709 into main Jul 10, 2026
19 checks passed
@shenxianpeng
shenxianpeng deleted the fix/bedrock-provider-missing-from-list branch July 10, 2026 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unable to Configure AWS Bedrock – Provider Missing from AI Provider List

1 participant