[Epic] Spring Cloud for Azure 4.0

[chenrujun]

Design Doc

• Spring Cloud for Azure 4.0 general design  #23920
• Design for a core module. Spring Cloud for Azure 4.0 Core
• Write design doc of level 1 azure spring cloud starter #23624
• Write design doc for azure-spring-messaging #23691
• Write design doc for azure-spring-cloud stream #23693
• Write design doc for azure-spring-integration #23690
• Write design doc for azure-spring-security-oauth2 #23369

Beta release

Things has to be done within our Beta Release:

• Release Spring Cloud for Azure 4.0.0-beta.2 #24260

Project structure

• A separate resource-manager module, which is optional, and when provided, could bring the ability to provision resources.
• Merge all auto configure into azure-spring-cloud-autoconfigure #24330
• Split spring cloud actuator module into a standalone module #23930
• Implement azure-spring-cloud-core #24329
• Combine two Spring boms into one, spring-cloud-azure-dependencies. #24812

Maven Artifact

• Change all Spring Cloud Azure related modules' artifact id to spring-cloud-azure-xxx #23931
• Rename artifact to spring-cloud-azure-starter-servicebus-jms. #24360
• Review the artifact names and their dependencies before release #24722

Improve Azure SDK Configuration support

• Epic - Unify and complete configurations for all Azure Spring starters on top of Azure SDKs #23421
  • Unify Azure SDK configurations setup in all Azure Spring starters #21972
  • [FEATURE REQ] Enable/disable azure-spring-boot auto configurations based on properties #23367
  • Support configure proxy #21552
  • Support configure retry in spring cloud azure 4.0 #24754 Support configure retry.
  • Spring Cloud Azure 4.0 should support to configure HttpClient, HttpPipeline, HttpPipelinePolicy, and HttpClientOptions for all Http protocol clients. #25221
  • Support configure logging level for HTTP requests. #24656
  • [FEATURE REQ] Ability to set AmqpRetryOptions in EvenHub connection #16596
  • [BUG]azure-spring-cloud-starter-eventhubs-kafka2.4.0 example china tenant id not working #21336
  • [Spring]Support to config different Azure clouds than Azure public #21593
  • Spring Cloud Azure 4.0 should enable configuring HTTP-related options underneath any TokenCredential #25223
  • Spring Cloud Azure 4.0 should enable configuring executor service underneath any TokenCredential #25222
• Allow auto-configure separate Event Hub consumer and producer in different namespaces. #24658
• Allow auto-configure separate Service Bus consumer and producer in different namespaces. #24659
• Make sure Spring libraries pick up the ENV used by azure-core/SDK. #24657

Improve Authentication

• Support TokenCredential for all SDK client auto-configuration
  • Integrate TokenCredential supported by #21472 with Azure Spring Storage/Database libs #21486
  • Integrate TokenCredential supported by #21472 with Azure Spring Messaging libs #22704
  • Integrate TokenCredential supported by #21472 with Azure Spring App Config libs #22706
• Support other authentication methods than TokenCredential for all SDK client auto-configuration
  • Support Azure Database/Storage SDK dedicated authentication methods in Azure Spring Database/Storage libs #22707
  • Support Azure Security SDK dedicated authentication methods in Azure Spring Security libs #22708
  • Support Azure Messaging SDK dedicated authentication methods in Azure Spring Messaging libs #22709
  • Support Azure AppConfig SDK dedicated authentication methods in Azure Spring App Config libs #22710

Production Ready Feature

Health Indicator

• [FEATURE REQ] Provide a health indicator for Service Bus Spring starter #21976
• Implement health indicators for database and storage components #21977
• Implement health indicators for security components #21979
• Health Indicators for App Config. #25225

Tracing

• Define the scopes of Spring Observability - Tracing #21969

Messaging

• Drop RXJava and CompletableFuture support from azure-spring-integration module #22755
• Design and implemention for Azure Spring Cloud Messaging 4.0 #23919
• Make azure-spring-boot-starter-servicebus-jms follow design doc. #23688
• Refactor spring-cloud-azure-messaging-eventhubs, integration, and binder to support configure each eventhub separately #25192
• Refactor spring-cloud-azure-messaging-servicebus, integration, and binder to support configure each queue/topic separately #25191
• Spring Cloud Azure 4.0 Refactor the health indicator of event hubs binder. #25226
• Feature/batch consumer #25363

Security

• Implement azure-spring-security 4.0 #23710
  • Delete azure-spring-boot-starter-active-directory-b2c related content #23932
  • Delete un-supported AAD features. #23922
  • Delete beans which should not configured in azure-spring-cloud-autoconfigure #23942
  • Implement spring-security-azure-oauth2-client 4.0 #24353

Docs + Samples + Misc

• Create sample projects for 4.0 related modules. #24334
  • Create sample for spring-security-azure-oauth2-client #24336
  • Create sample for resource-server with native spring-security #24335
• Write migration guide for every module #24351
  • Write migration guide for azure-spring-cloud-starter #24403
  • Write migration guide for azure-spring-boot-starter-cosmos #24394
  • Write migration guide for azure-spring-boot-starter-storage #24397
  • Write migration guide for azure-spring-cloud-starter-cache #24399
  • Write migration guide for azure-spring-boot-starter-servicebus-jms  #24396
  • Write migration guide for azure-spring-cloud-starter-eventhubs-kafka #24400
  • Write migration guide for azure-spring-cloud-starter-eventhubs  #24401
  • Write migration guide for azure-spring-cloud-starter-servicebus  #24402
  • Write migration guide for azure-spring-boot-starter-active-directory #24393
  • Write migration guide for azure-spring-boot-starter-keyvault-certificates #24395

Clean up starter module, to make it does dependency management only

• Delete README and CHANGELOG in azure-spring-boot-starter-xxx #23926
• Move readme from starter module into it's content module and update accordingly. #23938
  • Move readme from starter module into it's content module for azure-spring-cloud-starter #24392
  • Move readme from starter module into it's content module for azure-spring-boot-starter-cosmos #24384
  • Move readme from starter module into it's content module for azure-spring-boot-starter-storage #24387
  • Move readme from starter module into it's content module for azure-spring-cloud-starter-cache #24388
  • Move readme from starter module into it's content module for spring-security-azure-oauth2-client #24357
  • Move readme from starter module into it's content module for azure-spring-boot-starter-keyvault-certificates #24385
  • Move readme from starter module into it's content module for azure-spring-boot-starter-servicebus-jms #24386
  • Move readme from starter module into it's content module for azure-spring-cloud-starter-eventhubs-kafka #24389
  • Move readme from starter module into it's content module for azure-spring-cloud-starter-eventhubs #24390
  • Move readme from starter module into it's content module for azure-spring-cloud-starter-servicebus #24391

---

GA release

GA Exit Criteria

• Other features
  • [FEATURE REQ] In aad-starter support properties like spring.cloud.azure.tenant-id #25646
• Test spring modules support both spring-boot 2.5 and spring-boot 2.6 in spring-ci pipeline #25663
• Doc @chenrujun
  • Go through whole reference doc and fix errors microsoft/spring-cloud-azure#783
  • Go through whole migration guide and fix errors microsoft/spring-cloud-azure#784
  • Prepare Release Notes / Change Log for Spring Cloud Azure 4.0 microsoft/spring-cloud-azure#785
  • Update MS docs: Spring Cloud Azure 4.0 Azure-Samples/azure-spring-boot-samples#95
  • [Epic] Update MS docs: Spring Cloud Azure 4.0 #26307
• Blog @seanli1988
• Sample @backwind1233
  • All migrated to 4.0 GA (including petclinic) #25651
  • Migrated to use DefaultCredential if possible #25652
• Update spring libraries in start.spring.io after 4.0 GA #25683
• Upgrade spring-boot to 2.6.1, and upgrade external dependencies #25697 @hui1110
• Intellij tools azure plugin udpate for 4.0GA #25684
• [Epic] Improve java doc's quality. #24332
  • Improve java doc's quality for Fundamental modules #24409
  • Improve java doc's quality for Messaging modules #24410
  • Improve java doc's quality for Storage + Database modules #24411
  • Improve java doc's quality for Security modules #24412
    • Ensure all public class have well-formatted java doc in spring-security-azure-oauth2-client #24359
• Refactor Spring Cloud for Azure testing projects structure #23773
  • Move IT in azure-spring-boot-test-jms into azure-spring-cloud-autoconfigure #24354
  • Move IT modules for spring cloud for azure messaging into the source code module #24363
• Confusing version compatibility indications for Spring Boot starters #24469
• Spring Cloud Azure 4.0 Make sure no credential information required when using our first party SDKs, leverage DefaultTokenCredential to support both dev / prod (MSI) enabled environment. #25224
• [FEATURE REQ] Add more items in pom.xml for spring related modules. #25054
• [Epic] Spring Cloud Azure 4.0 API review  #27112
• [Epic] API review for each module #24356
  • API review for Fundamental modules #24413
  • API review for Messaging modules #24414
  • API review for Storage + Database modules #24415
  • API review for Security modules #24416
• Make sure telemetry is correctly sent and collected in Spring Cloud Azure 4.0 #25892
• Add automatic module names for Spring Cloud Azure modules #27350
• Make sure telemetry is correctly sent and collected in Spring Cloud Azure 4.0 #25892
• [BUG] UserAgent in spring-cloud-azure-core will be overrided by user defined project.properties #27303
• [Epic] Spring Cloud Azure 4.0 - All samples can work correctly #27480
• Reference docs are up to date.
• Make sure Spring Cloud Azure 4.0 Manged identity can work correctly, both user-assigned and system assigned #27492
• [Epic] Spring Cloud Azure 4.0 - Migration guide is correct #27481

Release

• Release Spring Cloud Azure 4.0.0-beta.3 #26300
• Release Spring Cloud Azure 4.0.0 #24327
• Merge feature/azure-spring-cloud-4.0 into main branch. #24362

---

Post GA

• [FEATURE REQ] Make azure-security-keyvault-jca support configuring by Spring Cloud Azure global properties. #19696
• [FEATURE REQ] Enable batch-sending for spring cloud stream eventhubs binder #25228
• Split spring directory into mutiple secondary directories #24369
• Integrate TokenCredential supported by #21472 with Azure Spring Security libs #22705
• [FEATURE REQ] Provide a health indicator for Service Bus Spring starter #21976
• Update version and screenshot in MS docs. MS docs about spring framework #25698
• Update version in azure-spring-boot-samples. Sample PR: azure-spring-boot-samples#62. #25699
• Update related wiki pages: Spring-Support-Multiple-Versions.md, Spring-Versions-Mapping.md. #25700

Metrics

• [FEATURE REQ] Enhance metrics for Azure Spring Event Hubs #21764
• [FEATURE REQ] Add metrics for Azure Spring Service Bus #23400

Ensure test coverage

• Ensure test coverage for each class #24333
  • Ensure test coverage for Fundamental modules #24405
  • Ensure test coverage for Messaging modules @moary #24406
  • Ensure test coverage for Storage + Database modules #24407
  • Ensure test coverage for Security modules #24408
    • Ensure test coverage in spring-security-azure-oauth2-client #24358

[saragluna]

Closing this issue now, the post-ga part will be logged in #28000.