Skip to content

Commit bd599af

Browse files
authored
Doc updates (#903)
Doc updates
1 parent 194e73a commit bd599af

File tree

7 files changed

+109
-51
lines changed

7 files changed

+109
-51
lines changed

docs-source/spring/content/_index.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@ description: "Spring and Spring Boot"
44
keywords: "spring springboot microservices development oracle backend"
55
---
66

7-
Oracle Backend for Spring Boot and Microservices allows developers to build microservices in Spring Boot and provisions a "backend as a service" with
8-
Oracle Database and other infrastructure components that operate on multiple clouds. Oracle Backend for Spring Boot and Microservices vastly simplifies the task of
9-
building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
7+
Oracle Backend for Spring Boot and Microservices allows developers to build microservices in Spring Boot and provisions a "backend as a service" with Oracle Database and other infrastructure components that operate on multiple clouds. Oracle Backend for Spring Boot and Microservices vastly simplifies the task of building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
108

119
 
12-
{{< hint type=[warning] icon=gdoc_fire title="Version 1.1.3 (production) released March, 2024" >}}
13-
Oracle Backend for Spring Boot and Microservices Version 1.1.3 is now generally available and suitable for production use. This version supports and recommends Spring Boot 3.2.x, Spring 6.1 and Spring Cloud 2023.0.0, with limited backwards compatibility for Spring Boot 2.7.x.
10+
{{< hint type=[warning] icon=gdoc_fire title="Version 1.2.0 (production) released June, 2024" >}}
11+
Oracle Backend for Spring Boot and Microservices Version 1.2.0 is now generally available and suitable for production use. This version supports and recommends Spring Boot 3.2.x, Spring 6.1 and Spring Cloud 2023.0.x, with limited backwards compatibility for Spring Boot 2.7.x.
1412
{{< /hint >}}
1513
&nbsp;
1614

@@ -37,7 +35,6 @@ Infrastructure (OCI) Container Engine for Kubernetes cluster (OKE cluster):
3735
- [Oracle Database Operator for Kubernetes (OraOperator or the operator)](https://github.com/oracle/oracle-database-operator)
3836
- Oracle Database Observability Exporter
3937
- [Oracle Transaction Manager for Microservices (MicroTx)](platform/microtx/)
40-
- Parse and Parse Dashboard (Optional)
4138
- [Prometheus](observability/metrics/)
4239
- Promtail
4340
- [Spring Boot Admin dashboard](platform/spring-admin/)
@@ -83,10 +80,3 @@ In the [CloudBank](https://bit.ly/CloudBankOnOBaaS) hands-on lab, you can learn
8380
We'd love to hear from you! You can contact us in the
8481
[#oracle-db-microservices](https://oracledevs.slack.com/archives/C06L9CDGR6Z) channel in the
8582
Oracle Developers slack workspace, or [open an issue in GitHub](https://github.com/oracle/microservices-datadriven/issues/new).
86-
87-
&nbsp;
88-
{{< hint type=[warning] icon=gdoc_fire title="Interested in Mobile or web apps too?" >}}
89-
Check out [Oracle Backend for Parse Platform](https://oracle.github.io/microservices-datadriven/mbaas/) - our "MERN"
90-
stack for Oracle Database! Available as an optional component in Oracle Backend for Spring Boot and Microservices.
91-
{{< /hint >}}
92-
&nbsp;

docs-source/spring/content/development/project.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ To take advantage of the built-in platform services, Oracle recommends using the
88

99
Recommended versions:
1010

11-
* Spring Boot 3.2.x
11+
* Spring Boot 3.3.x
1212
* Spring Cloud 2023.x.x
13-
* Java 17 or 21
13+
* Java 21 (or 17)
1414

1515
Table of Contents:
1616

@@ -29,9 +29,9 @@ Oracle recommends adding the following dependencies to your application so that
2929
```xml
3030
<properties>
3131
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
32-
<java.version>17</java.version>
33-
<spring.boot.dependencies.version>3.2.1</spring.boot.dependencies.version>
34-
<spring-cloud.version>2023.0.0</spring-cloud.version>
32+
<java.version>21</java.version>
33+
<spring.boot.dependencies.version>3.3.1</spring.boot.dependencies.version>
34+
<spring-cloud.version>2023.0.2</spring-cloud.version>
3535
</properties>
3636

3737
<dependencies>
@@ -167,7 +167,7 @@ If you are using Liquibase to manage your database schema and data, then you sho
167167
168168
```xml
169169
<properties>
170-
<liquibase.version>4.25.1</liquibase.version>
170+
<liquibase.version>4.28.0</liquibase.version>
171171
</properties>
172172

173173
<dependencies>
@@ -200,8 +200,8 @@ If you are using Oracle Transaction Manager for Microservices (MicroTx) to manag
200200
```xml
201201
<dependency>
202202
<groupId>com.oracle.microtx.lra</groupId>
203-
<artifactId>microtx-lra-spring-boot-starter-3x</artifactId>
204-
<version>23.4.1</version>
203+
<artifactId>microtx-lra-spring-boot-starter</artifactId>
204+
<version>24.2.1</version>
205205
</dependency>
206206
```
207207

@@ -296,6 +296,6 @@ To get tracing for the database calls you need to add the following dependency t
296296
<dependency>
297297
<groupId>net.ttddyy.observation</groupId>
298298
<artifactId>datasource-micrometer-spring-boot</artifactId>
299-
<version>$1.0.2</version>
299+
<version>1.0.3</version>
300300
</dependency>
301301
```

docs-source/spring/content/getting-started/_index.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ description: "Get started with Oracle Backend for Spring Boot and Microservices"
44
keywords: "spring springboot microservices demos videos samples cloudbank development oracle backend"
55
---
66

7-
There are a number of demonstrations (videos) and hands-on labs (Live Lab) that show how to use Oracle Backend for Spring Boot and Microservices (Spring Boot) and
8-
Oracle Backend for Parse Platform (Parse Platform).
7+
There are a number of demonstrations (videos) and hands-on labs (Live Lab) that show how to use Oracle Backend for Spring Boot and Microservices (Spring Boot).
98

109
## Prerequisites
1110

12-
* [Deployed Oracle Backend for Spring Boot and Microservices](../setup/) (and Parse Platform)
11+
* [Deployed Oracle Backend for Spring Boot and Microservices](../setup/).
1312

1413
## Introduction Video
1514

@@ -30,14 +29,13 @@ Watch this video for more information.
3029
[In this workshop (~ 2 hours)](https://bit.ly/CloudBankOnOBaaS), you learn how to build Microservices using Spring Boot and deploy
3130
them to the Oracle Backend for Spring Boot and Microservices. You learn about accessing the database using the Java Persistence API (JPA), service
3231
discovery, exposing services with the API Gateway, managing transactions across Microservices, workflow, and using observability tools
33-
to monitor your services and diagnose issues. You also learn about building a web and mobile user interface for your services using
34-
Flutter and Parse Platform.
32+
to monitor your services and diagnose issues.
3533

3634
If you have already deployed Oracle Backend for Spring Boot and Microservices, you can skip Lab 1 (Provision an Instance).
3735

3836
## More Learning
3937

40-
There are more channels to learn about Oracle Backend for Spring Boot and Microservices (and Parse Platform):
38+
There are more channels to learn about Oracle Backend for Spring Boot and Microservices:
4139

4240
* [Check out our blogs](../blogs/)
4341
* [Join our Youtube Channel](https://bit.ly/convergeddatabase)

docs-source/spring/content/release-notes/_index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This release includes:
1212
* Spring Boot upgrade to 3.3.0 and Spring Cloud 2023.0.2 for internal components.
1313
* Oracle Backend for Spring Boot and Microservices are running Java 21 with Virtual Threads enabled.
1414
* oractl is compiled using Java 21 and Virtual Threads.
15+
* Openshift support
1516

1617
The following components were updated:
1718

@@ -37,7 +38,7 @@ The following components were updated:
3738
| HashiCorp Vault | 1.16.1 | 1.15.2 |
3839

3940
{{< hint type=[warning] icon=gdoc_fire title="Deprecation Notice" >}}
40-
The following components are deprecated and will be removed in a future release:
41+
The following components are deprecated and are removed from this release:
4142

4243
* Oracle Database Storage Adapter for Parse
4344
* Parse Server

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

+91-22
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ resources:
5454
- name: oci-stack-byodb-options
5555
src: "oci-stack-byodb-options.png"
5656
title: "Bring your Own Database Options - Standard Edition"
57-
- name: oci-stack-parse-options
58-
src: "oci-stack-parse-options.png"
59-
title: "Parse Server Options"
6057
- name: oci-stack-app-name
6158
src: "oci-stack-app-name.png"
6259
title: "Compartment, Application and Edition"
@@ -116,6 +113,93 @@ You must meet the following prerequisites to use Oracle Backend for Spring Boot
116113
- Oracle Backend for Spring Boot and Microservices command-line interface (oractl). [Download oractl](https://github.com/oracle/microservices-datadriven/releases).
117114
- [OPTIONAL]Oracle Backend for Spring Boot and Microservices VS Code Extension. [Download VS Code Extension](https://github.com/oracle/microservices-datadriven/releases).
118115

116+
## OCI policies
117+
118+
The following policies needs to be in place to be able to install Oracle Backend for Spring Boot and Microservices. Top level and their dependencies listed.
119+
120+
### Oracle Container Engine for Kubernetes
121+
122+
```text
123+
Allow group `<group-name>` to manage cluster-family in `<location>`
124+
├── Allow group `<group-name>` to inspect compartments in `<location>`
125+
├── Allow group `<group-name>` to read virtual-network-family in `<location>`
126+
├── Allow group `<group-name>` to use network-security-groups in `<location>`
127+
├── Allow group `<group-name>` to use private-ips in `<location>`
128+
├── Allow group `<group-name>` to use subnets in `<location>`
129+
├── Allow group `<group-name>` to use vnics in `<location>`
130+
├── Allow group `<group-name>` to manage cluster-node-pools in `<location>`
131+
├── Allow group `<group-name>` to manage instance-family in `<location>`
132+
└── Allow group `<group-name>` to manage public-ips in `<location>`
133+
```
134+
135+
### VCN
136+
137+
```text
138+
Allow group `<group-name>` to manage vcns in `<location>`
139+
├── Allow group `<group-name>` to manage route-tables in `<location>`
140+
├── Allow group `<group-name>` to manage-security-lists in `<location>`
141+
├── Allow group `<group-name>` to manage-dhcp-options in `<location>`
142+
143+
144+
Allow group `<group-name>` to manage vcns in `<location>`
145+
Allow group `<group-name>` to manage route-tables in `<location>`
146+
Allow group `<group-name>` to manage security-lists in `<location>`
147+
Allow group `<group-name>` to manage dhcp-options in `<location>`
148+
Allow group `<group-name>` to manage nat-gateways in `<location>`
149+
Allow group `<group-name>` to manage service-gateways in `<location>`
150+
Allow group `<group-name>` to manage network-security-groups in `<location>`
151+
Allow group `<group-name>` to manage subnets in `<location>`
152+
```
153+
154+
### Container Registry
155+
156+
```text
157+
Allow group `<group-name>` to manage repos in `<location>`
158+
```
159+
160+
### Object Storage
161+
162+
```text
163+
Allow group `<group-name>` to read objectstorage-namespaces in `<location>`
164+
Allow group `<group-name>` to manage objects in `<location>`
165+
└── Allow group `<group-name>` to manage buckets in `<location>`
166+
```
167+
168+
### Autonomous Database
169+
170+
```text
171+
Allow group `<group-name>` to manage autonomous-database-family in `<location>`
172+
```
173+
174+
### Vault
175+
176+
If you deploy Oracle Backend for Spring Boot and Microservices **STANDARD** edition you need the following policies.
177+
178+
```text
179+
Allow group `<group-name>` to manage vaults in `<location>`
180+
Allow group `<group-name>` to manage keys in `<location>`
181+
```
182+
183+
#### Additional Vault
184+
185+
To allow Container Engine for Kubernetes to access Vault via Groups:
186+
187+
```text
188+
Allow group `<group-name>` to manage policies in `<location>`
189+
Allow group `<group-name>` to manage tag-namespaces in `<location>`
190+
Allow group `<group-name>` to manage dynamic-groups in `<location>`
191+
Allow group `<group-name>` to manage secret-family in `<location>`
192+
```
193+
194+
### Oracle Resource Manager
195+
196+
```text
197+
Allow group `<group-name>` to read orm-template in `<location>`
198+
Allow group `<group-name>` to use orm-stacks in `<location>`
199+
└── Allow group `<group-name>` to manage orm-jobs in `<location>`
200+
Allow group `<group-name>` to manage orm-private-endpoints in `<location>`
201+
```
202+
119203
## Summary of Components
120204

121205
Oracle Backend for Spring Boot and Microservices setup installs the following components:
@@ -137,10 +221,7 @@ Oracle Backend for Spring Boot and Microservices setup installs the following co
137221
| OpenTelemetry Collector | 0.101.0 | Collects process and export telemetry data. |
138222
| Oracle Database Observability Exporter | 1.2.1 | Exposes Oracle Database metrics in standard Prometheus format. |
139223
| Oracle Database Operator | 1.0 | Helps reduce the time and complexity of deploying and managing Oracle databases. |
140-
| Oracle Database storage adapter for Parse (optional) | 1.0.0 | Enables the Parse Server to store data in Oracle Database. |
141224
| Oracle Transaction Manager for Microservices | 23.4.2 | Manages distributed transactions to ensure consistency across Microservices. |
142-
| Parse Server (optional) | 6.3.0 | Provides backend services for mobile and web applications. |
143-
| Parse Dashboard (optional) | 5.2.0 | Provides web user interface for managing the Parse Server. |
144225
| Prometheus | 2.52.0 | Provides event monitoring and alerts. |
145226
| Prometheus Operator | 0.74.0 | Provides management for Prometheus monitoring tools. |
146227
| Promtail | 2.8.2 | Collects logs. |
@@ -189,27 +270,15 @@ To set up the OCI environment, process these steps:
189270

190271
**WARNING:** Deletion or expiration of the token will result in the failure to pull images later. Also you must have one free OCI auth token (note that the maximum is two per user). You can *NOT* use someone elses token.
191272

192-
| Edition | Parse Platform | BYO Network | BYO Database | Production Vault | Registry Scanning |
193-
|-----------|----------------|--------------|------------------|------------------| ------------------|
194-
| Community | x | | | | |
195-
| Standard | x | x | x | x | x |
273+
| Edition | BYO Network | BYO Database | Production Vault | Registry Scanning |
274+
|-----------|--------------|------------------|------------------| ------------------|
275+
| Community | | | | |
276+
| Standard | x | x | x | x |
196277

197278
<!-- spellchecker-disable -->
198279
{{< img name="oci-stack-app-name" size="large" lazy=false >}}
199280
<!-- spellchecker-enable -->
200281

201-
1. If you check the checkbox *Enable Parse Platform* in the **Parse Server** section a Parse Server will be installed. Fill in the following for the Parse Server:
202-
203-
- `Application ID` (optional) : Leave blank to auto-generate.
204-
- `Server Master Key` (optional) : Leave blank to auto-generate.
205-
- `Dashboard Username` : The user name of the user to whom access to the dashboard is granted.
206-
- `Dashboard Password` (optional) : The password of the dashboard user (a minimum of 12 characters). Leave blank to auto-generate.
207-
- `Enable Parse S3 Storage` : Check the checkbox to enable Parse Server S3 Adaptor and create a S3 compatible Object Storage Bucket.
208-
209-
<!-- spellchecker-disable -->
210-
{{< img name="oci-stack-parse-options" size="large" lazy=false >}}
211-
<!-- spellchecker-enable -->
212-
213282
1. If you check the checkbox *Set Administrator Passwords* in the **Administrator Passwords** section you have the option to fill in the following passwords (if not they are autogenerated):
214283

215284
- `APISIX Administrator Password` (optional) : Leave blank to auto-generate.
Loading
Binary file not shown.

0 commit comments

Comments
 (0)