Skip to content

Commit

Permalink
Documentation updates (#850)
Browse files Browse the repository at this point in the history
  • Loading branch information
andytael authored Mar 1, 2024
1 parent f7b98a2 commit 336145b
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 80 deletions.
57 changes: 28 additions & 29 deletions docs-source/spring/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Oracle Backend for Spring Boot and Microservices"
description: "Spring SpringBoot Spring Boot"
keywords: "spring springboot"
description: "Spring and Spring Boot"
keywords: "spring springboot microservices development oracle backend"
---

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

- Apache APISIX API Gateway and Dashboard
- Apache Kafka
- Coherence
- Conductor Server
- Grafana
- HashiCorp Vault
- Jaeger
- Apache Kafka
- [Apache APISIX API Gateway and Dashboard](platform/apigw/)
- [Apache Kafka](https://kafka.apache.org/)
- [Grafana](observability/metrics/)
- [HashiCorp Vault](platform/vault/)
- [Jaeger](observability/tracing/)
- [Apache Kafka](https://kafka.apache.org)
- Loki
- Netflix Conductor
- OpenTelemetry Collector
- Oracle Autonomous Database Serverless
- Oracle Backend for Spring Boot Command Line Interface (CLI)
- Oracle Backend for Spring Boot Visual Studio Code Plugin
- Oracle Database Operator for Kubernetes (OraOperator or the operator)
- [Netflix Conductor](platform/conductor/)
- [OpenTelemetry Collector](observability/tracing/)
- [Oracle Autonomous Database Serverless](database/)
- [Oracle Backend for Spring Boot Command Line Interface (CLI)](development/cli/)
- [Oracle Backend for Spring Boot Visual Studio Code Plugin](platform/vscode-plugin/)
- [Oracle Coherence](https://docs.oracle.com/en/middleware/standalone/coherence/)
- [Oracle Database Operator for Kubernetes (OraOperator or the operator)](https://github.com/oracle/oracle-database-operator)
- Oracle Database Observability Exporter
- Oracle Transaction Manager for Microservices (MicroTx)
- [Oracle Transaction Manager for Microservices (MicroTx)](platform/microtx/)
- Parse and Parse Dashboard (Optional)
- Prometheus
- [Prometheus](observability/metrics/)
- Promtail
- Spring Boot Admin dashboard
- Spring Cloud Config server
- Spring Cloud Eureka service registry
- Spring Operations Center
- [Spring Boot Admin dashboard](platform/spring-admin/)
- [Spring Cloud Config server](platform/config/)
- [Spring Cloud Eureka service registry](platform/eureka/)
- [Spring Operations Center](platform/soc/)
- Strimzi Kafka Operator

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

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

## Learn more, try it out with CloudBank!

Expand Down
13 changes: 9 additions & 4 deletions docs-source/spring/content/infrastructure/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Infrastructure Details
---
title: "Infrastructure"
description: "Infrastructure Oracle Backend for SPring Boot and Microservices"
keywords: "infrastructure spring springboot microservices development oracle backend"
---

## Infrastructure Architecture

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

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

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.
---

## Recommendations

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

### ATP CPU Auto-Scaling (Chargeable)

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.
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.

### Autonomous Data Guard (Chargeable)

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.

### Data Catalog (Chargeable)

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.
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
Loading

0 comments on commit 336145b

Please sign in to comment.