Skip to content

Commit 336145b

Browse files
authored
Documentation updates (#850)
1 parent f7b98a2 commit 336145b

File tree

4 files changed

+99
-80
lines changed

4 files changed

+99
-80
lines changed

docs-source/spring/content/_index.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Oracle Backend for Spring Boot and Microservices"
3-
description: "Spring SpringBoot Spring Boot"
4-
keywords: "spring springboot"
3+
description: "Spring and Spring Boot"
4+
keywords: "spring springboot microservices development oracle backend"
55
---
66

77
Oracle Backend for Spring Boot and Microservices allows developers to build microservices in Spring Boot and provisions a "backend as a service" with
@@ -23,43 +23,42 @@ To learn more, watch this short introductory video:
2323
In addition to an Oracle Autonomous Database Serverless instance, the following software components are deployed in an Oracle Cloud
2424
Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
2525

26-
- Apache APISIX API Gateway and Dashboard
27-
- Apache Kafka
28-
- Coherence
29-
- Conductor Server
30-
- Grafana
31-
- HashiCorp Vault
32-
- Jaeger
33-
- Apache Kafka
26+
- [Apache APISIX API Gateway and Dashboard](platform/apigw/)
27+
- [Apache Kafka](https://kafka.apache.org/)
28+
- [Grafana](observability/metrics/)
29+
- [HashiCorp Vault](platform/vault/)
30+
- [Jaeger](observability/tracing/)
31+
- [Apache Kafka](https://kafka.apache.org)
3432
- Loki
35-
- Netflix Conductor
36-
- OpenTelemetry Collector
37-
- Oracle Autonomous Database Serverless
38-
- Oracle Backend for Spring Boot Command Line Interface (CLI)
39-
- Oracle Backend for Spring Boot Visual Studio Code Plugin
40-
- Oracle Database Operator for Kubernetes (OraOperator or the operator)
33+
- [Netflix Conductor](platform/conductor/)
34+
- [OpenTelemetry Collector](observability/tracing/)
35+
- [Oracle Autonomous Database Serverless](database/)
36+
- [Oracle Backend for Spring Boot Command Line Interface (CLI)](development/cli/)
37+
- [Oracle Backend for Spring Boot Visual Studio Code Plugin](platform/vscode-plugin/)
38+
- [Oracle Coherence](https://docs.oracle.com/en/middleware/standalone/coherence/)
39+
- [Oracle Database Operator for Kubernetes (OraOperator or the operator)](https://github.com/oracle/oracle-database-operator)
4140
- Oracle Database Observability Exporter
42-
- Oracle Transaction Manager for Microservices (MicroTx)
41+
- [Oracle Transaction Manager for Microservices (MicroTx)](platform/microtx/)
4342
- Parse and Parse Dashboard (Optional)
44-
- Prometheus
43+
- [Prometheus](observability/metrics/)
4544
- Promtail
46-
- Spring Boot Admin dashboard
47-
- Spring Cloud Config server
48-
- Spring Cloud Eureka service registry
49-
- Spring Operations Center
45+
- [Spring Boot Admin dashboard](platform/spring-admin/)
46+
- [Spring Cloud Config server](platform/config/)
47+
- [Spring Cloud Eureka service registry](platform/eureka/)
48+
- [Spring Operations Center](platform/soc/)
5049
- Strimzi Kafka Operator
5150

5251
Developers also have access to development or build time services and libraries including:
5352

54-
- A command-line interface (CLI) to manage service deployment and configuration, including database schema management.
55-
- Visual Studio Code (VS Code) plugin to manage service deployment and configuration.
53+
- A command-line interface [(CLI)](development/cli/) to manage service deployment and configuration, including database schema management.
54+
- [Visual Studio Code (VS Code) plugin](platform/vscode-plugin/) to manage service deployment and configuration.
5655
- Spring Data (Java Persistence API (JPA) and Oracle JDBC) to access Oracle Database.
5756
- Oracle Java Database Connectivity (Oracle JDBC) drivers.
58-
- Spring Cloud Config client.
59-
- Spring Eureka service discovery client.
60-
- Spring Cloud OpenFeign.
61-
- OpenTelemetry Collector (including automatic instrumentation).
62-
- Spring Starters for Oracle Universal Connection Pool (UCP), Oracle Wallet, Oracle Advanced Queuing (AQ), and Transactional Event Queues (TxEventQ).
57+
- [Spring Cloud Config client](platform/config/).
58+
- [Spring Eureka service discovery client](platform/eureka/).
59+
- [Spring Cloud OpenFeign](https://spring.io/projects/spring-cloud-openfeign).
60+
- [OpenTelemetry Collector (including automatic instrumentation)](observability/tracing/).
61+
- [Spring Starters for Oracle Universal Connection Pool (UCP), Oracle Wallet, Oracle Advanced Queuing (AQ), and Transactional Event Queues (TxEventQ)](starters/).
6362

6463
## Learn more, try it out with CloudBank!
6564

docs-source/spring/content/infrastructure/_index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Infrastructure Details
1+
---
2+
title: "Infrastructure"
3+
description: "Infrastructure Oracle Backend for SPring Boot and Microservices"
4+
keywords: "infrastructure spring springboot microservices development oracle backend"
5+
---
6+
7+
## Infrastructure Architecture
28

39
![Infrastructure](infra_diagram.png "Overall Infrastructure")
410

@@ -81,7 +87,6 @@ Object Storage offers reliable and cost-efficient data durability, it provides q
8187
### Registry
8288

8389
Oracle Cloud Infrastructure Registry is an Oracle-managed registry that enables you to simplify your development-to-production workflow. Registry makes it easy for you to store, share, and manage development artifacts, like Docker images. The highly available and scalable architecture of Oracle Cloud Infrastructure ensures that you can deploy and manage your applications reliably.
84-
---
8590

8691
## Recommendations
8792

@@ -101,12 +106,12 @@ Web Application Firewall (WAF) protects applications from malicious and unwanted
101106

102107
### ATP CPU Auto-Scaling (Chargeable)
103108

104-
It is recommend to leave auto-scaling enabled; this will allow the increase and decrease of the databases CPU and I/O resources. Use Apache JMeter to load test functional behaviour and measure the performance.
109+
It is recommend to leave auto-scaling enabled; this will allow the increase and decrease of the databases CPU and I/O resources. Use Apache JMeter to load test functional behavior and measure the performance.
105110

106111
### Autonomous Data Guard (Chargeable)
107112

108113
Autonomous Data Guard monitors the primary database and if the Autonomous Database instance goes down, then the standby instance assumes the role of the primary instance adding additional fault tolerance.
109114

110115
### Data Catalog (Chargeable)
111116

112-
OCI Data Catalog is a fully managed, self-service data discovery and governance solution for your enterprise data. Data Catalog provides a single collaborative environment to manage technical, business, and operational metadata.
117+
OCI Data Catalog is a fully managed, self-service data discovery and governance solution for your enterprise data. Data Catalog provides a single collaborative environment to manage technical, business, and operational metadata

0 commit comments

Comments
 (0)