Skip to content

docs: clarify OpenSearch authentication setup#11924

Open
PSR94 wants to merge 1 commit into
deepset-ai:mainfrom
PSR94:contrib/clarify-opensearch-auth-docs
Open

docs: clarify OpenSearch authentication setup#11924
PSR94 wants to merge 1 commit into
deepset-ai:mainfrom
PSR94:contrib/clarify-opensearch-auth-docs

Conversation

@PSR94

@PSR94 PSR94 commented Jul 9, 2026

Copy link
Copy Markdown

Related Issues

Proposed Changes:

Clarifies that the http_auth value for OpenSearchDocumentStore depends on the deployment type:

  • local Docker uses the OpenSearch admin user and the OPENSEARCH_INITIAL_ADMIN_PASSWORD value from the container setup
  • Amazon OpenSearch Service should use the domain's configured authentication method instead of the local Docker password or IAM console password
  • IAM-based Amazon OpenSearch Service access can use an AWS SigV4 auth object, such as AWSV4SignerAuth, with a link to the OpenSearch Python client documentation

The clarification is added to both the unstable docs page and the latest stable version-2.31 copy.

How did you test it?

  • uvx hatch run pre-commit run --files docs-website/docs/document-stores/opensearch-document-store.mdx docs-website/versioned_docs/version-2.31/document-stores/opensearch-document-store.mdx
  • npm run build from docs-website/
  • git diff --check

Notes for the reviewer

Documentation-only change; no release note is included.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@PSR94 PSR94 requested a review from a team as a code owner July 9, 2026 02:23
@PSR94 PSR94 requested review from bogdankostic and removed request for a team July 9, 2026 02:23
@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

@PSR94 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@bogdankostic

Copy link
Copy Markdown
Contributor

Hi @PSR94, thanks for this PR! Please sign the CLA for me to be able to review and merge it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update authorization in OpenSeachDocumentStore example

3 participants