search

Kralizek / AWSSecretsManagerConfigurationExtensions

This repository contains a provider for Microsoft.Extensions.Configuration that retrieves secrets stored in AWS Secrets Manager.
MIT License
219 stars 43 forks source link

Update README to include EKS #69

Closed OliverRC closed 2 years ago

OliverRC commented 2 years ago

The IAM roles for Service Accounts feature was added to allow EKS pods to talk to AWS Secret Manager using a Service Account. This allows roles to be used natively in EKS. https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-minimum-sdk.html

However, the library was using a very old version of the AWS SDK that did not support this.

I wasn't quite sure if I should go with the lowest version where this feature was added or the latest SDK. I am open to feedback and can alter the PR if necessary.

It is kind of hard to backtrack to what exact version of AWSSDK.SecretsManager is the minimum version as they only list the minimum SDK version which is not on the same version numbers. https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-minimum-sdk.html

I also tried to provide some guidance on the EKS side of things as an additional library is required.

Kralizek commented 2 years ago

@OliverRC did you check the issue sticked on top? It explains how to use this library with a later version of the SDK.

As I'm not willing to release a new version for a package update, I'd be willing to accept a PR on the README that explains how to use this package in EKS.

OliverRC commented 2 years ago

@Kralizek no I didn't, thank you so much. I'll modify the PR to just include the README for now then.

I do feel at some point it would make sense to do a release with a more recent SDK version so isn't required to go outside the dependency chain.

Kralizek commented 2 years ago

@OliverRC I agree, but until there is no breaking change from AWS or in the API of this library, it's better this way.

OliverRC commented 2 years ago

I have removed the changes to the SDK versions and just left the changes to the README.