Skip to content

AWS external secrets docs#1481

Open
jroper wants to merge 1 commit intoakka:mainfrom
jroper:aws-external-secrets-docs
Open

AWS external secrets docs#1481
jroper wants to merge 1 commit intoakka:mainfrom
jroper:aws-external-secrets-docs

Conversation

@jroper
Copy link
Copy Markdown
Contributor

@jroper jroper commented Apr 2, 2026

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
Copy link
Copy Markdown
Member

@janikdotzel janikdotzel left a comment

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?

|Field |Type |Description

|*name* |string _required_ |The name of the object. For Secrets Manager this is the SecretId parameter and can either be the friendly name or full ARN of the secret. For SSM Parameter Store, this is the name of the parameter and can be either the name or full ARN of the parameter.
|*type* |string |The ID of the tenant that the KeyVault is in. Optional if an ARN was specified in name, required otherwise.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this be a copy-paste mistake?

The ID of the tenant that the KeyVault is in.

After checking the akka_secrets_external_create_aws.adoc file, I'd recommend replacing it with something like

The type of the object, either secretsmanager or ssmparameter.


[source, command window]
----
export AKKA_OIDC_ISSUER=$(akka secrets external info -o go-template='{{(index .Items 0).WorkloadIdentity.Aws.OidcIssuer}}'}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

export AKKA_OIDC_ISSUER=$(akka secrets external info -o go-template='{{(index .Items 0).WorkloadIdentity.Aws.OidcIssuer}}'}

There's a } at the end. It should be a ) instead:

export AKKA_OIDC_ISSUER=$(akka secrets external info -o go-template='{{(index .Items 0).WorkloadIdentity.Aws.OidcIssuer}}')


[source, command window]
----
akka service deploy $AKKA_SERVICE_NAME
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we add a \ at the end of the first line. My Shell executed akka service deploy $AKKA_SERVICE_NAME alone, then failed on the second line.

--
CLI::
+
Use the `akka secret external aws create` command.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The PR uses:

  • akka secret external aws create
  • akka secret external aws update

The CLI reference (akka_secrets_external_create_aws.adoc) documents:

  • akka secrets external create aws
  • akka secrets external update aws

[source, command line]
----
akka secret external aws create my-external-secret \ <1>
--object-name arn:aws:secretsmanager::$AWS_ACCOUNT_ID:secret:my-secret-QNTAHI \ <2>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

--object-name arn:aws:secretsmanager::$AWS_ACCOUNT_ID:secret:my-secret-QNTAHI

Secrets Manager is a regional service.
ARNs include the region: arn:aws:secretsmanager:REGION:ACCOUNT_ID:secret:NAME. The region field is empty here. Should likely be:

--object-name arn:aws:secretsmanager:$AWS_REGION:$AWS_ACCOUNT_ID:secret:my-secret-QNTAHI

@jroper
Copy link
Copy Markdown
Contributor Author

jroper commented Apr 16, 2026

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

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