Skip to content

AWS external secrets docs - #1481

Merged
jroper merged 1 commit into
akka:mainfrom
jroper:aws-external-secrets-docs
Apr 21, 2026
Merged

jroper merged 1 commit into
akka:mainfrom
jroper:aws-external-secrets-docs

Conversation

@jroper

@jroper jroper commented Apr 2, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions github-actions Bot added the documentation documentation related label Apr 2, 2026
@ennru
ennru requested a review from janikdotzel April 2, 2026 09:26

@janikdotzel janikdotzel 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.

@jroper I added a few little comments.

Additionally I wanted to test the full setup by creating my own service with an AWS secret. I found the aws-us-east-2 region in our dev environment, but it doesn't have a workload identity configured. How did you test it?

@jroper

jroper commented Apr 16, 2026

Copy link
Copy Markdown
Contributor Author

Additionally I wanted to test the full setup by creating my own service with an AWS secret. I found the aws-us-east-2 region in our dev environment, but it doesn't have a workload identity configured. How did you test it?

@girdharshubham we still don't have OIDC configuration in aws-us-east-2 on dev. Can we have that added?

@girdharshubham

Copy link
Copy Markdown
Contributor

Additionally I wanted to test the full setup by creating my own service with an AWS secret. I found the aws-us-east-2 region in our dev environment, but it doesn't have a workload identity configured. How did you test it?

@girdharshubham we still don't have OIDC configuration in aws-us-east-2 on dev. Can we have that added?

Done with this PR

@janikdotzel

Copy link
Copy Markdown
Contributor

I deployed a sample service to an aws-us-east-2 project and verified that the external secret was mounted and readable. The feature works correctly πŸ₯³

I encountered two issues during testing though:

1. Missing OIDC provider registration step

The akka secrets external info CLI output includes this command aws iam create-open-id-connect-provider, but the docs don't mention it. Without executing it, I hit an error at the role assumption step.

2. No descriptor field for AWS workload identity role ARN

I haven't found a Service Descriptor YAML field for the AWS role ARN. It could only be set via akka service deploy --aws-workload-identity-role-arn.

@jroper
jroper force-pushed the aws-external-secrets-docs branch from 46b5bee to 90b4c3b Compare April 21, 2026 05:58
@jroper

jroper commented Apr 21, 2026

Copy link
Copy Markdown
Contributor Author

@janikdotzel I've updated the PR based on all your comments, fixing everything that was broken. In addition, I've added/modified all the following docs:

  • Switch from akka secrets external info to akka project regions workload-identity-info, see https://github.com/akka/cli/pull/111.
  • Added descriptor reference documentation for workloadIdentity as well as workloadIdentityToken volume mounts.
  • Added new workload identity documentation page for general workload identity use cases beyond secrets. This was mostly generated by Claude. It repeats a lot of the external secret docs, but that's ok.

This documents how to use AWS external secrets, and also documents workload
identity in general, including adding the new service descriptor features to
the reference documentation, and adding a page on general workload identity
configuration to the docs.
@jroper
jroper force-pushed the aws-external-secrets-docs branch from 90b4c3b to 58a3ea8 Compare April 21, 2026 06:09

@janikdotzel janikdotzel 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.

LGTM.

I just want to mention that I updated my akka cli to 3.0.59 and tried the akka projects regions workload-identity-info command. It isn't available yet.

@jroper
jroper merged commit fb52044 into akka:main Apr 21, 2026
10 checks passed
@jroper
jroper deleted the aws-external-secrets-docs branch April 21, 2026 08:36
@jroper

jroper commented Apr 21, 2026

Copy link
Copy Markdown
Contributor Author

That's right, the PR isn't merged yet.

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

Labels

documentation documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants