Skip to content

Commit 6cc4db8

Browse files
authored
update readme (#103)
* update readme --------- Signed-off-by: Mark Nelson <mark.x.nelson@oracle.com>
1 parent 03df6e2 commit 6cc4db8

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
# Spring Cloud Oracle
22

3-
Spring Cloud Oracle facilitates the integration of Oracle Database and Oracle Cloud Infrastructure (OCI) with Spring Boot. Spring Cloud Oracle contains autoconfiguration support for Oracle Database and OCI-managed services.
3+
Many Oracle customers make extensive use of Spring in their environments. They use Oracle Database and Oracle Cloud Infrastructure (OCI) services. Oracle Database is available in OCI, Azure, GCP and AWS, making it truly a multi-cloud database, and on-premises including in containers and Kubernetes. Oracle is trusted by many of the world’s top businesses, governments and other organizations to protect their most sensitive data.
44

5-
Spring Cloud Oracle artifacts are made available through Maven Central. With Spring Cloud Oracle, developers may add annotations and a small number of configuration parameters to connect Spring Cloud applications to Oracle Database and OCI services.
5+
*Spring Cloud Oracle* provides tools and services to integrate Oracle Cloud Infrastructure and Software with the Spring ecosystem in an idiomatic and flexible manner. It is designed to simplify microservices development that uses Oracle Database, middleware, and messaging on Oracle and non-Oracle clouds as well as on-premises.
66

7-
The following projects are supported through Spring Cloud Oracle:
7+
Spring Cloud Oracle 1.2.0 is the most recent release which brings together in one place Spring Boot Starters, autoconfiguration and sample code for Oracle Database and OCI services.
8+
9+
Spring Cloud Oracle goes beyond simply wrapping the OCI APIs in starters and adds idiomatic ways to integrate with Spring including for example the ability to use OCI Vault as a Spring Property Source and OCI Object Storage as a Spring Resource provider. We also provide Spring CLI integration with a project catalog to help you create Spring Boot projects using Oracle.
10+
11+
The following sub-projects are included in Spring Cloud Oracle:
812

913
| Project | Description |
1014
|-----------------------------------------------------------------------|---------------------------------------------------------|
1115
| [Spring Cloud OCI](./spring-cloud-oci/README.md) | Use OCI services with well-known Spring idioms and APIs |
1216
| [Oracle Database Spring Boot Starters](./database/starters/README.md) | Integrate Oracle Database with Spring Boot |
1317

18+
## Some key features
19+
20+
- Compatible with Spring Boot 3.2 and 3.3
21+
- Support for several common OCI services including Object Storage, Functions, Logging, Notifications, Queues, Streaming, Email Delivery, Vault, Autonomous Database and Generative AI (for embeddings and inferencing)
22+
- Improved autoconfiguration for Spring Boot Starters for Oracle Database, and support for Oracle Database 23ai
23+
- OCI service components are built on top of OCI SDK for Java and a core module provides OCI configuration and authentication support
24+
25+
1426
## Documentation
1527

16-
For a deep dive into the project, refer to the Spring Cloud Oracle documentation:
28+
We encourage you to learn more in the Spring Cloud Oracle documentation:
1729

1830
| Version | Reference Docs | API Docs |
1931
|---------------------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
@@ -22,6 +34,21 @@ For a deep dive into the project, refer to the Spring Cloud Oracle documentation
2234
| Spring Cloud Oracle 1.1.0 | [Reference Docs](https://oracle.github.io/spring-cloud-oracle/1.1.0/reference/html/index.html) | [API Docs](https://oracle.github.io/spring-cloud-oracle/1.1.0/javadocs/index.html) |
2335
| Spring Cloud Oracle 1.2.0 | [Reference Docs](https://oracle.github.io/spring-cloud-oracle/1.2.0/reference/html/index.html) | [API Docs](https://oracle.github.io/spring-cloud-oracle/1.2.0/javadocs/index.html) |
2436

37+
Additionally, you can explore sample applications for each module in the [samples directory](https://github.com/oracle/spring-cloud-oracle/tree/main/spring-cloud-oci/spring-cloud-oci-samples).
38+
39+
## Roadmap
40+
41+
Spring Cloud Oracle has a strong and constantly evolving roadmap as we work to provide comprehensive up-to-date coverage. Right now, we are working on the following updates:
42+
43+
- Spring Cloud Stream Binder for Oracle Transactional Event Queues
44+
- A Spring Boot Starter for JSON Collections in the Oracle Database
45+
- OpenRewrite recipes to ease migration from HikariCP to Oracle Universal Connection Pool
46+
- Further simplification of running Spring Boot applications as OCI Functions, including as native images using GraalVM Native Image compilation
47+
- Further improvement of the idiomaticity of OCI Service modules and the expansion of adoption of the Spring Template pattern
48+
- Additional Spring CLI project templates and example applications, particularly in the Spring AI space, focusing on retrieval augmented generation and agentic use cases
49+
50+
We’d love to hear from you! Please let us know about your experiences using Spring Cloud Oracle, and what else you would like to see supported by opening an issue in our GitHub repository.
51+
2552
## Contributing
2653

2754
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)