spring-cloud-aws icon indicating copy to clipboard operation
spring-cloud-aws copied to clipboard

Version 3.x and aws.paramstore.* properties. Documentation is highly unclear.

Open timo-eloranta opened this issue 1 year ago • 7 comments

Type: Bug

Component: Parameter Store

Describe the bug We are trying to migrate several applications from Spring Cloud AWS 2.4.4 to 3.0.x.

Based on the announcement (https://spring.io/blog/2023/05/02/announcing-spring-cloud-aws-3-0-0) and documentation (https://docs.awspring.io/spring-cloud-aws/docs/3.0.3/reference/html/index.html#spring-cloud-aws-parameter-store) we understand that a lot has changed. However, our greatest issue at the moment is that due to the Migration Guide being "work in progress" (https://docs.awspring.io/spring-cloud-aws/docs/3.0.3/reference/html/index.html#migration-from-2-x-to-3-x), it is quite difficult to find out exactly what all features have been removed.

In order to make this ticket's scope well defined, I'll limit to the aws.paramstore.* parameters, which are well documented for the 2.4.4 version here: https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/reference/html/index.html#integrating-your-spring-cloud-application-with-the-aws-parameter-store (2nd table, with 7 properties explained).

From https://docs.awspring.io/spring-cloud-aws/docs/3.0.3/reference/html/index.html#migration-from-2-x-to-3-x I can find one of these properties, aws.paramstore.region, which has apparently been renamed as spring.cloud.aws.parameterstore.region.

From https://docs.awspring.io/spring-cloud-aws/docs/3.0.3/reference/html/appendix.html I can find 5 properties related to spring.cloud.aws.parameterstore.* , but none of these seem to match these 6 properties from version 2.x: aws.paramstore.prefix, aws.paramstore.defaultContext, aws.paramstore.profileSeparator, aws.paramstore.failFast, aws.paramstore.name and aws.paramstore.enabled.

If these 6 properties are indeed now obsolete in version 3.x, then I feel this should definitely be mentioned in the Migration Guide.

timo-eloranta avatar Nov 17 '23 12:11 timo-eloranta

Yes, we are aware that migration guide is missing. Long story short - in 2.x there were a lot of conventions based on properties, in 3.x you must be explicit about the path you want to import.

maciejwalkowiak avatar Nov 17 '23 18:11 maciejwalkowiak

@maciejwalkowiak - Understood. However, can you straight away confirm that the above listed 6 aws.paramstore.* properties no more have significance in 3.x? Having this confirmed would reduce unclarity and help us in cleaning existing configurations.

timo-eloranta avatar Nov 20 '23 07:11 timo-eloranta

Yes, that's correct. You're welcome to submit a PR to documentation with an update to migration guide.

maciejwalkowiak avatar Nov 20 '23 14:11 maciejwalkowiak

@maciejwalkowiak - Thank you for confirming the situation regarding the old aws.paramstore.* properties. I assume the situation is identical with the aws.secretsmanager.* properties listed here: https://docs.awspring.io/spring-cloud-aws/docs/2.4.4/reference/html/index.html#integrating-your-spring-cloud-application-with-the-aws-secrets-manager ?

timo-eloranta avatar Nov 28 '23 07:11 timo-eloranta

@timo-eloranta correct, same for Secrets Manager

maciejwalkowiak avatar Dec 01 '23 06:12 maciejwalkowiak

@timo-eloranta correct, same for Secrets Manager

Is it planned to put this functionality back inside? So is it planned to be able to import: aws-secretsmanager: and this loads by default all properties matching /prefix/application, /prefix/application_profile and so on?

Bene98 avatar Jun 18 '24 11:06 Bene98