Skip to content

docs: document 1Password Secrets Automation - #2191

Open
sdelamo wants to merge 1 commit into
5.1.xfrom
paperclip/mng-234-onepassword-docs
Open

docs: document 1Password Secrets Automation#2191
sdelamo wants to merge 1 commit into
5.1.xfrom
paperclip/mng-234-onepassword-docs

Conversation

@sdelamo

@sdelamo sdelamo commented May 22, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a Security Configuration guide page for using 1Password Secrets Automation or 1Password Connect to supply existing Micronaut Security configuration values.
  • Documents OAuth client secret and JWT signing secret placeholder patterns, including Kubernetes secretKeyRef injection.
  • States the scope boundary explicitly: Micronaut Security does not call the 1Password Connect API directly, add a client/cache/retry loop, or capture secrets at build/AOT time.

Fixes #628

Tests

  • ./gradlew publishGuide
  • Rendered output checked for the new 1Password Secrets Automation navigation entry and preserved ${OAUTH_CLIENT_SECRET}, ${JWT_GENERATOR_SECRET}, and ${JWT_GENERATOR_SECRET_BASE64} placeholders.

PR Assets

Release Targeting

  • Target branch: 5.1.x
  • Target release: 5.1.0
  • Micronaut organization project selected by QA: 5.1.0 Release (Throw an error if multiple annotations are used. #147)
  • Live project linkage: project Throw an error if multiple annotations are used. #147 exists, but this run could not apply the PR-to-project association. gh project item-add 147 --owner micronaut-projects returned unknown owner type; the direct GraphQL addProjectV2ItemById fallback returned INSUFFICIENT_SCOPES because the token lacks the project scope.
  • Type label: type: enhancement

✨ This message was AI-generated using gpt-5

Copilot AI review requested due to automatic review settings May 22, 2026 09:56
@sdelamo sdelamo added the type: enhancement New feature or request label May 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds documentation describing how to use 1Password Secrets Automation (or 1Password Connect) to supply Micronaut Security secrets via standard configuration injection, without adding a 1Password client to the application.

Changes:

  • Adds a new guide page explaining 1Password-based secret lifecycle + runtime injection patterns
  • Documents placeholder usage for OAuth client secrets and JWT signing secrets (including Kubernetes secretKeyRef)
  • Adds the new page to the security configuration guide TOC

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/main/docs/guide/toc.yml Adds a navigation entry for the new 1Password Secrets Automation doc page
src/main/docs/guide/securityConfiguration/onePasswordSecretsAutomation.adoc New AsciiDoc guide describing usage patterns and operational boundaries

Comment thread src/main/docs/guide/toc.yml
sdelamo added a commit that referenced this pull request May 22, 2026
@sonarqubecloud

Copy link
Copy Markdown

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

Labels

type: enhancement New feature or request

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Explore integration with 1Password Secrets Automation

2 participants